HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Create/Update airgroup service policy by name at Global or group

put
https://{api-base-url}/airgroup-config/v2/node_list///config/services//

Policy for each Airgroup service to be applied at Global or group level

Path Params
string
enum
required

Defines the type of configuration node to which the config is being applied.

Allowed:
string
required

The identifier of the configuration node(aka group). For node-type GLOBAL, node-id should be 'GLOBAL'. For node-type 'GROUP', node-id should be set to the group-name

string
required

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.

Body Params

JSON representation of services config

string
required

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.

string

This field indicates whether this profile was explicitly configured at this node or inherited from a parent node

string

Description of the Airgroup service. This is a read-only field

boolean
Defaults to false

Indicates whether service is enabled or disabled

int32
Defaults to 10

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

boolean
Defaults to false

Indicates whether the service is pre-defined or custom (user-defined) service. This is a read-only field.

vlan_restrictions
object
role_restrictions
object
Responses

401

Unauthorized

403

Forbidden

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Updated about 2 years ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 years ago