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 template

Returns a sandbox template and the state of its builds. Use the template's id to create sandboxes after its build is ready.

Required permission

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

Command line

The orl CLI wraps this endpoint:

Guided workflow: orl sandbox template get

orl sandbox template get <template-id>
GET
/v1/sandbox-templates/{templateId}

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

templateId*string

Response Body

The template

application/json
  1. response
id*string
name*string
builtin?boolean
state*string
Value in"building""ready""failed"
createdAt?string
Formatdate-time
Example Request
curl -X GET 'https://api.openrelay.inc/v1/sandbox-templates/string'
Example Response
{  "id": "string",  "name": "string",  "builtin": true,  "state": "building",  "createdAt": "2019-08-24T14:15:22Z"}

Create a sandbox template POST

Starts a build of a template from an image and its init steps. A sandbox can start from it once a build reaches the hosts.

Get the organization's sandbox network policy GET

Returns the organization's sandbox network layer, defaults and version, plus the members and API keys with their own policy layers. Send the bundle's version as expectedVersion on a write. Every layer is a ceiling on the sandboxes created under it. 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.