NylorunDocsBeta
Runtime APISandboxes

Stop a pod sandbox

POST
/v1/sandboxes/{sandboxId}/stop

Suspends the pod: its volume is kept, and the next turn of a session attached to it (or a PUT) starts it again. Refused during a turn (sandbox_busy).

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

The sandbox

application/json
  1. response
id*string
kind*string
Value in"virtual""pod"
labels*
spec*
state*string
Value in"ready""creating""running""stopped"
pod?
sessions*array<>
createdAt*string
updatedAt*string
curl -X POST "https://example.com/v1/sandboxes/string/stop" \  -H "Nylorun-Protocol: string"
{  "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"}