Appearance
runner.execution-stop-do-app-job ​
Stop a runner execution on DigitalOcean App Platform Jobs
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-runners-digitalocean |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_execution_uuid | uuid | Yes | — | Runner execution UUID to stop |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | No | — | UUID of the RunnerGroup this workflow operates on, picked from the organization's list of runner groups. |
organization_uuid | uuid | No | — | UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. |
runner_execution_uuid | uuid | No | — | UUID of the RunnerExecution this workflow operates on, picked from the organization's list of runner executions. |
old_runner_execution_uuid | uuid | No | — | UUID of the prior RunnerExecution being replaced/restarted, picked from the organization's list of runner executions. |
new_runner_execution_uuid | uuid | No | — | UUID of the new RunnerExecution created to replace the prior one, picked from the organization's list of runner executions. |
registration_token | string | No | — | Ephemeral runner registration token (vaulted, never persisted in cleartext) |
provider_execution_ref | string | No | — | — |
region | string | No | — | — |
app_name | string | No | — | — |
job_name | string | No | — | — |
container_image | string | No | — | — |
is_deleted | boolean | No | — | — |
events | json | No | — | — |
new_events_count | integer | No | — | — |
command | json | No | — | — |
environment | dict | No | — | Extra environment variables for the runner container (vaulted, never persisted in cleartext). Only environment_keys — the variable NAMES — reaches execution_metadata. |
environment_keys | json | No | — | Names (never values) of the environment variables passed to the runner |
extra_tags | dict | No | — | — |
limit | integer | No | — | — |
completed_at | string | No | — | — |
failed_at | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
reason | string | No | — | — |
workflow_run_id | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | stop_execution | — |
stopping | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | stop_execution | stopping | — |
stopping | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.execution-stop-do-app-job",
"initial_data": {
"runner_execution_uuid": "value"
}
}