Skip to main content
GET
/
v1
/
sandboxes
List sandboxes
curl --request GET \
  --url https://api.runtools.ai/v1/sandboxes \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "sandbox-abc123def456",
      "name": "<string>",
      "status": "pending",
      "tags": [
        "<string>"
      ],
      "template": "<string>",
      "ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ownerDisplayName": "<string>",
      "ownerEmail": "<string>",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "mounts": [
        {
          "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "path": "/workspace",
          "readOnly": true
        }
      ],
      "hasWritableWorkspaceMount": true,
      "sshReady": true,
      "vncReady": true,
      "ip": "<string>",
      "publicIp": "<string>",
      "sshAccessConfigured": true,
      "sshAuthMethod": "key",
      "vncUrl": "<string>",
      "resources": {
        "vcpus": 2,
        "memory": "4GB",
        "disk": "10GB"
      },
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.runtools.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

WorkOS session token or RunTools API key (rt_live_* / rt_test_*). Used in Authorization: Bearer <token> header.

Query Parameters

​
status
enum<string>
Available options:
pending,
creating,
running,
pausing,
paused,
resuming,
destroying,
destroyed,
stopped,
failed,
error,
orphaned,
suspected_missing
​
tag
string
​
template
string
​
exclude_template
string
​
limit
integer

Maximum number of rows to return.

Required range: 1 <= x <= 500
​
cursor
string

Opaque pagination cursor returned by a prior page.

​
all
boolean

Include resources for all members of the org (admin only).

Response

Page of sandboxes.

​
data
object[]
​
hasMore
boolean
​
nextCursor
string | null