Skip to content
Proud to collaborate with Microsoft for Startups

runner.execution-launch-do-droplet ​

Launch one runner execution on a DigitalOcean Droplet

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-runners-digitalocean
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidYes—Runner group UUID
organization_uuiduuidNo—Organization UUID
runner_execution_uuiduuidNo—Existing execution UUID to reuse
commandjsonNo—Command to run (generic mode)
environmentdictNo—Extra environment variables for the runner container (vaulted, never persisted in cleartext). Only the variable NAMES are persisted to the execution record.

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidNo—UUID of the RunnerGroup this workflow operates on, picked from the organization's list of runner groups.
organization_uuiduuidNo—UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant.
runner_execution_uuiduuidNo—UUID of the RunnerExecution this workflow operates on, picked from the organization's list of runner executions.
old_runner_execution_uuiduuidNo—UUID of the prior RunnerExecution being replaced/restarted, picked from the organization's list of runner executions.
new_runner_execution_uuiduuidNo—UUID of the new RunnerExecution created to replace the prior one, picked from the organization's list of runner executions.
registration_tokenstringNo—Ephemeral runner registration token (vaulted, never persisted in cleartext)
provider_execution_refstringNo——
regionstringNo——
app_namestringNo——
job_namestringNo——
container_imagestringNo——
is_deletedbooleanNo——
eventsjsonNo——
new_events_countintegerNo——
commandjsonNo——
environmentdictNo—Extra environment variables for the runner container (vaulted, never persisted in cleartext). Only environment_keys — the variable NAMES — reaches execution_metadata.
environment_keysjsonNo—Names (never values) of the environment variables passed to the runner
extra_tagsdictNo——
limitintegerNo——
completed_atstringNo——
failed_atstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——
reasonstringNo——
workflow_run_idstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—prepare—
getting_registration_tokenNoNo—launch_execution—
launching_executionNoNo—complete—
preparingNoNo—get_registration_token—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedpreparepreparing—
preparingget_registration_tokengetting_registration_token—
getting_registration_tokenlaunch_executionlaunching_execution—
launching_executioncompletecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "runner.execution-launch-do-droplet",
  "initial_data": {
    "runner_group_uuid": "value"
  }
}