Appearance
agents.runner-group.enable ​
Enable agent support on a runner group that is in ACTIVE status
Enable agent workload support on an ACTIVE runner group.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-agents |
| Version | 1.0 |
Triggers ​
| Source | Endpoint / Event | Description |
|---|---|---|
| API | POST /api/agents/runner-groups/{runner_group_uuid}/enable | API — enable or disable agent support on a runner group |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | string | Yes | — | — |
organization_uuid | string | Yes | — | — |
agent_max_concurrent | integer | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
agent_max_concurrent | json | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
failed_at_state | string | No | — | — |
failed_layer | json | No | — | — |
failed_step | string | No | — | — |
failure_reason | string | No | — | — |
runner_group_uuid | json | No | — | — |
supports_agents | json | No | — | — |
organization_uuid | json | No | — | — |
coding_artifact_storage_configured | boolean | No | — | — |
coding_artifact_storage_binding_digest | string | No | — | — |
coding_artifact_retention_days | integer | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | run | — |
run | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | run | run | — |
run | complete | completed | — |
* (any state) | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
enabled | SUCCESS | Runner group enabled for agents | runner_group_uuid, supports_agents, organization_uuid |
failed | FAILURE | Runner group enabled for agents failed | failure_reason, error, error_type, failed_at_state, failed_step, failed_layer |
Business Errors ​
| Code | Message Template |
|---|---|
AGENTS_ORGANIZATION_CONTEXT_INVALID | Authenticated organization context is missing or does not match the workflow input |
AGENTS_RUNNER_GROUP_NOT_FOUND | Runner group {runner_group_uuid} was not found in the organization |
AGENTS_VALIDATION_FAILED | Workflow input or domain state failed validation: |
AGENTS_CONFLICT | Conflicting agent domain state: |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "agents.runner-group.enable",
"initial_data": {
"runner_group_uuid": "value",
"organization_uuid": "value"
}
}