Get Sandbox Instance

GET/v1/sandbox/instances/{sandboxId}

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)

sandboxId (path) *

tenantId (query)

Parameters

Name	In	Type	Required	Description
`sandboxId`	path	`string`	Yes
`tenantId`	query	`string`	No

Responses

200 Get a sandbox instance by ID

Property	Type	Description
`instance`	`object`	SandboxInstance represents a running sandbox environment.

default An unexpected error response.

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

Request

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

const response = await fetch("http://localhost:8089/v1/sandbox/instances/{sandboxId}", {
  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/{sandboxId}",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = response.json()

Response

{
  "instance": {
    "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
  }
}

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