Skip to main content
POST
Allocate a phone
Minimum role required: Member

Authorizations

X-Axilio-Api-Key
string
header
required

Customer API key (axl_ prefix).

Body

application/json

Request body for allocating a phone.

phone_type
enum<string>
required

Category of device to allocate.

Available options:
android
capture
boolean

Capture media this session produces on the phone into the org's file library (default true). false disables capture for this session entirely.

live_view
object

Hosted live-view options for this session; omit for the defaults (token auth, interactive, enabled).

name
string

Optional session label (letters, numbers, dots, hyphens, underscores; max 64). Unique among the org's active sessions - allocating with a name already in use returns a conflict.

phone_id
string

PhoneID pins allocation to a specific device (for dedicated devices).

pool
enum<string>

Which pool to draw the phone from. Omit for shared. 'dedicated' claims any idle phone your organization rents; combine with phone_id to pin a specific one.

Available options:
shared,
dedicated
recording
boolean

Record this session's screen (default true). false suppresses the video recording and rolling thumbnail entirely - no screen content is ever written.

tags
object

Optional key->value labels for organizing sessions (max 50 tags; keys up to 40 chars, values up to 128).

telemetry
boolean

Emit this session's telemetry (default true). false suppresses telemetry entirely - no live trace stream and no durable trace store; the session dashboard shows a 'telemetry disabled' state.

ttl
object

Idle timeout for this session. Omit for no idle timeout: the session runs until the 1-hour max-session cap.

workflow_id
string

Workflow requesting allocation; nil for an interactive lease.

Response

OK

Returned when a device has been successfully allocated.

phone_id
string
required

Allocated device's identifier.

session_id
string
required

Device_allocations row id — the canonical session identifier (WS-ID2).

workflow_started_at
string<date-time>
required

Timestamp when the session started.

control_url
string

WebSocket URL for driving the phone over the device control protocol.

live_view_url
string

Hosted live-view page URL (live screen + interaction, iframe-embeddable). Contains a session-scoped capability token; treat as a secret. Dies with the session.

region
string

Physical region or location of the device.

telemetry_url
string

WebSocket URL for the session's live telemetry stream (trace spans + output logs, read-only). Dies with the session.