Claim edge device

POST /api/v1/edge-protocol/devices/{device_id}/claim

Enrollment bearer only. Appliance persists a random device credential before calling; identical retries recover a lost response without minting new credentials.

Access

Authentication options declared in the contract include one-use appliance enrollment credential.

Authentication and permissions explains tokens, cookies, CSRF, and workspace context.

Parameters

Name	Location	Required	Type	Description and constraints
device_id	path	Yes	string (uuid)

Request body

Required.

application/json — EdgeClaimBody.

Field	Type	Required	Description and constraints
deviceCredential	string	Yes	pattern ^[A-Za-z0-9_-]{43,128}$

cURL request template

Set the connection variables described in Get started. Replace each additional EOI_… variable with the parameter value for this request. Prepare the body file using the request schema above. This template sends the request when run.

curl --fail-with-body --silent --show-error \
  --request POST \
  --header "Authorization: Bearer ${EOI_EDGE_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json \
  "${EOI_API_BASE_URL}/edge-protocol/devices/${EOI_DEVICE_ID}/claim"

Contract responses

The table records responses declared by the OpenAPI contract. See Errors and status codes for the runtime error envelope and shared failures.

Status	Description	Media type	Body
200	Successful Response	application/json	EdgeDeviceResponse
422	Validation Error	application/json	HTTPValidationError

Operation identifier claimEdgeDevice. Browse Device protocol.