Stream the changes of a sandbox
Stream the changes of one sandbox as server-sent events.
- Each
sandboxevent carries the sandbox exactly asGET /v1/sandboxes/{idOrName}returns it to the caller. - The stream sends every sandbox at once, then again each time its response changes.
- A
removedevent 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
removedevent. A browserEventSourceopens a closed stream again by itself. - A
pingevent arrives every 25 s when no other event arrives. - The stream ends after the
removedevent.
Authorization
apiKey API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.
In: header
Path Parameters
Sandbox ID (ULID) or name
Query Parameters
Required when the path names the sandbox by name.
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 }]{ "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}Rename a sandbox PUT
Set or remove the name of a sandbox. A name is unique among the live sandboxes of the project: a name that another live sandbox holds returns 409. A sandbox in failed, deleting or deleted holds no name for this check. Rename is not allowed while the sandbox is deleting or deleted.
Stream the changes of several sandboxes GET
Stream the changes of up to 100 sandboxes 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 caller must be able to read every sandbox when the stream opens. - The stream ends after the last `removed` event.