Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Skip to Content
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceComputeSandboxes

Get the current sandbox fleet observation

Read active sandbox counts and configured vCPUs for your organization, with observation timestamps and host coverage. Returns the organization's active sandbox sessions and their configured vCPUs from fresh host observations. Active sessions include paused sessions; these counts do not describe currently executing commands or physically reserved CPU. Incomplete observations identify the reporting and expected host counts. Availability is enabled per organization; unavailable organizations receive 404.

Required permission

Requires the sandboxes.read permission. See Permissions for the roles and API key permissions that include it.

GET
/v1/sandbox-monitoring/current

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Response Body

Cached fleet observation

application/json
  1. response

A cached observation of open sandbox sessions, including paused sessions. No guest is awakened by this read.

observedAt*string

Oldest contributing host observation in RFC3339 UTC, or empty when no configured host is fresh.

activeSandboxes*integer
Formatint64
Range0 <= value
configuredVcpus*integer
Formatint64
Range0 <= value
hostsReporting*integer
Range0 <= value
hostsExpected*integer
Range0 <= value
complete*boolean

True only when every configured host has a fresh observation.

Example Request
curl -X GET 'https://api.openrelay.inc/v1/sandbox-monitoring/current'
Example Response
{  "observedAt": "string",  "activeSandboxes": 0,  "configuredVcpus": 0,  "hostsReporting": 0,  "hostsExpected": 0,  "complete": true}

Replace an API key's sandbox network policy PUT

Replaces an API key's layer over the version the policy was read at. A key may only narrow it, its own or another key's. Network policy access must be enabled for the organization. Host egress, DNS and bandwidth enforcement is not yet available. Creates requiring an unsupported restriction return 503 NETWORK_POLICY_UNSUPPORTED. Only the organization layer's preview source restrictions are enforced. Host policy updates are not pushed to running sandboxes. The router applies updated organization preview restrictions on each new request, including previews of existing sandboxes, after receiving the new policy version.

Overview

Prepaid balance, saved cards, deposits, and auto-recharge: read the balance and recent transactions, save or remove cards, and top up from a saved card.