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"
import requests
import json
url = "https://api.spkey.co/hubs/example_string/status"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.spkey.co/hubs/example_string/status", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.spkey.co/hubs/example_string/status", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/hubs/example_string/status')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"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
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
GET
/hubs/{id}/statusGET
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token (JWT)
Bearer Tokenstring
RequiredJWT 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
RequiredAPI key for B2B organization access. Provided during organization onboarding.
API key for B2B organization access. Provided during organization onboarding.
path
idstring
RequiredHub ID
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
header
X-API-Keystring
RequiredAPI Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
idstring
RequiredHub ID
Responses
hubIdstring
Requiredserialstring
Requiredmodelstring
RequiredthingNamestring
Requiredstatusstring
RequiredAllowed values:
ProvisionedClaimedSuspendedDecommissionedorgIdstring
RequiredsiteIdstring
RequiredisPrimaryboolean
RequiredprovisionedAtnumber
RequiredclaimedAtnumber
Requiredonlineboolean
lastSeennumber
versionstring
uptimeSecondsnumber
successboolean
Requirederrorsarray
Requiredcodenumber
Requiredmessagestring
RequiredWas this page helpful?