SandboxesManagement

Stream the changes of a sandbox

Stream the changes of one sandbox as server-sent events.

  • Each sandbox event carries the sandbox exactly as GET /v1/sandboxes/{idOrName} returns it to the caller.
  • The stream sends every sandbox at once, then again each time its response changes.
  • A removed event says that the stream sends no more events for a sandbox: it reached the deleted state, or the caller can no longer read it.
  • Close the stream after the last removed event. A browser EventSource opens a closed stream again by itself.
  • A ping event arrives every 25 s when no other event arrives.
  • The stream ends after the removed event.
GET
/v1/sandboxes/{idOrName}/events
AuthorizationBearer <token>

API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.

In: header

Path Parameters

idOrName*string

Sandbox ID (ULID) or name

Query Parameters

org?string

Required when the path names the sandbox by name.

project?string

Required when the path names the sandbox by name.

Response Body

text/event-stream

application/problem+json

curl -X GET "https://example.com/v1/sandboxes/string/events"
[  {    "data": {},    "event": "ping",    "id": 0,    "retry": 0  }]