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

Delete a sandbox template

Deletes one of your organization's templates, in any state, and frees its place in the organization's template limit. A create that names the template is refused within a few seconds, once the API's routers have taken the change. A create accepted before that may still start while it waits for capacity (its waitSeconds). Sandboxes already created from the template keep running until they end, paused ones included. A built-in template answers 403 TEMPLATE_BUILTIN. Repeating a delete answers 404. A 503 SERVICE_UNAVAILABLE means the delete was not confirmed and may have been applied: repeat it, and a 404 NOT_FOUND then means it was.

Required permission

Requires the sandboxes.template_write 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 delete

orl sandbox template delete <template-id>
DELETE
/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 is deleted

Example Request
curl -X DELETE 'https://api.openrelay.inc/v1/sandbox-templates/string'
Example Response
Empty