Device

The Device API manages device registation with the Builder.

When devices are first booted, they will "register" with the builder using their device ID (ClaimID). The device then remains under the management of the Builder until it is "claimed" by a user for management using the "claim" API.

When claimed, the device is redirected to the device cloud when it next invokes the "register" API.

Get

Endpoint

POST /device/get

Authorized User Role

user

Request Body

Field	Type	Required	Notes
id	string	yes	Device Claim ID.

Response

Field	Type
id	string
accountId	string
managerAccountId	string
cloudId	string
productId	string
test	boolean

Find

Endpoint

POST /device/find

Authorized User Role

user

Request Body

Field	Type
id	string
cloudId	string
productId	string

Query String Options

Field	Type
limit	number
next	object
prev	object

Response

Paged response.

Field	Type	Notes
data	array	Array of items.
next	string	Paged cursor to use for the next page of items.
prev	string	Pages cursor to use for the previous page of items.

Device

An array of Device items.

Field	Type
id	string
accountId	string
managerAccountId	string
cloudId	string
productId	string
test	boolean

Register

Endpoint

POST /device/register

Authorized User Role

public

Request Body

Field	Type	Required	Notes
id	string	yes	Device Claim ID.
account	string		Manager Account ID if auto claiming.
cloud	string		Cloud ID if auto claiming.
product	string	yes	Product ID Token.
test	boolean		Set to true for test devices.
*	any

Response

Field	Type	Notes
api	string	API endpoint for the device cloud that claimed the device.
token	string	Access token for requests to the device cloud.
registered	boolean	Set to true when registered.
cloudType	string
cloudName	string
cloudRegion	string

Release

Endpoint

POST /device/release

Authorized User Role

user

Request Body

Field	Type	Required	Notes
id	string	yes	Device claim ID.
callback	boolean
certArn	string

Remove

Endpoint

POST /device/remove

Authorized User Role

admin

Request Body

Field	Type	Required	Notes
id	string	yes	Device claim ID.