ReferenceStructures
CommandExecutionRecord
The command job object returned by command execution endpoints.
CommandExecutionRecord represents a queued, running, or completed command execution inside a container. It is returned by both POST /api/v1/containers/{id}/commands (on enqueue) and GET /api/v1/commands/{id} (on poll).
Fields
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Unique job identifier. Use this to poll status via GET /api/v1/commands/{id}. |
container_id | string (UUID) | ID of the container the command is executing in. |
requested_by | string (UUID) | User ID of the actor who submitted the command. |
program | string | Executable path or name (e.g. "apt-get", "/usr/bin/python3"). |
args | array of strings | Arguments passed to the program. May be empty. |
status | string | Execution status. One of "queued", "running", "succeeded", "failed", "cancelled". |
stdout | string | Standard output captured from the command. Empty string while the command is still running. |
stderr | string | Standard error captured from the command. Empty string while the command is still running. |
created_at | string (ISO 8601) | UTC timestamp when the job was enqueued. |
Status values
| Value | Meaning |
|---|---|
"queued" | Job has been accepted but the worker has not started it yet. |
"running" | Worker is actively executing the command inside the container. |
"succeeded" | Command exited with code 0. stdout and stderr contain the full captured output. |
"failed" | Command exited with a non-zero code, or an internal error occurred. Check stderr for details. |
"cancelled" | Job was cancelled before it started executing. |
Example (queued)
{
"id": "a1b2c3d4-0000-0000-0000-000000000001",
"container_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"requested_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"program": "apt-get",
"args": ["update"],
"status": "queued",
"stdout": "",
"stderr": "",
"created_at": "2025-06-15T12:05:00Z"
}Example (succeeded)
{
"id": "a1b2c3d4-0000-0000-0000-000000000001",
"container_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"requested_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"program": "apt-get",
"args": ["update"],
"status": "succeeded",
"stdout": "Hit:1 http://deb.debian.org/debian bookworm InRelease\nReading package lists... Done\n",
"stderr": "",
"created_at": "2025-06-15T12:05:00Z"
}