List Switches

get

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

Get switches You can only specify one of group, label and stack_id parameters.
Possible error_codes for the error responses are

0001 - General Error.
0002 - Validation Error. Out of Range value for a query parameter.
0003 - Validation Error. Unsupported query combination
0004 - Validation Error. Invalid value for a query parameter

Query Params

group

string

Filter by group name

label

string

Filter by Label name

stack_id

string

Filter by Switch stack_id

status

string

Filter by Switch status

fields

string

Comma separated list of fields to be returned. Valid fields are status, macaddr, model, ip_address, public_ip_address, firmware_version, labels, uplink_ports, site

calculate_total

boolean

Whether to calculate total Switches

show_resource_details

boolean

Whether to show switch uptime, max_power, power_consumption, temperature, fan_speed, cpu_utilization, mem_free, mem_total, poe_consumption.

calculate_client_count

boolean

Whether to calculate client count per Switch

public_ip_address

string

Filter by public ip address

site

string

Filter by site name

offset

int32

Pagination offset

limit

int32

Pagination limit. Default is 100 and max is 1000

sort

string

Sort parameter may be one of +serial, -serial, +name, -name, +macaddr, -macaddr

Responses

401

Unauthorized access

403

Forbidden

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Language

Credentials

Bearer

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400Bad Request

500Internal server error