Skip to content
Proud to collaborate with Microsoft for Startups

runner.delete_gcp_workload ​

Delete GCE VM and instance template for a runner environment.

Delete the GCE runner workload (environment VM + instance template).

Overview ​

PropertyValue
Workflow typeDag
LibraryApp-runners-gcp
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidYes—UUID of the RunnerGroup this action 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.
workflow_run_idstringNo—Engine-stamped workflow run ID
workflow_run_uuidstringNo—Engine-stamped correlation/run id (ADR-015/E1); tolerated on input

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidNo—UUID of the RunnerGroup whose GCE workload was deleted, echoed back from the input.
organization_uuiduuidNo—UUID of the caller's organization, echoed back from the input.
cloud_connection_uuiduuidNo—UUID of the GCP CloudConnection backing this runner group's cloud backend, picked from the organization's GCP connections.
project_idstringNo——
zonestringNo——
mig_namestringNo——
workflow_run_uuidstringNo—Internal engine correlation/run identifier for this DAG execution, stamped by the engine (ADR-015/E1).
failure_reasonstringNo—Populated only when the workflow ends in FAILED
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——
prejsonNo—Output of the pre DAG step
vm_deletejsonNo—Output of the vm_delete DAG step
template_deletejsonNo—Output of the template_delete DAG step
postjsonNo—Output of the post DAG step

DAG Layers ​

#LayerStepsCompensation
1prerunner.delete_gcp_workload__pre—
2vm_deletegcp.compute.vm.delete—
3template_deletegcp.compute.instance_template.delete—
4postrunner.delete_gcp_workload__post—

Execution Flow ​

Sub-workflows ​

Sub-workflowStep name
runner.delete_gcp_workload__prepre
gcp.compute.vm.deletevm_delete
gcp.compute.instance_template.deletetemplate_delete
runner.delete_gcp_workload__postpost

API Usage ​

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

{
  "workflow_type": "runner.delete_gcp_workload",
  "initial_data": {
    "runner_group_uuid": "value"
  }
}