API / deregister-a-pool-via-api

API

Deregister a pool via the Cloud Agents API

Soft-delete a durable pool so it no longer appears in pool pickers or List Pools with DELETE https://api.cursor.com/v0/private-workers/pools. Official reference: Cloud Agents API → Deregister A Pool (Workers and Pools).

The Cloud Agents API v1 is in public beta. Paths keep the older private-workers name; they refer to the same Self-Hosted Machines workers. Authenticate with the pool's service account API key via Basic auth (-u "$CURSOR_API_KEY:") or Authorization: Bearer. Other API key types are rejected for these endpoints. Availability: Beta (all plans) per the API overview.

Workers currently connected to the pool are not affected. Team pools require a team admin; user pools require their owner.

Query parameters

Param Required Meaning
scope yes Pool ownership scope. One of user or team.
pool_name yes Pool name to deregister.
repo_owner no Repository owner when deregistering a repo-scoped pool record.
repo_name no Repository name when deregistering a repo-scoped pool record. Provide repo_owner and repo_name together, or omit both for an any-repo pool.
curl --request DELETE \
  --url "https://api.cursor.com/v0/private-workers/pools?scope=team&pool_name=sandbox" \
  -u "$CURSOR_API_KEY:"

Response

{
  "deregistered": true
}

Pair this with List and register pools when a controller tears down capacity after scale-to-zero, or when a named pool should leave pickers without stopping workers that are already connected.