ci.runner-pools.delete

Delete a pool: its machines drain (a running job finishes) and go

DELETE /ci/api/runner-pools/{id}IAM ci:DeleteRunnerPoolChanges stateDestructive

Request syntax

DELETE /ci/api/runner-pools/{id}

Path parameters

  • idRequired

    string

    Constraints: uuid

Response

200 with { id, status: "deleting" }: its auto scaling group is set to zero machines and removed in the background. 404 when it 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:DeleteRunnerPool 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 runner-pools delete id

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