List Sandbox Instances

GET/v1/sandbox/instances

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

tenantId (query)

status (query)

limit (query)

offset (query)

Parameters

Name	In	Type	Required
`tenantId`	query	`string`	No
`status`	query	`"SANDBOX_STATUS_UNSPECIFIED" \| "SANDBOX_STATUS_PENDING" \| "SANDBOX_STATUS_RUNNING" \| "SANDBOX_STATUS_STOPPED" \| "SANDBOX_STATUS_FAILED"`	No
`limit`	query	`integer`	No
`offset`	query	`integer`	No

Responses

200 List sandbox instances

Property	Type	Description
`instances`	`object[]`
`total`	`integer`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X GET "http://localhost:8089/v1/sandbox/instances" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch("http://localhost:8089/v1/sandbox/instances", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "http://localhost:8089/v1/sandbox/instances",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = response.json()

Response

{
  "instances": [
    {
      "id": "string",
      "sessionId": "string",
      "tenantId": "string",
      "backend": "string",
      "containerId": "string",
      "image": "string",
      "status": "SANDBOX_STATUS_UNSPECIFIED",
      "createdAt": "2024-01-01T00:00:00Z",
      "expiresAt": "2024-01-01T00:00:00Z",
      "destroyReason": "string",
      "name": "string",
      "gitRepoUrl": "string",
      "gitBranch": "string",
      "gitCommitSha": "string",
      "lifecycleState": "string",
      "revivableUntil": "2024-01-01T00:00:00Z",
      "stoppedAt": "2024-01-01T00:00:00Z",
      "sshEnabled": true
    }
  ],
  "total": 0
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}