v24

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-19169310464.0 KB
Devices

Provision a new device

post/devices

Query parameters

deviceType'dedicated_physical_device' | 'dedicated_premium_device' | 'dedicated_ios_device'
countrystring

ISO 3166-1 alpha-2 country code. If omitted the system picks the country with the most availability.

ISO 3166-1 alpha-2 country code. If omitted the system picks the country with the most availability.

profileIdstring

Profile ID to use as device spec

Profile ID to use as device spec

Request body

$schemastring uri

A URL to the JSON Schema for this object.

androidVersioninteger
appsstring[] nullable
countrystring
filesstring[] nullable
localestring
namestring
timezonestring

Example request

{
  "$schema": "https://example.com/schemas/DeviceSpec.json",
  "location": {
    "$schema": "https://example.com/schemas/Location.json"
  }
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

activeTaskIdstring required
assignedAtstring date-time nullable required
createdAtstring date-time required
idstring required
namestring required
providerIdstring
statestring required
stateMessagestring required
streamTokenstring
streamUrlstring required
taskCountinteger required
terminatesAtstring date-time nullable required
typestring required
updatedAtstring date-time required
userIdstring

Example response

{
  "$schema": "https://example.com/schemas/DeviceInfo.json"
}