post https://hub.xyte.io/core/v1/organization/devices/claim
This endpoint is used to claim organization devices.
Authorization
This endpoint requires Authorization.
Request data
Key | Type | Description | Required |
---|---|---|---|
name | string | Name of the device | No |
space_id | string | ID of the space that will claim the device | Yes |
mac | string | MAC address of the device. The serial number and MAC address or the Device Cloud ID is required | No |
sn | string | Serial number of the device. The serial number and MAC address or the Device Cloud ID is required | No |
cloud_id | string | Cloud ID of the device. The serial number and MAC address or the Device Cloud ID is required | Yes |
Request
Key | Type | Description | Required |
---|---|---|---|
name | string | Name of the device. | No |
space_id | string | ID of the space that will claim the device. | Yes |
mac | string | MAC address of the device. The serial number and MAC address or the Device Cloud ID is required. | No |
sn | string | Serial number of the device. The serial number and MAC address or the Device Cloud ID is required. | No |
cloud_id | string | Cloud ID of the device. The serial number and MAC address or the Device Cloud ID is required. | Yes |
Request sample
{
"space_id": "xxxxx",
"name": "DSP-X200",
"mac": "....",
"sn": "...",
"cloud_id": "LelJ5pO..."
}
Response
Key | Subkey | Type | Description |
---|---|---|---|
id | string | Unique identifier of the device. It is a universally unique identifier (UUID). | |
name | string | Name of the device. | |
sn | string | Serial number of the device. | |
mac | string | Cloud ID of the device. | |
cloud_id | string | Unique identifier of the device in the cloud. | |
status | string | Current status of the device: "online", "offline", "error". | |
last_seen_at | string | Timestamp of the last time the device was seen online in ISO 8601 format (e.g., "2024-07-29T10:18:39.267Z"). | |
details | object | Additional details about the device. This field might be null if no details are available. | |
model | object | Information about the device model. | |
id | string | Unique identifier of the device model. It is a universally unique identifier (UUID). | |
name | string | Name of the device model. | |
sub_model | string | Sub-model of the device. This field might be null if no sub-model exists. | |
firmware | object | Firmware information. | |
version | string | Current firmware version of the device. | |
space | object | Information about the space that claimed the device. | |
id | integer | Unique identifier of the space where the device is located. | |
full_path | string | Full path of the space where the device is located. This path represents the hierarchical structure of the space. |
Example JSON Response
{
"id": "1ad4e4e4-99b4-48ed-be81-c4....",
"name": "DSP-X200",
"sn": "5pOLfS-YyeE4QlKnA...",
"mac": null,
"cloud_id": "LelJ5pOLfS-YyeE4Q...",
"status": "online",
"last_seen_at": "2024-07-29T10:18:39.267Z",
"details": null,
"model": {
"id": "799d6127-71b1-45af-8bca-3ad2d...",
"name": "DSP-X200",
"sub_model": null
},
"firmware": {
"version": "1.0.0"
},
"space": {
"id": xxxxx,
"full_path": "Green Energy Corp/United Kingdom/London/Executive Suite"
}
}