---
title: "Stop cluster"
method: POST
path: "/organization/{organizationId}/cluster/{clusterId}/stop"
tags: ["Clusters"]
---

# Stop cluster

`POST /organization/{organizationId}/cluster/{clusterId}/stop`

## Request

- Base URL: `https://api.qovery.com`
- URL: `https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/stop`
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/qovery/apis/qovery-api/docs/organization/:organizationId/cluster/:clusterId/stop/post.ts> (a function with typed inputs; its response is checked against the schema)

Cluster stop has been requester.

## Path parameters

- `organizationId` string, uuid, required
- `clusterId` string, uuid, required

## Response `202`

Update cluster

- ClusterStatus
  - `cluster_id` string, uuid
  - `status` 'BUILDING' | 'BUILD_ERROR' | 'CANCELED' | 'CANCELING' | 'DELETED' | 'DELETE_ERROR' | 'DELETE_QUEUED' | 'DELETING' | 'DEPLOYED' | 'DEPLOYING' | 'DEPLOYMENT_ERROR' | 'DEPLOYMENT_QUEUED' | 'DRY_RUN' | 'QUEUED' | 'READY' | 'STOPPED' | 'STOPPING' | 'STOP_ERROR' | 'STOP_QUEUED' | 'RESTART_QUEUED' | 'RESTARTING' | 'RESTARTED' | 'RESTART_ERROR' | 'INVALID_CREDENTIALS'
  - `is_deployed` boolean
  - `next_k8s_available_version` string, nullable
  - `last_execution_id` string
  - `cluster_lock` ClusterLock
    - `reason` string, required
    - `ttl_in_days` integer
    - `cluster_id` string, uuid, required
    - `locked_at` string, date-time, required
    - `owner_name` string, required
  - `last_deployment_date` string, date-time

## Other responses

- `401`: Access token is missing or invalid
- `403`: Access forbidden
- `404`: Resource not found
- `409`: Cluster is already stopped or an operation is in progress

---

[API](https://skmtc.dev/qovery/apis/qovery-api.md) - [All operations](https://skmtc.dev/qovery/apis/qovery-api/llms.txt) - [OpenAPI document](https://skmtc.dev/qovery/apis/qovery-api/revisions/93c4960a44ba?raw)