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

Create vlan restriction for given service at Global or group

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

Configuration of allowed/disallowed VLANs applicable to this service

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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 vlan_restrictions config

disallowed_vlans
array of objects
length ≤ 20

Disallowed VLAN IDs or range of VLAN IDs (eg '100-200'. This list must be empty if vlans are configured as part of 'allowed_vlans'.

disallowed_vlans
allowed_vlans
array of objects
length ≤ 20

List of allowed VLAN ids or range of VLAN ids. This list must be empty if 'disallowed_vlans' has vlans configured

allowed_vlans
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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago