List Mobility Controllers
GET {{base_url}}/monitoring/v1/mobility_controllers?group=<string>&label=<string>&site=<string>&status=<string>&macaddr=<string>&model=<string>&fields=<string>&calculate_total=<boolean>&offset=<integer>&limit=<integer>&sort=<string>
Get mobility controllers. This API is deprecated and will be removed on 2022-06-30T00:00:00Z. For cloud deployment, use /monitoring/v1/gateways. For controller on-prem deployment, use /monitoring/v2/mobilitycontrollers. You can only specify one of group, label parameters. Possible errorcodes for the error responses are 1. 0001 - General Error. 2. 0002 - Validation Error. Out of Range value for a query parameter. 3. 0003 - Validation Error. Unsupported query combination 4. 0004 - Validation Error. Invalid value for a query parameter
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
group | string | Filter by group name | |
label | string | Filter by Label name | |
site | string | Filter by Site name | |
status | string | Filter by Mobility Controller status | |
macaddr | string | Filter by Mobility Controller MAC address | |
model | string | Filter by Mobility Controller Model | |
fields | string | Comma separated list of fields to be returned. Valid fields are status, ip_address, model, firmware_version, labels, ap_count, usage | |
calculate_total | string | Whether to calculate total Mobility Controllers | |
offset | string | Pagination offset | |
limit | string | Pagination limit. Default is 100 and max is 1000 | |
sort | string | Sort parameter may be one of +serial, -serial, +macaddr, -macaddr. Default is '+serial' |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":"\u003cinteger\u003e","mcs":[{"group_name":"\u003cstring\u003e","macaddr":"\u003cstring\u003e","name":"\u003cstring\u003e","serial":"\u003cstring\u003e","status":"\u003cstring\u003e","ip_address":"\u003cstring\u003e","model":"\u003cstring\u003e","firmware_version":"\u003cstring\u003e","role":"\u003cstring\u003e","ap_count":"\u003cinteger\u003e","usage":"\u003cstring\u003e","labels":["\u003cstring\u003e","\u003cstring\u003e"],"site":"\u003cstring\u003e","est_status":"\u003cstring\u003e","est_cert_expiry_time":"\u003cstring\u003e","vgw_sys_bw_limit":"\u003cinteger\u003e","vgw_sys_bw_usage":"\u003cinteger\u003e"},{"group_name":"\u003cstring\u003e","macaddr":"\u003cstring\u003e","name":"\u003cstring\u003e","serial":"\u003cstring\u003e","status":"\u003cstring\u003e","ip_address":"\u003cstring\u003e","model":"\u003cstring\u003e","firmware_version":"\u003cstring\u003e","role":"\u003cstring\u003e","ap_count":"\u003cinteger\u003e","usage":"\u003cstring\u003e","labels":["\u003cstring\u003e","\u003cstring\u003e"],"site":"\u003cstring\u003e","est_status":"\u003cstring\u003e","est_cert_expiry_time":"\u003cstring\u003e","vgw_sys_bw_limit":"\u003cinteger\u003e","vgw_sys_bw_usage":"\u003cinteger\u003e"}],"total":"\u003cinteger\u003e"}