Update cluster compute settings

curl --request PATCH \
  --url https://api.akua.dev/v1/clusters/{id}/compute_settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'if-match: <if-match>' \
  --data '
{
  "auto_scaling_enabled": true,
  "max_machines": 50
}
'

import requests

url = "https://api.akua.dev/v1/clusters/{id}/compute_settings"

payload = {
    "auto_scaling_enabled": True,
    "max_machines": 50
}
headers = {
    "if-match": "<if-match>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'if-match': '<if-match>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({auto_scaling_enabled: true, max_machines: 50})
};

fetch('https://api.akua.dev/v1/clusters/{id}/compute_settings', 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.akua.dev/v1/clusters/{id}/compute_settings",
  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([
    'auto_scaling_enabled' => true,
    'max_machines' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "if-match: <if-match>"
  ],
]);

$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.akua.dev/v1/clusters/{id}/compute_settings"

	payload := strings.NewReader("{\n  \"auto_scaling_enabled\": true,\n  \"max_machines\": 50\n}")

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

	req.Header.Add("if-match", "<if-match>")
	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.akua.dev/v1/clusters/{id}/compute_settings")
  .header("if-match", "<if-match>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auto_scaling_enabled\": true,\n  \"max_machines\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.akua.dev/v1/clusters/{id}/compute_settings")

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

request = Net::HTTP::Patch.new(url)
request["if-match"] = '<if-match>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"auto_scaling_enabled\": true,\n  \"max_machines\": 50\n}"

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

{
  "auto_scaling": "active",
  "machines": 1,
  "max_machines": 1,
  "updated_at": 123,
  "etag": "<string>"
}

{
  "_tag": "Validation",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unauthorized",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Forbidden",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "ClusterNotFoundError"
}

{
  "_tag": "ComputeSettingsConflictError",
  "message": "<string>",
  "currentEtag": "<string>"
}

{
  "_tag": "ComputeSettingsQueryError",
  "cause": "<unknown>"
}

PATCH

clusters

{id}

compute_settings

Update cluster compute settings

curl --request PATCH \
  --url https://api.akua.dev/v1/clusters/{id}/compute_settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'if-match: <if-match>' \
  --data '
{
  "auto_scaling_enabled": true,
  "max_machines": 50
}
'

import requests

url = "https://api.akua.dev/v1/clusters/{id}/compute_settings"

payload = {
    "auto_scaling_enabled": True,
    "max_machines": 50
}
headers = {
    "if-match": "<if-match>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'if-match': '<if-match>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({auto_scaling_enabled: true, max_machines: 50})
};

fetch('https://api.akua.dev/v1/clusters/{id}/compute_settings', 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.akua.dev/v1/clusters/{id}/compute_settings",
  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([
    'auto_scaling_enabled' => true,
    'max_machines' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "if-match: <if-match>"
  ],
]);

$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.akua.dev/v1/clusters/{id}/compute_settings"

	payload := strings.NewReader("{\n  \"auto_scaling_enabled\": true,\n  \"max_machines\": 50\n}")

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

	req.Header.Add("if-match", "<if-match>")
	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.akua.dev/v1/clusters/{id}/compute_settings")
  .header("if-match", "<if-match>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auto_scaling_enabled\": true,\n  \"max_machines\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.akua.dev/v1/clusters/{id}/compute_settings")

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

request = Net::HTTP::Patch.new(url)
request["if-match"] = '<if-match>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"auto_scaling_enabled\": true,\n  \"max_machines\": 50\n}"

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

{
  "auto_scaling": "active",
  "machines": 1,
  "max_machines": 1,
  "updated_at": 123,
  "etag": "<string>"
}

{
  "_tag": "Validation",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unauthorized",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Forbidden",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "ClusterNotFoundError"
}

{
  "_tag": "ComputeSettingsConflictError",
  "message": "<string>",
  "currentEtag": "<string>"
}

{
  "_tag": "ComputeSettingsQueryError",
  "cause": "<unknown>"
}

Authorizations

Authorization

string

header

required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

if-match

string

required

akua-context

string

Path Parameters

string

required

Body

application/json

Option 1
Option 2

auto_scaling_enabled

boolean

required

max_machines

integer | null

Required range: 0 <= x <= 100

Response

ClusterComputeSettings

auto_scaling

enum<string>

required

Available options:

active,

paused

machines

integer

required

Required range: x >= 0

max_machines

integer

required

Required range: x >= 0

updated_at

integer

required

etag

string

required

⌘I

Overview

Endpoints

Update cluster compute settings

Authorizations

Headers

Path Parameters

Body

Response