ci.runners.set-group

Move a runner into a runner group, or back to Default

PATCH /ci/api/runners/{id}IAM ci:ManageRunnersChanges stateDestructive

Request syntax

PATCH /ci/api/runners/{id}
{
  "groupId": "string"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • groupIdRequired

    string

    A runner group of this organization (404 otherwise); null moves the runner to Default. Required

    Constraints: uuid

    May be null.

Response

200 with the runner as stored (id, name, labels, status, groupId, …; never its credential hash or session). 404 when the runner or the group is not in this organization.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow ci:ManageRunners on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud ci runners set-group id --group-id 00000000-0000-0000-0000-000000000000

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_ci_runners_set-group.