SandboxesManagement

Get a sandbox

Get a sandbox by ID or by name with the org and project query parameters.

GET
/v1/sandboxes/{idOrName}
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

application/json

application/problem+json

curl -X GET "https://example.com/v1/sandboxes/string"
{  "access": "read",  "access_credentials": [    "api_key"  ],  "access_endpoint": "https://fr-par-1.access.sandbox.tektona.app",  "created_at": "string",  "effective_role": "none",  "egress_network_policy": {    "name": "string"  },  "egress_proxy_profile": {    "name": "string"  },  "error": {    "at": "string",    "message": "sandbox user \"dev\" does not exist in the image",    "reason": "start_failed"  },  "id": "string",  "image": "string",  "image_pull": {    "bytes_done": 0,    "bytes_total": 0,    "estimated_seconds": 0  },  "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    },    "run_deadline": "2019-08-24T14:15:22Z",    "running_since": "2019-08-24T14:15:22Z",    "source": {      "auto_delete_after": "own",      "auto_pause_after": "own",      "auto_pause_mode": "own",      "auto_resume": "own"    }  },  "managed": true,  "name": "string",  "owner": {    "email": "string",    "id": "string",    "kind": "human",    "name": "string"  },  "project": {    "display_name": "string",    "id": "string",    "name": "string",    "org": "string",    "slug": "string"  },  "public": true,  "region": "fr-par-1",  "resources": {    "cpu": 2,    "disk": 10,    "memory": 2  },  "restart_count": 0,  "share_type": "none",  "state": "creating",  "state_reason": "string",  "tags": [    "string"  ],  "template": {    "name": "go-dev",    "reference": "go-dev",    "scope": "system",    "tag": "stable",    "version_id": "01JABCDEF0123456789ABCDEFG"  }}