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

Get vlan info of the switch

get
https://{api-base-url}/monitoring/v1/switches//vlan

Get switch vlan info

Path Params
string
required

Filter by switch serial

Query Params
string

Filter by vlan name

integer

Filter by vlan id

string

Filter by tagged port name

string

Filter by untagged port name

boolean

Filter by jumbo enabled

boolean

Filter by voice enabled

boolean

Filter by igmp enabled

string

Type of the vlan to be queried

integer

Primary Vlan Id of the vlan to be queried"

string

Filter by status of VLAN. Status can be Up/Down

int32

Pagination offset

int32

Pagination limit. Default is 100 and max is 1000

string

Sort parameter may be one of +name, -name

boolean

Whether to calculate total vlans

Responses

401

Unauthorized access

403

Forbidden

404

Not found

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