api:networkmanagement:device:refresh
Table of Contents
API : Network Device Refresh
Introduction
This request refreshes a single network device's live data from the device platform and returns the updated device. If the live refresh fails, the last known data is returned instead.
Request
| URL | https://api.telecomx.dk/network/device/DEVICE_ID/refresh | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller or a sub reseller. RESELLER_ADMIN. ADMIN. The customer must have the NETWORK_MANAGEMENT feature. |
|
| Params | DEVICE_ID | Id of the network device. |
| Query | force | [optional] True to bypass the 5-minute per-device cooldown and force a live re-fetch. Defaults to false. |
Query examples
https://api.telecomx.dk/network/device/12345678901234567890ABCD/refresh https://api.telecomx.dk/network/device/12345678901234567890ABCD/refresh?force=true
Response
The response is identical to Get.
Errors
| Error code | Message | Description |
|---|---|---|
| 422 | <property> | Invalid input for the named property - the request body, query or URL parameter failed validation |
| 400 | networkId | Device is not linked to an external network |
| 400 | deviceId | Device is not linked to an external device |
| 400 | provisioned | Device is not provisioned |
| 403 | access_denied | Insufficient access level |
| 404 | id | Not found |
| 500 | internal_error | <Unspecified> |
api/networkmanagement/device/refresh.txt · Last modified: by Mikkel Meerwaldt Jørgensen