deploy.job.run-once
Run a single one-off command in an image through the configured runner backend (schema bootstrap, ad-hoc migration, backfill) — the flat, ceremony-free sibling of deploy.database.run-migrations that needs no deployment target or release.
Run a single one-off command in an image through the configured runner backend.
Overview
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-deployments |
| Version | 1.0 |
Input Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Organization UUID. |
runner_connection_uuid | uuid | Yes | — | Runner backend connection UUID. |
image_reference | string | Yes | — | Image the job runs in. |
command | list | Yes | — | Job command argv. |
env | json | No | — | Plain environment variables. |
secret_env | json | No | — | Secret Manager env mappings. |
timeout_seconds | integer | No | — | Job timeout. |
purpose | string | No | — | Free-form label recorded as the ltinteg:purpose runner tag. |
Output Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | Echoed organization UUID. |
runner_execution_uuid | uuid | No | — | Runner execution UUID. |
purpose | string | No | — | Echoed job purpose label. |
status | string | No | — | Job status. |
exit_code | integer | No | — | Process exit code. |
log_ref | string | No | — | Runner log reference. |
started_at | string | No | — | ISO-8601 start time. |
completed_at | string | No | — | ISO-8601 completion time. |
failure_reason | string | No | — | Failure reason. |
failed_step | json | No | — | Failed step envelope. |
failed_layer | json | No | — | Failed layer envelope. |
failed_at_state | string | No | — | State where failure occurred. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
States
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | launch | — |
waiting | No | No | — | — | Polling the runner execution |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram
Transitions
| From | Action | To | Description |
|---|---|---|---|
pending | launch | waiting | — |
waiting | poll | waiting | — |
waiting | complete | completed | — |
* (any state) | fail | failed | — |
API Usage
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "deploy.job.run-once",
"initial_data": {
"organization_uuid": "value",
"runner_connection_uuid": "value",
"image_reference": "value",
"command": "value"
}
}