Appearance
runner.instance-heartbeat ​
Heartbeat a DevKit runner instance and refresh safe protocol metadata.
Renew liveness without allowing a draining runner to reactivate itself.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-runners |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Authenticated organization; injected by the workflow API. |
runner_instance_uuid | uuid | Yes | — | — |
control_token | string | No | — | Opaque credential held only by the registered DevKit runner. |
protocol_version | string | Yes | — | — |
software_version | string | No | — | — |
capabilities | list | No | — | — |
max_concurrency | integer | No | — | — |
requested_status | string | No | — | — |
last_claim_error | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | — |
runner_group_uuid | uuid | No | — | — |
runner_instance_uuid | uuid | No | — | — |
runner_execution_uuid | uuid | No | — | — |
integration_test_attempt_uuid | uuid | No | — | — |
workspace_lease_uuid | uuid | No | — | — |
agent_session_uuid | uuid | No | — | — |
ticket_uuid | uuid | No | — | — |
ticket_git_work_uuid | uuid | No | — | — |
repository_uuid | uuid | No | — | — |
coding_artifact_uuid | uuid | No | — | — |
executor_key | string | No | — | — |
control_token | string | No | — | — |
worktree_uuid | uuid | No | — | — |
protocol_version | string | No | — | — |
software_version | string | No | — | — |
capabilities | list | No | — | — |
max_concurrency | integer | No | — | — |
requested_status | string | No | — | — |
last_claim_error | string | No | — | — |
instance_status | string | No | — | — |
phase | string | No | — | — |
head_oid | string | No | — | — |
test_id | string | No | — | — |
argv | list | No | — | — |
timeout_seconds | integer | No | — | — |
max_output_bytes | integer | No | — | — |
network_mode | string | No | — | — |
egress_rules | list | No | — | — |
host_aliases | list | No | — | — |
credential_envelope | string | No | — | — |
expires_at | string | No | — | — |
exit_code | integer | No | — | — |
result_digest | string | No | — | — |
outcome | string | No | — | — |
failure_summary | string | No | — | — |
failure_code | string | No | — | — |
validation_evidence | list | No | — | — |
drain_reason | string | No | — | — |
heartbeat_at | string | No | — | — |
completed_at | string | No | — | — |
heartbeat_interval_seconds | integer | No | — | — |
lease_timeout_seconds | integer | No | — | — |
startup_timeout_seconds | integer | No | — | — |
drain | boolean | No | — | — |
assignment | dict | No | — | — |
found | boolean | No | — | — |
claimable | boolean | No | — | — |
items | list | No | — | — |
blocked_items | list | No | — | — |
mutation_controls | list | No | — | — |
retry_requests | list | No | — | — |
retry_request | dict | No | — | — |
drain_decision | dict | No | — | — |
retry_workflow_uuid | string | No | — | — |
limit | integer | No | — | — |
candidate_count | integer | No | — | — |
reconciled_count | integer | No | — | — |
skipped_count | integer | No | — | — |
failure_reason | string | No | — | — |
failed_at | string | No | — | — |
request_uuid | uuid | No | — | — |
reason | string | No | — | — |
blocker_code | string | No | — | — |
idempotency_key | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
workflow_run_id | string | No | — | DAG parent run ID (stamped by engine) |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.instance-heartbeat",
"initial_data": {
"organization_uuid": "value",
"runner_instance_uuid": "value",
"protocol_version": "value"
}
}