NylorunDocsBeta
Runtime APISandboxes

List sandboxes

GET
/v1/sandboxes

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

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).

Query Parameters

limit?integer
Range1 <= value <= 200
cursor?string
label?|array<string>

key=value; repeat it to require several labels

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

The sandboxes; limit opts into pagination

application/json
  1. response
sandboxes*array<>
import { createClient } from "@nylorun/agents";const client = await createClient();const sandboxes = await client.sandboxes.list({ labels: { team: "ops" } });
{  "sandboxes": [    {      "id": "string",      "kind": "virtual",      "labels": {        "property1": "string",        "property2": "string"      },      "spec": {        "property1": null,        "property2": null      },      "state": "ready",      "pod": {        "desired": "running",        "observed": "creating",        "volumeGeneration": 0,        "hostEpoch": 0,        "expiresAt": "string",        "reason": "string"      },      "sessions": [        {          "id": "string",          "activeTurnId": "string"        }      ],      "createdAt": "string",      "updatedAt": "string"    }  ]}