Update cluster

curl --request PATCH \
  --url https://api.cnap.tech/v1/clusters/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "staging",
  "region_id": "<string>"
}
'

import requests

url = "https://api.cnap.tech/v1/clusters/{id}"

payload = {
    "name": "staging",
    "region_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'staging', region_id: '<string>'})
};

fetch('https://api.cnap.tech/v1/clusters/{id}', 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.cnap.tech/v1/clusters/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'staging',
    'region_id' => '<string>'
  ]),
  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.cnap.tech/v1/clusters/{id}"

	payload := strings.NewReader("{\n  \"name\": \"staging\",\n  \"region_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.cnap.tech/v1/clusters/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"staging\",\n  \"region_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cnap.tech/v1/clusters/{id}")

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

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

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

{
  "id": "j572abc123def456",
  "name": "production",
  "workspace_id": "j572abc123def456",
  "region_id": "j572abc123def456",
  "kaas": {
    "version": "v1.30",
    "status": "RUNNING",
    "status_message": null
  },
  "created_at": 123
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

PATCH

clusters

{id}

Update cluster

curl --request PATCH \
  --url https://api.cnap.tech/v1/clusters/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "staging",
  "region_id": "<string>"
}
'

import requests

url = "https://api.cnap.tech/v1/clusters/{id}"

payload = {
    "name": "staging",
    "region_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'staging', region_id: '<string>'})
};

fetch('https://api.cnap.tech/v1/clusters/{id}', 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.cnap.tech/v1/clusters/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'staging',
    'region_id' => '<string>'
  ]),
  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.cnap.tech/v1/clusters/{id}"

	payload := strings.NewReader("{\n  \"name\": \"staging\",\n  \"region_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.cnap.tech/v1/clusters/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"staging\",\n  \"region_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cnap.tech/v1/clusters/{id}")

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

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

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

{
  "id": "j572abc123def456",
  "name": "production",
  "workspace_id": "j572abc123def456",
  "region_id": "j572abc123def456",
  "kaas": {
    "version": "v1.30",
    "status": "RUNNING",
    "status_message": null
  },
  "created_at": 123
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

Personal Access Token (cnap_pat_...) or OAuth2 JWT. Create tokens at https://cnap.tech/account/tokens

Path Parameters

string

required

Cluster ID

Body

application/json

name

string

Required string length: 1 - 100

Example:

"staging"

region_id

string

Region ID

Response

Updated cluster

string

required

Example:

"j572abc123def456"

name

string

required

Example:

"production"

workspace_id

string

required

Example:

"j572abc123def456"

region_id

string

required

Example:

"j572abc123def456"

kaas

object | null

required

Present if cluster is KaaS-managed

Show child attributes

created_at

number

required

Unix timestamp (seconds)

Overview

Endpoints

Update cluster

Authorizations

Path Parameters

Body

Response