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 a sandbox group

Returns the progress of a sandbox group while its create request is running, including the requested count and the members started.

Required permission

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

GET
/v1/sandbox-groups/{groupId}

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

groupId*string

Response Body

The group

application/json
  1. response
id*string
template*string
requested*integer
minReady*integer
started*integer
createdAt?string
Formatdate-time
Example Request
curl -X GET 'https://api.openrelay.inc/v1/sandbox-groups/string'
Example Response
{  "id": "string",  "template": "string",  "requested": 0,  "minReady": 0,  "started": 0,  "createdAt": "2019-08-24T14:15:22Z"}

Create many sandboxes as one group POST

Starts a group of sandboxes, reserving at least minReady together. Streams group progress and each sandbox as capacity becomes available. Starts the rest as capacity allows, until all n run or waitSeconds expires. The answer is a stream with a group line, one sandbox line per member as it starts, and, if some never fit, a last error line with code CAPACITY_EXHAUSTED and the count started. A 503 means minReady never fit together within waitSeconds, and nothing was started.

List sandbox templates GET

Lists the built-in sandbox templates and your organization's own templates. Choose a ready template's id when creating a sandbox.