GET /api/v1/data/deviceStatus?deviceID={id}
Use this method to return status information for a specific device.
Authentication
Authentication with username and password is required.
Resource URI
GET https://{orchestrator_server_IP}/api/v1/data/deviceStatus?deviceID={id}
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| deviceID={id} | Required | Returns status for a device, specified by the ID To obtain the device IDs, use GET /api/v1/data/devices |
The following example returns status information for a specific device.
GET https://192.0.2.0/api/v1/data/deviceStatus?deviceID=
3015DE7E2B6011E881940A94EF5F5B65-C7199530FEDE4FE09540DFC3D75FC56C
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. If a query parameter is specified and the value of that parameter has no matches, the response body returns default values. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 404 | Not found | The resource cannot be found. A descriptive error message is returned in the response body. |
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
| Attributes | Type | Description | ||
|---|---|---|---|---|
| criticalAlerts | Integer | Number of critical alerts | ||
| faultLedStatus | String | Number of informational alerts | ||
| identityLedStatus | String | Fault LED status. This can be one of the following values.
| ||
| informationalAlerts | Integer | Identity LED status. This can be one of the following values.
| ||
| powerStatus | String | Power status. This can be one of the following values.
| ||
| warningAlerts | Integer | Number of warning alerts | ||
| _links | Object | Device URI (see Links) | ||
The following example is returned if the request is successful.
{
"criticalAlerts": 0,
"faultLedStatus": "Off",
"identityLedStatus": "Off",
"informationalAlerts": 0,
"powerStatus": "Off",
"warningAlerts": 1,
"_links": {
"rel": "self",
"uri": "/api/v1/data/devices/C7199530FEDE4FE09540DFC3D75FC56C"
}
}
Give documentation feedback