CommandSend hub command

Send hub command

Passthrough: forwards { command, args } verbatim to the hub device shadow. The command is not allow-listed and args are not validated — the device is the validator and responds asynchronously on its reported topic.

curl -X POST "https://api.spkey.co/hubs/example_string/SendHubCommand" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "hubId": "example_string",
  "command": "example_string",
  "args": {}
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null"
}
POST
/hubs/{id}/SendHubCommand
POST
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.
Content-Typestring
Required

The media type of the request body

Options: application/json
commandstring
Required

Hub command name, forwarded verbatim to the device shadow (e.g. get_nodes, server_info, set_wifi_credentials)

Min length: 1
argsobject

Command arguments, forwarded verbatim (e.g. set_wifi_credentials → { ssid, credentials })

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

Body

application/json
commandstring
Required

Hub command name, forwarded verbatim to the device shadow (e.g. get_nodes, server_info, set_wifi_credentials)

argsobject

Command arguments, forwarded verbatim (e.g. set_wifi_credentials → { ssid, credentials })

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventnull
Required