Skip to main content
GET
Get environment

Authorizations

X-Asteroid-Agents-Api-Key
string
header
required

Path Parameters

environmentId
string<uuid>
required

The environment to read.

Response

The request has succeeded.

A single environment: what it is, its provider state, and how to drive it. state is the same shape the execution endpoint returns, so the LiveView/OsLiveView components render either without branching.

connection
object
required

How to connect to it.

createdAt
string<date-time>
required

When the environment row was created.

environmentType
enum<string>
required

Browser or OS.

Available options:
browser,
os
expiresAt
string<date-time>
required

When the reaper will tear the environment down if no graceful Stop arrives first.

hasRecording
boolean
required

Whether a playable recording has been persisted (GCS object or provider URL). The playable URL itself is minted on the by-id read.

id
string<uuid>
required

Environment identifier.

organizationId
string<uuid>
required

The organisation the environment belongs to.

owner
object
required

Who the environment belongs to, and the identity that owner carries.

state
object
required

Environment state (browser or OS): live-view URL, viewport, provider config and a freshly-minted recording URL when one exists.

status
enum<string>
required

Current status, terminal states included. Lists exclude terminal environments unless includeTerminal is set.

Available options:
requested,
provisioning,
ready,
stopping,
stopped,
failed,
dead
agentProfileId
string<uuid>

Profile snapshot the environment was booted against, if any.

osType
enum<string>

Operating system for OS environments. Absent for browser environments; linux when an OS environment predates explicit osType storage.

Available options:
linux,
windows
readyAt
string<date-time>

When the environment first became ready, if it reached that state.

stoppedAt
string<date-time>

When the environment reached a terminal state. Set after Stop runs.