Skip to main content
GET
List processes
List running and recently ended processes, ordered by process ID. Filter by session, state, command execution, job, or machine. Ended processes are retained for up to one hour, with a maximum of 1,024 records. Servers sharing a workspace store share these records; snapshots preserve ended records. Times are RFC 3339 strings in UTC.
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.

Query Parameters

session_id
string

Filter by session ID. If omitted, include all sessions.

state
enum<string>

Filter by execution state.

Available options:
running,
stopping,
exited
line_id
string

Command execution ID returned as line_id by the shell endpoint.

job_id
string

Filter processes by job ID (job_ and 32 hex digits), including descendant processes.

machine
string

Filter by machine name in provider:name format.

Response

200 - application/json

OK

items
ProcessResponse · object[]
required