Skip to content
Proud to collaborate with Microsoft for Startups

runner.environment-update-do-app-job ​

Update DigitalOcean App Job environment for a runner group

Update DigitalOcean app-job metadata after runner group changes.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-runners-digitalocean
Version1.0

Input 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.

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—
preparingNoNo—update_environment—
updatingNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedpreparepreparing—
preparingupdate_environmentupdating—
updatingcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "runner.environment-update-do-app-job",
  "initial_data": {
    "runner_group_uuid": "value",
    "organization_uuid": "value"
  }
}