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

List sandbox templates

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

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 list

orl sandbox template list
GET
/v1/sandbox-templates

Authorization

apiKey
headerAuthorizationBearer <token>

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

Response Body

The templates

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://api.openrelay.inc/v1/sandbox-templates'
Example Response
{  "data": [    {      "id": "string",      "name": "string",      "builtin": true,      "state": "building",      "createdAt": "2019-08-24T14:15:22Z"    }  ]}

Get a sandbox group GET

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

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.