Start a process
Start a process in a sandbox. With wait=true, blocks until the process exits (up to wait_timeout_seconds) and returns the finished result; otherwise returns the running process. Always auto-resumes a paused sandbox.
Start a process in a sandbox. With wait=true, blocks until the process exits (up to wait_timeout_seconds) and returns the finished result; otherwise returns the running process. Always auto-resumes a paused sandbox.
Authorization
apiKey API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.
In: header
Path Parameters
Sandbox ID (ULID)
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Persist the definition and relaunch on every boot; requires name
Shell command, executed as a process group
1 <= lengthWorking directory
Environment variables
Log retention cap in bytes; null = sandbox default, 0 = logging off
int640 <= valueOptional name ([a-z0-9_-], unique among running processes); a memorable name is generated when omitted
^[a-z0-9]([a-z0-9_-]*[a-z0-9])?$length <= 64Behavior when the sandbox pauses
"preserve""preserve" | "stop" | "restart_after_resume"Keep the sandbox awake while this process runs
Kill the process group after this many seconds (0 = no timeout)
int640 <= valueTTY config; tty.enabled=true allocates a PTY at cols/rows, otherwise pipe mode
Run-as Linux user; defaults to the image's default user
Block until the process exits, up to wait_timeout_seconds
Wait cap in seconds (1–120)
60int641 <= value <= 120Response Body
application/json
application/problem+json
curl -X POST "https://api-dev.tektona.ai/v1/sandboxes/string/processes" \ -H "Content-Type: application/json" \ -d '{ "command": "string" }'{ "$schema": "https://api-dev.tektona.ai/schemas/ProcessDTO.json", "already_finished": true, "autostart": true, "command": "string", "cwd": "string", "error": "string", "exit_code": 0, "finish_reason": "string", "finished_at": "2019-08-24T14:15:22Z", "id": "string", "max_log_bytes": 0, "name": "string", "on_hibernate": "string", "pid": 0, "prevent_auto_pause": true, "restarted_from": "string", "signal": "string", "started_at": "2019-08-24T14:15:22Z", "status": "running", "stderr": "string", "stdout": "string", "tty": { "cols": 0, "enabled": true, "rows": 0 }, "user": "string"}{ "$schema": "https://api-dev.tektona.ai/schemas/ErrorModel.json", "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"}