PHphone-harness
Sessions

Get a session

Inspect state, deadline, geometry and advertised operations. A valid read-only watch grant may read only its own session. Ready does not mean a browser frame has been displayed.

get/sessions/{sid}

Request

  • Base URL
    https://api.phone-harness.com
  • Auth
    • HTTP bearer
    • or API key in query parameter token

Path parameters

sidstring required

Session ID returned by POST /sessions.

Response

Session metadata.

idstring required

Opaque session ID.

profilestring nullable

The profile id this session holds, or null for a temporary phone.

state'provisioning' | 'ready' | 'error' | 'closing' required
platform'android' | 'ios'

What the phone is: android or ios.

kind'emulator' | 'device'

How it runs: an emulator, or a real device (your own phone on a host).

devicestring nullable required

Display label in plain words ("Android emulator", "iPhone"); not a device connection address.

close_requestednumber nullable required

Time closure was requested. Unix time in seconds.

cleanup_pendingboolean required
cleanup_status'complete' | 'allocation_uncertain' | 'pending' | 'null' nullable required
billing_mode'metered' | 'disabled' required
phonestring nullable required

Legacy saved-phone ID. Null for a new disposable session.

watch_urlstring uri required

Sensitive read-only snapshot link. Not the interactive owner viewer.

age_sinteger required

Rounded seconds since creation.

ready_age_sinteger required

Rounded seconds since readiness, stopped at closure; zero before readiness.

idle_sinteger required

Rounded seconds since the last activity recorded by the API. Does not extend or replace a selected session deadline.

errorstring

Public startup failure, if present.

expires_atnumber

Absolute session expiry, including provisioning. Unix time in seconds.

timeout_secondsinteger

Selected finite duration from creation, in seconds.

request_keystring

Returned in a creation response when an idempotency key was supplied.

Changes

No recorded changes to this operation across all 1 revision of this API.