QueryGet hub status

Get hub status

Get hub status including real-time online/offline from Thing Shadow

curl -X GET "https://api.spkey.co/hubs/example_string/status" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "hubId": "example_string",
  "serial": "example_string",
  "model": "example_string",
  "thingName": "John Doe",
  "status": "Provisioned",
  "orgId": "example_string",
  "siteId": "example_string",
  "isPrimary": true,
  "provisionedAt": 3.14,
  "claimedAt": 3.14,
  "online": true,
  "lastSeen": 3.14,
  "version": "example_string",
  "uptimeSeconds": 3.14
}
GET
/hubs/{id}/status
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

Responses

hubIdstring
Required
serialstring
Required
modelstring
Required
thingNamestring
Required
statusstring
Required
Allowed values:ProvisionedClaimedSuspendedDecommissioned
orgIdstring
Required
siteIdstring
Required
isPrimaryboolean
Required
provisionedAtnumber
Required
claimedAtnumber
Required
onlineboolean
lastSeennumber
versionstring
uptimeSecondsnumber