NylorunDocsBeta
Runtime APISandboxes

Read a sandbox's lifecycle events

GET
/v1/sandboxes/{sandboxId}/events

sandbox.created, sandbox.attached, sandbox.detached and sandbox.deleted, in order, numbered from 0.

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

Query Parameters

from?string

The first seq to return

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 events

application/json
  1. response
events*array<>
import { createClient } from "@nylorun/agents";const client = await createClient();const events = await client.sandboxes.events("build-box");
{  "events": [    {      "schema": "nylorun.sandbox-event/1",      "eventId": "string",      "tenantId": "string",      "sandboxId": "string",      "seq": 0,      "time": "string",      "type": "sandbox.created",      "payload": {        "property1": null,        "property2": null      }    }  ]}