List sandboxes
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.
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.
Authorization
apiKey API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.
In: header
Query Parameters
Organization slug.
Project slug. Omit for org-wide (across all your projects in the org).
Which sandboxes, by your relationship to them.
"mine"Value in
- "mine"
- "shared"
- "all"
Admin oversight: include everyone's sandboxes (incl. private). Requires project-admin (with project) or org-owner (org-wide).
Admin filter: restrict to this owner (email or user-id). Only valid with all_owners.
Admin filter: only sandboxes created before now minus this duration (e.g. 24h). Only valid with all_owners.
Admin filter: only sandboxes whose owner can no longer manage them. Only valid with all_owners.
Include soft-deleted sandboxes (state 'deleted'). Off by default.
Filter by sandbox state. May be repeated.
Filter by tags. Every tag must match. May be repeated.
items <= 20Keep only sandboxes created from this template version id (a ULID). Cannot be combined with template.
26 <= length <= 26Keep only sandboxes created from this template, by reference (go-dev, org/base-ubuntu, tektona/sandbox-base). Cannot be combined with template_version.
length <= 88Opaque pagination cursor from a previous response
Maximum number of items to return (1–100)
int321 <= value <= 10020Response Body
application/json
application/problem+json
curl -X GET "https://example.com/v1/sandboxes?org=string"{ "effective_role": "none", "items": [ { "access": "read", "created_at": "string", "effective_role": "none", "egress_network_policy": { "name": "string" }, "egress_proxy_profile": { "name": "string" }, "id": "string", "image": "string", "last_restart_reason": "string", "last_restarted_at": "string", "lifecycle": { "auto_delete_after": "string", "auto_pause_after": "string", "auto_pause_mode": "string", "auto_resume": true, "configured": { "auto_delete_after": "string", "auto_pause_after": "string", "auto_pause_mode": "string", "auto_resume": true }, "source": { "auto_delete_after": "own", "auto_pause_after": "own", "auto_pause_mode": "own", "auto_resume": "own" } }, "location": "string", "managed": true, "owner": { "email": "string", "id": "string", "name": "string" }, "project": { "display_name": "string", "id": "string", "name": "string", "org": "string", "slug": "string" }, "public": true, "resources": { "cpu": 2, "disk": 10, "memory": 2 }, "restart_count": 0, "share_type": "none", "state": "string", "tags": [ "string" ], "template": { "name": "go-dev", "reference": "go-dev", "scope": "system", "tag": "stable", "version_id": "01JABCDEF0123456789ABCDEFG" } } ], "pagination": { "has_more": true, "next_cursor": "string", "total_count": 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"}Get a sandbox GET
Get a sandbox by ID.
Detach a sandbox's egress proxy profile PUT
Remove the sandbox's egress proxy profile attachment. The sandbox keeps its egress network policy; it just loses credential injection. A running sandbox picks up the change within seconds, without a restart. Detaching with nothing attached returns 409.