- Release Notes
- API Changelog
- Overview
- Generally Available
- v1.57.0
- v1.56.0
- v1.55.0
- v1.54.0
- v1.53.0
- v1.52.0
- v1.51.1
- v1.50.0
- v1.49.0
- v1.48.0
- v1.47.0
- v1.46.0
- v1.45.0
- v1.44.0
- v1.43.0
- v1.42.0
- v1.41.0
- v1.40.0
- v1.39.0
- v1.38.0
- v1.37.0
- v1.36.0
- v1.35.0
- v1.34.0
- v1.33.0
- v1.32.0
- v1.31.0
- v1.30.0
- v1.29.0
- v1.28.0
- v1.27.0
- v1.26.0
- v1.25.0
- v1.24.0
- v1.23.0
- v1.22.0
- v1.21.0
- v1.20.0
- v1.19.0
- v1.18.0
- v1.17.0
- v1.16.0
- v1.15.0
- v1.14.0
- v1.13.0
- v1.12.0
- v1.11.0
- v1.10.0
- v1.8.0
- v1.7.0
- v1.6.0
- v1.5.0
- v1.4.0
- v1.3.0
- v1.2.0
- v1.1.0
- v1.0.0
- v0.11.0
- v0.10.0
- v0.9.0
- v0.8.0
- v0.7.0
- v0.6.0
- v0.5.0
- v0.4.0
- v0.3.0
- v0.2.0
- Beta
- What's Updated
- What's New
Version 1.52.0 to 1.53.0
Summary of Changes
5 - New
37 - Updated
773 - Total Endpoints
520 - Total Paths
What's Updated
[ licensing ]
subscription
List available subscriptions
GET /administered/licensing/subscription/subscriptions
- Property
smartAccountStatus
Deleted
- Property
id
Deleted
- Property
name
Deleted
- Optional property
status
Added
- Optional property
account
Added
- Optional property
lastUpdatedAt
Added
- Optional property
renewalRequested
Added
- Response property
status
value added
- Response property
account
value added
- Response property
lastUpdatedAt
value added
- Response property
renewalRequested
value added
Claim a subscription into an organization.
POST /administered/licensing/subscription/subscriptions/claim
- Property
smartAccountStatus
Deleted
- Property
id
Deleted
- Property
name
Deleted
- Optional property
status
Added
- Optional property
account
Added
- Optional property
lastUpdatedAt
Added
- Optional property
renewalRequested
Added
Find a subscription by claim key
POST /administered/licensing/subscription/subscriptions/claimKey/validate
- Property
smartAccountStatus
Deleted
- Property
id
Deleted
- Property
name
Deleted
- Optional property
status
Added
- Optional property
account
Added
- Optional property
lastUpdatedAt
Added
- Optional property
renewalRequested
Added
[ devices ]
ping
Return a ping job
GET /devices/{serial}/liveTools/ping/{id}
- Property
sourceInterface
Deleted
- Optional property
serial
Added
- Response property
serial
value added
Enqueue a job to ping a target host from the device
POST /devices/{serial}/liveTools/ping
- Property
sourceInterface
Deleted
- Optional property
serial
Added
pingDevice
Return a ping device job
GET /devices/{serial}/liveTools/pingDevice/{id}
- Optional property
serial
Added
- Response property
serial
value added
Enqueue a job to check connectivity status to the device
POST /devices/{serial}/liveTools/pingDevice
- Optional property
serial
Added
[ wireless ]
ssids
Return the L3 firewall rules for an SSID on an MR network
GET /networks/{networkId}/wireless/ssids/{number}/firewall/l3FirewallRules
- Optional property
allowLanAccess
Added
- Response property
allowLanAccess
value added
Update the L3 firewall rules of an SSID on an MR network
PUT /networks/{networkId}/wireless/ssids/{number}/firewall/l3FirewallRules
- Optional property
allowLanAccess
Added
[ organizations ]
inventory
Initiates or updates an import session
POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare
- Optional property
options
Added
What's New
[ devices ]
leds
PATH /devices/{serial}/liveTools/leds/blink
- Path added
- New endpoint
Enqueue a job to blink LEDs on a device. This endpoint has a rate limit of one request every 10 seconds.
POST
/devices/{serial}/liveTools/leds/blink
Code SnippetCopy{ "ledsBlinkId": "123", "url": "/devices/QXXX-YYYY-ZZZZ/liveTools/leds/blink/1738", "status": "complete", "request": { "serial": "Q234-ABCD-5678", "duration": 30 }, "error": "error description", "callback": { "id": "1284392014819", "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031", "status": "new" } }
PATH /devices/{serial}/liveTools/leds/blink/{ledsBlinkId}
- Path added
- New endpoint
Return a blink LEDs job
GET
/devices/{serial}/liveTools/leds/blink/{ledsBlinkId}
Code SnippetCopy{ "ledsBlinkId": "123", "url": "/devices/QXXX-YYYY-ZZZZ/liveTools/leds/blink/1738", "status": "complete", "request": { "serial": "Q234-ABCD-5678", "duration": 30 }, "error": "error description" }
[ switch ]
ports
PATH /organizations/{organizationId}/switch/ports/clients/overview/byDevice
- Path added
- New endpoint
List the number of clients for all switchports with at least one online client in an organization.
GET
/organizations/{organizationId}/switch/ports/clients/overview/byDevice
Code SnippetCopy{ "items": [ { "name": "Example Switch", "serial": "Q555-5555-5555", "mac": "01:23:45:67:ab:cd", "network": { "name": "Example Network", "id": "L_12345" }, "model": "MS120-8", "ports": [ { "portId": "1", "counts": { "byStatus": { "online": 0 } } } ] } ], "meta": { "counts": { "items": { "total": 1, "remaining": 0 } } } }
PATH /organizations/{organizationId}/switch/ports/statuses/bySwitch
- Path added
- New endpoint
List the switchports in an organization
GET
/organizations/{organizationId}/switch/ports/statuses/bySwitch
Code SnippetCopy{ "items": [ { "name": "Example Switch", "serial": "Q555-5555-5555", "mac": "01:23:45:67:ab:cd", "network": { "name": "Example Network", "id": "L_12345" }, "model": "MS120-8", "ports": [ { "portId": "1", "enabled": true, "status": "Connected", "isUplink": false, "errors": [ "PoE overload", "Very high proportion of CRC errors" ], "warnings": [ "SecurePort authentication in progress", "PoE port was denied power", "High proportion of CRC errors" ], "speed": "10 Gbps", "duplex": "full", "spanningTree": { "statuses": [ "Learning" ] }, "poe": { "isAllocated": false }, "securePort": { "active": true, "authenticationStatus": "Authentication in progress" } } ] } ], "meta": { "counts": { "items": { "total": 1, "remaining": 0 } } } }
PATH /organizations/{organizationId}/switch/ports/topology/discovery/byDevice
- Path added
- New endpoint
List most recently seen LLDP/CDP discovery and topology information per switch port in an organization.
GET
/organizations/{organizationId}/switch/ports/topology/discovery/byDevice
Code SnippetCopy{ "items": [ { "name": "Example Switch", "serial": "Q555-5555-5555", "mac": "01:23:45:67:ab:cd", "network": { "name": "Example Network", "id": "L_12345" }, "model": "MS120-8", "ports": [ { "portId": "1", "lastUpdatedAt": "ISO8061Z", "cdp": [ { "name": "System name", "value": "MS350-24X - Test" } ], "lldp": [ { "name": "System name", "value": "MS350-24X - Test" } ] } ] } ], "meta": { "counts": { "items": { "total": 1, "remaining": 0 } } } }