CommandCommission device on hub

Commission device on hub

Sends a commission_with_code command to the hub via AWS IoT Shadow. The hub performs Matter device commissioning and reports the result asynchronously.

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

Matter commissioning code (11 or 22 digits, or MT:<code>)

Pattern: ^(\d{11}|\d{22}|MT:.+)$
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
commissioningCodestring
Required

Matter commissioning code (11 or 22 digits, or MT:<code\>)

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventnull
Required