NylorunDocsBeta
Runtime APISandboxes

Delete a sandbox

DELETE
/v1/sandboxes/{sandboxId}

Deletes the sandbox and its files. Sessions attached to it stay attached by id; their next turn is refused until a sandbox with this id exists again.

Authorization

headerAuthorizationBearer <token>

An application key of the Tenant (PUT /v1/tenant/keys/{keyId}), or Studio's key, derived from the admin key. With Nylorun-Subject and Nylorun-Scopes, it acts for that person, narrowed to those scopes. Never accepted from a browser (Origin).

Path Parameters

sandboxId*string

The sandbox id, percent-encoded: team-a%2Fproj-42 for team-a/proj-42

Header Parameters

Nylorun-Protocol*string

The protocol version, 8

Nylorun-Subject?string

The person an application key acts for

Nylorun-Scopes?string

The subject's space-separated scopes; required with a subject

Response Body

Deleted, or there was none

application/json
  1. response
id*string
deleted*boolean
import { createClient } from "@nylorun/agents";const client = await createClient();await client.sandboxes.delete("build-box");
{  "id": "string",  "deleted": true}

Get a sandbox GET

Its spec, labels, state and the sessions attached to it (acting for a person, only theirs).

List sandboxes GET

Every sandbox with all the labels asked for. A token caller sees only the sandboxes its grants reach.