Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeLinear
LibraryApp-deployments
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID.
runner_connection_uuiduuidYes—Runner backend connection UUID.
image_referencestringYes—Image the job runs in.
commandlistYes—Job command argv.
envjsonNo—Plain environment variables.
secret_envjsonNo—Secret Manager env mappings.
timeout_secondsintegerNo—Job timeout.
purposestringNo—Free-form label recorded as the ltinteg:purpose runner tag.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Echoed organization UUID.
runner_execution_uuiduuidNo—Runner execution UUID.
purposestringNo—Echoed job purpose label.
statusstringNo—Job status.
exit_codeintegerNo—Process exit code.
log_refstringNo—Runner log reference.
started_atstringNo—ISO-8601 start time.
completed_atstringNo—ISO-8601 completion time.
failure_reasonstringNo—Failure reason.
failed_stepjsonNo—Failed step envelope.
failed_layerjsonNo—Failed layer envelope.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—launch—
waitingNoNo——Polling the runner execution
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendinglaunchwaiting—
waitingpollwaiting—
waitingcompletecompleted—
* (any state)failfailed—

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"
  }
}