API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create ssid-cluster by profile

WLAN profile to Cluster mapping

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

WLAN ssid profile name or wired-port 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

ssid-clusterbody object

string
length between 1 and 256

ESSID alias name

string
length between 1 and 32

ESSID, The AP takes this parameter from its per-AP-ssid specific configuration.

gw-cluster-list
array of objects
length ≤ 2147483647

Gateway Clusters mapped to this profile

gw-cluster-list
string
enum
required

WIRELESS_PROFILE if profile is wlan ssid name, pass 'WIRED_PORT_PROFILE' if profile is wired-port profile

Show Details
WIRED_PORT_PROFILEWired Port profile
WIRELESS_PROFILEWireless profile
Allowed:
string
length between 1 and 255

WLAN ssid profile name or wired-port profile name

boolean
Defaults to false

ESSID use alias or not

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