API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create an uplink profile

List of uplink profiles, configure the uplink parameters, such like ethernet uplink, cellular uplink, preemption parameters, management VLAN, etc.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Uplink profile name.

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

preemption
object

Preemption for uplink.

failover
object

Health check for uplink.

string
enum

AP campus or microbranch or Instant mode.

Show Details
CAMPUSAP campus mode.
INSTANTInstant AP mode.
MICROBRANCHAP microbranch mode.
Allowed:
string
length between 1 and 256

Uplink profile description.

ethernet-1
object

Media Access Control Security config for ap uplink ethernet.

ethernet-2
object

AP uplink ethernet.

boolean
Defaults to false

Re-trigger DHCP once the ARP entry for the APs default gateway is lost

lte-modem
object

AP uplink cellular sim pin is a security method to protect the SIM card from unauthorized access,
the following operations can be configured for the sim pin:
1.sim-pin-enable: enable SIM PIN lock
2.sim-pin-renew: update the current SIM PIN
3.sim-pin-puk: unlock the SIM PIN using PUK.

string
length between 1 and 256

Uplink profile name.

wifi-uplink
object
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json