Stop cluster

Cluster stop has been requester.

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

Stop cluster

cURL

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

import requests

url = "https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/stop"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/stop', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/stop",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/stop"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/stop")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/organization/{organizationId}/cluster/{clusterId}/stop")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

202

{
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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

Response

202

application/json

Update cluster

cluster_id · string<uuid> · required

status · enum<string> · required

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 · required

reason · enum<string> · required

Available options: UNSPECIFIED, MAINTENANCE

next_k8s_available_version · string | null

Example:

"1.28"

last_execution_id · string | null

Example:

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

cluster_lock · ClusterLock · object | null

Show child attributes

last_deployment_date · string<date-time> | null

Example:

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