Skip to content
Proud to collaborate with Microsoft for Startups

runner.execution-stop-gcp ​

Stop a runner execution on GCE

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-runners-gcp
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_execution_uuiduuidYes—Execution UUID to stop
runner_group_uuiduuidNo—Runner group UUID (optional, resolved from execution)
organization_uuiduuidNo—Organization UUID (optional, resolved from execution)
reasonstringNo—Optional stop reason

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_execution_uuiduuidYes—RunnerExecution that was stopped
runner_group_uuiduuidNo—Runner group UUID (resolved from execution)
organization_uuiduuidNo—Organization UUID (resolved from execution)
reasonstringNo—Optional stop reason (passed through from input)
completed_atstringNo—ISO timestamp when stop finalised
failed_atstringNo—ISO timestamp when stop failed
failure_reasonstringNo—Populated only when the workflow ends in FAILED
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—stop_execution—
stopping_executionNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedstop_executionstopping_execution—
stopping_executioncompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "runner.execution-stop-gcp",
  "initial_data": {
    "runner_execution_uuid": "value"
  }
}