Sandbox Ping

GET/v1/sandbox/{sandbox_id}/ping

GET/v1/sandbox/{'{sandbox_id}'}/ping

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)

sandbox_id (path) *

Description

Performs a health check on a sandbox instance, verifying that the sandbox is running and reachable. Returns the sandbox status and an exit code indicating the result.

Path Parameters

Parameter	Type	Required	Description
`sandbox_id`	`string`	Yes	Sandbox ID or name

Responses

200 Success

Property	Type	Description
`status`	`string`	Health status of the sandbox (e.g. `"ok"`)
`sandbox_id`	`string`	The ID of the sandbox that was pinged
`exit_code`	`integer`	Exit code of the ping operation. `0` indicates success

default An unexpected error response.

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

Request

curl -X GET "https://{instance}.{region}.everstack.ai/v1/sandbox/{sandbox_id}/ping" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const sandboxId = "your-sandbox-id";
const response = await fetch(`https://{instance}.{region}.everstack.ai/v1/sandbox/${sandboxId}/ping`, {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
});
const data = await response.json();

import requests

sandbox_id = "your-sandbox-id"
response = requests.get(
    f"https://{instance}.{region}.everstack.ai/v1/sandbox/{sandbox_id}/ping",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = response.json()

Response

{
  "status": "ok",
  "sandbox_id": "string",
  "exit_code": 0
}

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