Send hub command
Sends hub-level commands (get_nodes, server_info, set_wifi_credentials)
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": "get_nodes",
"args": {}
}'
import requests
import json
url = "https://api.spkey.co/hubs/example_string/SendHubCommand"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"hubId": "example_string",
"command": "get_nodes",
"args": {}
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/hubs/example_string/SendHubCommand", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"hubId": "example_string",
"command": "get_nodes",
"args": {}
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"hubId": "example_string",
"command": "get_nodes",
"args": {}
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/hubs/example_string/SendHubCommand", bytes.NewBuffer(data))
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/SendHubCommand')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"hubId": "example_string",
"command": "get_nodes",
"args": {}
}'
response = http.request(request)
puts response.body
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": "null"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Error",
"message": "Hub offline — the hub is not currently connected to the network.",
"code": 502
}
POST
/hubs/{id}/SendHubCommandPOST
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
Content-Typestring
RequiredThe media type of the request body
Options: application/json
hubIdstring
RequiredHub ID
commandstring
RequiredHub command type
Options: get_nodes, server_info, set_wifi_credentials
argsobject
Command arguments
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
successboolean
RequiredaggregateIdstring
Requiredversionnumber
Requiredeventnull
Requiredsuccessboolean
RequiredAllowed values:
falseerrorstring
Requiredmessagestring
Requiredsuccessboolean
RequiredAllowed values:
falseerrorstring
Requiredmessagestring
Requiredsuccessboolean
RequiredAllowed values:
falseerrorstring
Requiredmessagestring
RequiredWas this page helpful?