Rename a sandbox
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.
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.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Sandbox name: lowercase letters, digits and hyphens, 1 to 40 characters, no hyphen at the start or the end. Unique among the live sandboxes of the project. It must not be a ULID (the sandbox ID format). Send null to remove the name.
^[a-z0-9]([a-z0-9-]*[a-z0-9])?$length <= 40Response Body
application/json
application/problem+json
curl -X PUT "https://example.com/v1/sandboxes/string/rename" \ -H "Content-Type: application/json" \ -d '{ "name": "api-dev" }'{ "id": "string", "name": "string"}{ "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"}List sandboxes GET
List sandboxes you can access in an org, optionally a single project, filtered by scope (mine|shared|all). Org-owners and project-admins may pass all_owners for oversight.
Stream the changes of a sandbox GET
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.