Get Sandbox Overview

GET/v1/sandbox/overview

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)

Parameters

Name	In	Type	Required	Description
`tenantId`	query	`string`	No

Responses

200 Get sandbox subsystem overview

Property	Type	Description
`overview`	`object`	SandboxOverview provides a summary of the sandbox subsystem.

default An unexpected error response.

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

Request

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

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

Response

{
  "overview": {
    "totalInstances": 0,
    "runningInstances": 0,
    "maxSandboxes": 0,
    "backend": "string",
    "maxCpu": 0,
    "maxMemoryMb": "string",
    "healthy": true,
    "aggregateCpuPercent": 0,
    "aggregateMemoryUsage": "string",
    "aggregateMemoryLimit": "string",
    "aggregateMemoryPercent": 0,
    "aggregateNetworkRxBytes": "string",
    "aggregateNetworkTxBytes": "string",
    "aggregateBlockRead": "string",
    "aggregateBlockWrite": "string",
    "aggregatePids": 0,
    "totalExecutions": 0,
    "avgExecutionDurationMs": 0
  }
}

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