Deploy a cluster

allows to deploy a cluster

POST /organization/{organizationId}/cluster/{clusterId}/deploy

Deploy a cluster

cURL

curl --request POST \
  --url https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/deploy \
  --header 'Authorization: Bearer <token>'

201

{
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "BUILDING",
  "is_deployed": true,
  "next_k8s_available_version": "1.28",
  "last_execution_id": "f73e3833-922a-48a5-9dbd-6163f43f9143-1656410242",
  "cluster_lock": {
    "reason": "<string>",
    "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "locked_at": "2023-11-07T05:31:56Z",
    "owner_name": "<string>",
    "ttl_in_days": 123
  },
  "last_deployment_date": "2022-06-22T14:20:17.733084815Z"
}

Authorizations

bearerAuthApiKeyAuth

Authorization · string · header · required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

organizationId · string<uuid> · required

Organization ID

clusterId · string<uuid> · required

Cluster ID

Query Parameters

dry_run · boolean

default: false. Decide if the deployment of the cluster should be done in dry_run mode. Avoiding any changes

Response

201

application/json

Deploy cluster

cluster_id · string<uuid>

status · enum<string>

Available options: 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 | null

Example:

"1.28"

last_execution_id · string

Example:

"f73e3833-922a-48a5-9dbd-6163f43f9143-1656410242"

cluster_lock · ClusterLock · object

Show child attributes

last_deployment_date · string<date-time>

Example:

"2022-06-22T14:20:17.733084815Z"