bindDeviceToGateway
Associates the device with the gateway.
Note: This is a regional API.
You can find the URL, SystemKey, and token required in the call by clicking API Keys (key icon) at the top-right of the Registry Details page. Use the Registry Keys section.
HTTP request
POST {URL}/api/v/4/webhook/execute/{SystemKey}/cloudiot
Query parameters
Parameters | |
---|---|
|
The registry name. For example, |
|
|
Header parameters
Parameters | |
---|---|
| See the note at the start of this document on where to find the token. |
Request body
The request body contains data with this structure:
JSON representation |
---|
{
"gatewayId": string,
"deviceId": string
} |
Fields | |
---|---|
|
The |
|
The device to associate with the specified gateway. The |
Response status codes
Code | Meaning |
---|---|
200 | Success |
Response body
If successful, the response body will be empty.
Example curl
curl 'https://us-central1.clearblade.com/api/v/4/webhook/execute/aae9b9b30c8aa4e49081c7eeb9bb07/cloudiot?method=bindDeviceToGateway&parent=test-reg' -X POST -H 'ClearBlade-UserToken: {Token}' -d '{"gatewayId": "test-gateway-1", "deviceId": "test-dev-1"}'
Using the instructions at the start of this document, replace the following: https://us-central1.clearblade.com
with your URL. aae9b9b30c8aa4e49081c7eeb9bb07
with your SystemKey. {Token} with your token.
Set the gatewayId
and deviceId
values appropriately.