ci.runners.disable

Disable a runner and revoke its credential

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

The row is kept so past runs still name the machine that ran them; the credential is overwritten, so the machine stops working immediately.

Request syntax

DELETE /ci/api/runners/{id}

Path parameters

  • idRequired

    string

    Constraints: uuid

Response

200 with the runner as now stored, status disabled (no credential hash or session). Disabling a disabled runner answers 200 again. 404 when no runner of this organization has that id.

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 disable id

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