Lock Cluster

Lock a Cluster

POST /cluster/{clusterId}/lock

Lock Cluster

cURL

curl --request POST \
  --url https://api.qovery.com/cluster/{clusterId}/lock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "ttl_in_days": 123
}
'

import requests

url = "https://api.qovery.com/cluster/{clusterId}/lock"

payload = {
    "reason": "<string>",
    "ttl_in_days": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>', ttl_in_days: 123})
};

fetch('https://api.qovery.com/cluster/{clusterId}/lock', 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/cluster/{clusterId}/lock",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>',
    'ttl_in_days' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.qovery.com/cluster/{clusterId}/lock"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"ttl_in_days\": 123\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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/cluster/{clusterId}/lock")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\",\n  \"ttl_in_days\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\",\n  \"ttl_in_days\": 123\n}"

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

200

{
  "reason": "<string>",
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "locked_at": "2023-11-07T05:31:56Z",
  "owner_name": "<string>",
  "ttl_in_days": 123
}

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

clusterId · string · required

Body

application/json

reason · string · required

ttl_in_days · integer

Response

200

application/json

OK

reason · string · required

cluster_id · string<uuid> · required

locked_at · string<date-time> · required

owner_name · string · required

ttl_in_days · integer