Sign in

v1

latestOpenAPI 3.1.02026-07-22154213404.8 KB
Devices

Provision a new device

Requests a new device for the authenticated user from the device spec in the request body. Optional query parameters select the device type, target country, billing mode, and a profile to use as the base spec; the response returns the device and its stream token.

post/devices

Query parameters

deviceType'dedicated_physical_device' | 'dedicated_premium_device' | 'dedicated_ios_device' | 'dedicated_emulated_device' | 'ios_simulator'
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

billing'auto' | 'subscription' | 'minute'

Billing mode. 'auto' uses a subscription slot when available and otherwise bills per minute; 'subscription' requires an available subscription slot; 'minute' bills per minute. Only cloud phone and cloud emulator devices support per-minute billing.

Billing mode. 'auto' uses a subscription slot when available and otherwise bills per minute; 'subscription' requires an available subscription slot; 'minute' bills per minute. Only cloud phone and cloud emulator devices support per-minute billing.

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
billingStrategystring
createdAtstring date-time required
createdBystring
idstring required
namestring required
ownerIdstring
providerIdstring
statestring required
stateMessagestring required
streamTokenstring
streamUrlstring required
taskCountinteger required
terminatesAtstring date-time nullable required
typestring required
updatedAtstring date-time required
userIdstring

Deprecated: use ownerId/createdBy.

Example response

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