Start Claim

Time	Status	User Agent
Retrieving recent requests…

Overview

Starts the asynchronous claim process for a device reachable via an edge proxy. The device is identified by its IP/Host address, and the claim is handled through the Edge.

The following information is required to claim an Edge device:

The ID of the Edge (Available in the End Customer Portal)
Device Model - The list of currently supported models is available from Xyte's support. To claim "Heartbeat monitoring" (only Ping) use the Heartbeat model id: 5dc4ba6c-c323-4118-a4e4-504f074426f2
The IP/Hostname of the device to monitor.

The Claiming flow is asynchronous, to check the status of the process poll the Get Claim Status API.

Authorization

This endpoint requires Authorization.

Request Body

Key	Type	Description	Required
proxy_id	string	ID of the Edge through which the device is reachable.	Yes
device_ip	string	IP address or Hostname of the device to claim.	Yes
device_model_id	string	ID of the device model.	Yes
space_id	number	ID of the space to claim the device into.	Yes
display_name	string	Display name to assign to the device.	No
mac	string	MAC address to assign to the device. Accepts common formats (`aa:bb:cc:dd:ee:ff`, `AA-BB-CC-DD-EE-FF`, `aabbccddeeff`); it is normalized on the server. An invalid MAC returns `422`.	No
sn	string	Serial number to assign to the device. When omitted, the device is created without a serial number.	No
custom_parameters	object	Additional custom parameters for the device.	No
custom_partner_name	string	Custom partner name override.	No
custom_model_name	string	Custom model name override.	No
skip_connectivity_check	boolean	Skip the pre-claim connectivity check. Defaults to `false`.	No

By default the claiming process requires a ping check, to verify the device is reachable from the Edge. To skip this step, pass skip_connectivity_check as false

{
  "proxy_id": "proxy-uuid",
  "device_ip": "192.168.1.100",
  "device_model_id": "model-uuid",
  "space_id": 10000,
  "display_name": "Conference Room Display",
  "mac": "aa:bb:cc:dd:ee:ff",
  "sn": "SN-12345",
  "custom_parameters": {},
  "skip_connectivity_check": false
}

Response

204 No Content — The claim process has been initiated. No response body is returned. Use Get Claim Status to poll for the result.

Errors

Status	Description
401	Missing or invalid `Authorization` header.
422	Invalid parameters, e.g. unknown `device_model_id`, invalid `mac`, or unreachable edge.