Skip to content
Proud to collaborate with Microsoft for Startups

runner.environment-health-check ​

Cloud-side health check for the AWS Fargate (ECS) runner environment.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-runners
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidYes—UUID of the RunnerGroup this health check operates on, picked from the organization's list of runner groups.
organization_uuiduuidYes—UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant.
actorstringNo—User or service actor initiating the health check.
workflow_run_uuidstringNo—Engine workflow-run identifier; not a platform entity foreign key despite the name. System-generated, no source.

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidNo—RunnerGroup uuid, echoed from input.
organization_uuiduuidNo—Organization uuid, echoed from input.
actorstringNo——
workflow_run_uuidstringNo——
statusstringNo—Terminal health status (healthy
summaryjsonNo—Aggregated Fargate health summary (cluster + resource rollup).
resource_refsjsonNo—References to the RunnerCloudResource rows probed.
warningslistNo—Non-fatal warnings (missing services, degraded probe, ...).
completed_atstringNo——
failure_reasonstringNo——
failed_stepjsonNo——
failed_layerjsonNo——
failed_at_statestringNo——
failed_atstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—probe—
probingNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedprobeprobing—
probingcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "runner.environment-health-check",
  "initial_data": {
    "runner_group_uuid": "value",
    "organization_uuid": "value"
  }
}