Skip to main content
GET
Get machine
Get machine status and the tracked processes found on it. The machine is checked when requested.
See error examples and recovery steps. The complete OpenAPI contract includes every response schema.

Authorizations

Authorization
string
header
required

The server's token (MIRAGE_AUTH_TOKEN) or a JWT. A daemon in the default local mode with no token accepts requests without one.

Path Parameters

workspace_id
string
required

Workspace ID.

machine
string
required

Machine name in provider:name format.

Response

200 - application/json

OK

type
string
required

The machine's provider, such as e2b or docker, or host for the host running Mirage.

name
string
required

The machine's name under machines:; with the type it makes the machine's full name, type:name.

id
string
required

What the provider calls the machine, such as an E2B sandbox id or a container.

state
enum<string>
required

Machine access status. managed allows inspection and control of every process started by Mirage programs. reachable limits this to processes Mirage started directly. unreachable means the latest check failed.

Available options:
managed,
reachable,
unreachable
checked_at
string<date-time>
required

When the check ran.

processes
ProcessResponse · object[]
required

The processes the workspace keeps that ran on the machine.