About

Return the current WebSockets status of the specified device. Is the device online (WebSockets enabled) or offline (not WebSockets enabled)?

Parameters

PropertyLocationDetails

AccessKey

string
Required
Unique
Header

The access key for your user account.

This value is a 36-character GUID provided in your user profile.

Name

string
Required
Unique
URL

The name of the device.

This value has a max length of 128 ASCII characters.

This value must adhere to this regular expression: ^[a-zA-Z0-9-_]*$

Example

Request URL

GET https://api.jetstreamrfid.com/3/devices/{Device Name}/status

Request Body

None Required

Response Code

200 OK

Response Body

{
    "WebSocketsEnabled": true
}

Version Changes

None