Skip to content
Proud to collaborate with Microsoft for Startups

runner.execution-restart-gcp ​

Restart a runner execution on GCE

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-runners-gcp
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_execution_uuiduuidYes—Execution UUID to restart
runner_group_uuiduuidNo—Runner group UUID (optional, resolved from execution)
organization_uuiduuidNo—Organization UUID (optional, resolved from execution)
commandjsonNo—Command to run on the replacement VM: string or list of strings
environmentdictNo—Extra environment variables to inject into the replacement VM (vaulted — persisted state_data holds a [VAULT:...] reference)

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidNo—Runner group the execution belongs to
runner_execution_uuiduuidNo—Original RunnerExecution UUID (passed through from input)
organization_uuiduuidNo—Organization UUID (passed through from input)
commandjsonNo—Command for the replacement VM (passed through from input)
environmentdictNo—Extra environment variables for the replacement VM (passed through from input; vaulted)
old_runner_execution_uuiduuidNo—The original RunnerExecution that was stopped
new_runner_execution_uuiduuidNo—Replacement RunnerExecution this workflow created
provider_execution_idstringNo—LTIP/GCE VM reference for the replacement
registration_tokenstringNo—GitHub registration token (when applicable)
completed_atstringNo—ISO timestamp when restart finalised
failed_atstringNo—ISO timestamp when restart 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—load_execution—
getting_registration_tokenNoNo—launch_replacement—
launching_replacementNoNo—complete—
loading_executionNoNo—stop_old_execution—
stopping_old_executionNoNo—get_registration_token—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedload_executionloading_execution—
loading_executionstop_old_executionstopping_old_execution—
stopping_old_executionget_registration_tokengetting_registration_token—
getting_registration_tokenlaunch_replacementlaunching_replacement—
launching_replacementcompletecompleted—
* (any state)failfailed—

API Usage ​

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

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