API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create a new mac lockout profile by unique name

Defines a single MAC Lockout profile, specifying the MAC addresses to be blocked
and the lockout duration. Each entity is identified by name. Use these APIs to create,
modify, or delete an instance.

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

Unique name for the MAC Lockout profile. Required to reference this profile in device configurations.

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

address
array of objects
length ≤ 2147483647

List of MAC addresses that should be locked out.

address
boolean
Defaults to false

Enable MAC lockout logging.

string
length between 1 and 256

User description for MAC lockout profile.

string
length between 1 and 256

Unique name for the MAC Lockout profile. Required to reference this profile in device configurations.

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