API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create new service policy

List of policies for each Airgroup service to be applied at different scope.

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

Name of the Airgroup service. This should refer to one of the pre-defined services or a custom-service that has been defined by user.

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

policybody object

role-restrictions
object

Role restriction for this service at global or group scope

vlan-restrictions
object

Configuration of allowed/disallowed VLANs applicable to this service.
Both allowed and disallowed VLANS cannot be configured at the same time.

boolean
Defaults to false

Enable specific Airgroup service.

string
length between 1 and 32

Name of the Airgroup service. This should refer to one of the pre-defined services or a custom-service that has been defined by user.

int64
10 to 1440

Duration in minutes after which the records
of inactive servers are purged. This timer will be used for
all server records belonging to this service. Allowed range
is from 60 (1 hour) to 360 (6 hours). If this is not
configured, the records are purged as per TTL/max-age specified
in packets

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