Create load balancer pool

curl --request POST \
  --url https://api.gcore.com/cloud/v1/lbpools/{project_id}/{region_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "pool_name",
  "ca_secret_id": "<string>",
  "crl_secret_id": "<string>",
  "healthmonitor": {
    "delay": 10,
    "domain_name": "example.com",
    "http_method": "GET",
    "http_version": "1.1",
    "max_retries": 3,
    "max_retries_down": 3,
    "timeout": 5,
    "type": "HTTP",
    "url_path": "/"
  },
  "listener_id": "<string>",
  "load_balancer_id": "bbb35f84-35cc-4b2f-84c2-a6a29bba68aa",
  "members": [
    {
      "address": "192.168.1.101",
      "instance_id": "a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9",
      "protocol_port": 8000,
      "weight": 2
    },
    {
      "address": "192.168.1.102",
      "instance_id": "169942e0-9b53-42df-95ef-1a8b6525c2bd",
      "protocol_port": 8000,
      "weight": 4
    }
  ],
  "secret_id": "<string>",
  "session_persistence": {
    "cookie_name": "cookie_name",
    "type": "APP_COOKIE"
  },
  "timeout_client_data": 50000,
  "timeout_member_connect": 50000,
  "timeout_member_data": 43200000
}
'

import requests

url = "https://api.gcore.com/cloud/v1/lbpools/{project_id}/{region_id}"

payload = {
    "name": "pool_name",
    "ca_secret_id": "<string>",
    "crl_secret_id": "<string>",
    "healthmonitor": {
        "delay": 10,
        "domain_name": "example.com",
        "http_method": "GET",
        "http_version": "1.1",
        "max_retries": 3,
        "max_retries_down": 3,
        "timeout": 5,
        "type": "HTTP",
        "url_path": "/"
    },
    "listener_id": "<string>",
    "load_balancer_id": "bbb35f84-35cc-4b2f-84c2-a6a29bba68aa",
    "members": [
        {
            "address": "192.168.1.101",
            "instance_id": "a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9",
            "protocol_port": 8000,
            "weight": 2
        },
        {
            "address": "192.168.1.102",
            "instance_id": "169942e0-9b53-42df-95ef-1a8b6525c2bd",
            "protocol_port": 8000,
            "weight": 4
        }
    ],
    "secret_id": "<string>",
    "session_persistence": {
        "cookie_name": "cookie_name",
        "type": "APP_COOKIE"
    },
    "timeout_client_data": 50000,
    "timeout_member_connect": 50000,
    "timeout_member_data": 43200000
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'pool_name',
    ca_secret_id: '<string>',
    crl_secret_id: '<string>',
    healthmonitor: {
      delay: 10,
      domain_name: 'example.com',
      http_method: 'GET',
      http_version: '1.1',
      max_retries: 3,
      max_retries_down: 3,
      timeout: 5,
      type: 'HTTP',
      url_path: '/'
    },
    listener_id: '<string>',
    load_balancer_id: 'bbb35f84-35cc-4b2f-84c2-a6a29bba68aa',
    members: [
      {
        address: '192.168.1.101',
        instance_id: 'a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9',
        protocol_port: 8000,
        weight: 2
      },
      {
        address: '192.168.1.102',
        instance_id: '169942e0-9b53-42df-95ef-1a8b6525c2bd',
        protocol_port: 8000,
        weight: 4
      }
    ],
    secret_id: '<string>',
    session_persistence: {cookie_name: 'cookie_name', type: 'APP_COOKIE'},
    timeout_client_data: 50000,
    timeout_member_connect: 50000,
    timeout_member_data: 43200000
  })
};

fetch('https://api.gcore.com/cloud/v1/lbpools/{project_id}/{region_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.gcore.com/cloud/v1/lbpools/{project_id}/{region_id}",
  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([
    'name' => 'pool_name',
    'ca_secret_id' => '<string>',
    'crl_secret_id' => '<string>',
    'healthmonitor' => [
        'delay' => 10,
        'domain_name' => 'example.com',
        'http_method' => 'GET',
        'http_version' => '1.1',
        'max_retries' => 3,
        'max_retries_down' => 3,
        'timeout' => 5,
        'type' => 'HTTP',
        'url_path' => '/'
    ],
    'listener_id' => '<string>',
    'load_balancer_id' => 'bbb35f84-35cc-4b2f-84c2-a6a29bba68aa',
    'members' => [
        [
                'address' => '192.168.1.101',
                'instance_id' => 'a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9',
                'protocol_port' => 8000,
                'weight' => 2
        ],
        [
                'address' => '192.168.1.102',
                'instance_id' => '169942e0-9b53-42df-95ef-1a8b6525c2bd',
                'protocol_port' => 8000,
                'weight' => 4
        ]
    ],
    'secret_id' => '<string>',
    'session_persistence' => [
        'cookie_name' => 'cookie_name',
        'type' => 'APP_COOKIE'
    ],
    'timeout_client_data' => 50000,
    'timeout_member_connect' => 50000,
    'timeout_member_data' => 43200000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.gcore.com/cloud/v1/lbpools/{project_id}/{region_id}"

	payload := strings.NewReader("{\n  \"name\": \"pool_name\",\n  \"ca_secret_id\": \"<string>\",\n  \"crl_secret_id\": \"<string>\",\n  \"healthmonitor\": {\n    \"delay\": 10,\n    \"domain_name\": \"example.com\",\n    \"http_method\": \"GET\",\n    \"http_version\": \"1.1\",\n    \"max_retries\": 3,\n    \"max_retries_down\": 3,\n    \"timeout\": 5,\n    \"type\": \"HTTP\",\n    \"url_path\": \"/\"\n  },\n  \"listener_id\": \"<string>\",\n  \"load_balancer_id\": \"bbb35f84-35cc-4b2f-84c2-a6a29bba68aa\",\n  \"members\": [\n    {\n      \"address\": \"192.168.1.101\",\n      \"instance_id\": \"a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9\",\n      \"protocol_port\": 8000,\n      \"weight\": 2\n    },\n    {\n      \"address\": \"192.168.1.102\",\n      \"instance_id\": \"169942e0-9b53-42df-95ef-1a8b6525c2bd\",\n      \"protocol_port\": 8000,\n      \"weight\": 4\n    }\n  ],\n  \"secret_id\": \"<string>\",\n  \"session_persistence\": {\n    \"cookie_name\": \"cookie_name\",\n    \"type\": \"APP_COOKIE\"\n  },\n  \"timeout_client_data\": 50000,\n  \"timeout_member_connect\": 50000,\n  \"timeout_member_data\": 43200000\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.gcore.com/cloud/v1/lbpools/{project_id}/{region_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"pool_name\",\n  \"ca_secret_id\": \"<string>\",\n  \"crl_secret_id\": \"<string>\",\n  \"healthmonitor\": {\n    \"delay\": 10,\n    \"domain_name\": \"example.com\",\n    \"http_method\": \"GET\",\n    \"http_version\": \"1.1\",\n    \"max_retries\": 3,\n    \"max_retries_down\": 3,\n    \"timeout\": 5,\n    \"type\": \"HTTP\",\n    \"url_path\": \"/\"\n  },\n  \"listener_id\": \"<string>\",\n  \"load_balancer_id\": \"bbb35f84-35cc-4b2f-84c2-a6a29bba68aa\",\n  \"members\": [\n    {\n      \"address\": \"192.168.1.101\",\n      \"instance_id\": \"a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9\",\n      \"protocol_port\": 8000,\n      \"weight\": 2\n    },\n    {\n      \"address\": \"192.168.1.102\",\n      \"instance_id\": \"169942e0-9b53-42df-95ef-1a8b6525c2bd\",\n      \"protocol_port\": 8000,\n      \"weight\": 4\n    }\n  ],\n  \"secret_id\": \"<string>\",\n  \"session_persistence\": {\n    \"cookie_name\": \"cookie_name\",\n    \"type\": \"APP_COOKIE\"\n  },\n  \"timeout_client_data\": 50000,\n  \"timeout_member_connect\": 50000,\n  \"timeout_member_data\": 43200000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/lbpools/{project_id}/{region_id}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"pool_name\",\n  \"ca_secret_id\": \"<string>\",\n  \"crl_secret_id\": \"<string>\",\n  \"healthmonitor\": {\n    \"delay\": 10,\n    \"domain_name\": \"example.com\",\n    \"http_method\": \"GET\",\n    \"http_version\": \"1.1\",\n    \"max_retries\": 3,\n    \"max_retries_down\": 3,\n    \"timeout\": 5,\n    \"type\": \"HTTP\",\n    \"url_path\": \"/\"\n  },\n  \"listener_id\": \"<string>\",\n  \"load_balancer_id\": \"bbb35f84-35cc-4b2f-84c2-a6a29bba68aa\",\n  \"members\": [\n    {\n      \"address\": \"192.168.1.101\",\n      \"instance_id\": \"a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9\",\n      \"protocol_port\": 8000,\n      \"weight\": 2\n    },\n    {\n      \"address\": \"192.168.1.102\",\n      \"instance_id\": \"169942e0-9b53-42df-95ef-1a8b6525c2bd\",\n      \"protocol_port\": 8000,\n      \"weight\": 4\n    }\n  ],\n  \"secret_id\": \"<string>\",\n  \"session_persistence\": {\n    \"cookie_name\": \"cookie_name\",\n    \"type\": \"APP_COOKIE\"\n  },\n  \"timeout_client_data\": 50000,\n  \"timeout_member_connect\": 50000,\n  \"timeout_member_data\": 43200000\n}"

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

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}

POST

cloud

lbpools

{project_id}

{region_id}

Create load balancer pool

curl --request POST \
  --url https://api.gcore.com/cloud/v1/lbpools/{project_id}/{region_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "pool_name",
  "ca_secret_id": "<string>",
  "crl_secret_id": "<string>",
  "healthmonitor": {
    "delay": 10,
    "domain_name": "example.com",
    "http_method": "GET",
    "http_version": "1.1",
    "max_retries": 3,
    "max_retries_down": 3,
    "timeout": 5,
    "type": "HTTP",
    "url_path": "/"
  },
  "listener_id": "<string>",
  "load_balancer_id": "bbb35f84-35cc-4b2f-84c2-a6a29bba68aa",
  "members": [
    {
      "address": "192.168.1.101",
      "instance_id": "a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9",
      "protocol_port": 8000,
      "weight": 2
    },
    {
      "address": "192.168.1.102",
      "instance_id": "169942e0-9b53-42df-95ef-1a8b6525c2bd",
      "protocol_port": 8000,
      "weight": 4
    }
  ],
  "secret_id": "<string>",
  "session_persistence": {
    "cookie_name": "cookie_name",
    "type": "APP_COOKIE"
  },
  "timeout_client_data": 50000,
  "timeout_member_connect": 50000,
  "timeout_member_data": 43200000
}
'

import requests

url = "https://api.gcore.com/cloud/v1/lbpools/{project_id}/{region_id}"

payload = {
    "name": "pool_name",
    "ca_secret_id": "<string>",
    "crl_secret_id": "<string>",
    "healthmonitor": {
        "delay": 10,
        "domain_name": "example.com",
        "http_method": "GET",
        "http_version": "1.1",
        "max_retries": 3,
        "max_retries_down": 3,
        "timeout": 5,
        "type": "HTTP",
        "url_path": "/"
    },
    "listener_id": "<string>",
    "load_balancer_id": "bbb35f84-35cc-4b2f-84c2-a6a29bba68aa",
    "members": [
        {
            "address": "192.168.1.101",
            "instance_id": "a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9",
            "protocol_port": 8000,
            "weight": 2
        },
        {
            "address": "192.168.1.102",
            "instance_id": "169942e0-9b53-42df-95ef-1a8b6525c2bd",
            "protocol_port": 8000,
            "weight": 4
        }
    ],
    "secret_id": "<string>",
    "session_persistence": {
        "cookie_name": "cookie_name",
        "type": "APP_COOKIE"
    },
    "timeout_client_data": 50000,
    "timeout_member_connect": 50000,
    "timeout_member_data": 43200000
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'pool_name',
    ca_secret_id: '<string>',
    crl_secret_id: '<string>',
    healthmonitor: {
      delay: 10,
      domain_name: 'example.com',
      http_method: 'GET',
      http_version: '1.1',
      max_retries: 3,
      max_retries_down: 3,
      timeout: 5,
      type: 'HTTP',
      url_path: '/'
    },
    listener_id: '<string>',
    load_balancer_id: 'bbb35f84-35cc-4b2f-84c2-a6a29bba68aa',
    members: [
      {
        address: '192.168.1.101',
        instance_id: 'a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9',
        protocol_port: 8000,
        weight: 2
      },
      {
        address: '192.168.1.102',
        instance_id: '169942e0-9b53-42df-95ef-1a8b6525c2bd',
        protocol_port: 8000,
        weight: 4
      }
    ],
    secret_id: '<string>',
    session_persistence: {cookie_name: 'cookie_name', type: 'APP_COOKIE'},
    timeout_client_data: 50000,
    timeout_member_connect: 50000,
    timeout_member_data: 43200000
  })
};

fetch('https://api.gcore.com/cloud/v1/lbpools/{project_id}/{region_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.gcore.com/cloud/v1/lbpools/{project_id}/{region_id}",
  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([
    'name' => 'pool_name',
    'ca_secret_id' => '<string>',
    'crl_secret_id' => '<string>',
    'healthmonitor' => [
        'delay' => 10,
        'domain_name' => 'example.com',
        'http_method' => 'GET',
        'http_version' => '1.1',
        'max_retries' => 3,
        'max_retries_down' => 3,
        'timeout' => 5,
        'type' => 'HTTP',
        'url_path' => '/'
    ],
    'listener_id' => '<string>',
    'load_balancer_id' => 'bbb35f84-35cc-4b2f-84c2-a6a29bba68aa',
    'members' => [
        [
                'address' => '192.168.1.101',
                'instance_id' => 'a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9',
                'protocol_port' => 8000,
                'weight' => 2
        ],
        [
                'address' => '192.168.1.102',
                'instance_id' => '169942e0-9b53-42df-95ef-1a8b6525c2bd',
                'protocol_port' => 8000,
                'weight' => 4
        ]
    ],
    'secret_id' => '<string>',
    'session_persistence' => [
        'cookie_name' => 'cookie_name',
        'type' => 'APP_COOKIE'
    ],
    'timeout_client_data' => 50000,
    'timeout_member_connect' => 50000,
    'timeout_member_data' => 43200000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.gcore.com/cloud/v1/lbpools/{project_id}/{region_id}"

	payload := strings.NewReader("{\n  \"name\": \"pool_name\",\n  \"ca_secret_id\": \"<string>\",\n  \"crl_secret_id\": \"<string>\",\n  \"healthmonitor\": {\n    \"delay\": 10,\n    \"domain_name\": \"example.com\",\n    \"http_method\": \"GET\",\n    \"http_version\": \"1.1\",\n    \"max_retries\": 3,\n    \"max_retries_down\": 3,\n    \"timeout\": 5,\n    \"type\": \"HTTP\",\n    \"url_path\": \"/\"\n  },\n  \"listener_id\": \"<string>\",\n  \"load_balancer_id\": \"bbb35f84-35cc-4b2f-84c2-a6a29bba68aa\",\n  \"members\": [\n    {\n      \"address\": \"192.168.1.101\",\n      \"instance_id\": \"a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9\",\n      \"protocol_port\": 8000,\n      \"weight\": 2\n    },\n    {\n      \"address\": \"192.168.1.102\",\n      \"instance_id\": \"169942e0-9b53-42df-95ef-1a8b6525c2bd\",\n      \"protocol_port\": 8000,\n      \"weight\": 4\n    }\n  ],\n  \"secret_id\": \"<string>\",\n  \"session_persistence\": {\n    \"cookie_name\": \"cookie_name\",\n    \"type\": \"APP_COOKIE\"\n  },\n  \"timeout_client_data\": 50000,\n  \"timeout_member_connect\": 50000,\n  \"timeout_member_data\": 43200000\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.gcore.com/cloud/v1/lbpools/{project_id}/{region_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"pool_name\",\n  \"ca_secret_id\": \"<string>\",\n  \"crl_secret_id\": \"<string>\",\n  \"healthmonitor\": {\n    \"delay\": 10,\n    \"domain_name\": \"example.com\",\n    \"http_method\": \"GET\",\n    \"http_version\": \"1.1\",\n    \"max_retries\": 3,\n    \"max_retries_down\": 3,\n    \"timeout\": 5,\n    \"type\": \"HTTP\",\n    \"url_path\": \"/\"\n  },\n  \"listener_id\": \"<string>\",\n  \"load_balancer_id\": \"bbb35f84-35cc-4b2f-84c2-a6a29bba68aa\",\n  \"members\": [\n    {\n      \"address\": \"192.168.1.101\",\n      \"instance_id\": \"a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9\",\n      \"protocol_port\": 8000,\n      \"weight\": 2\n    },\n    {\n      \"address\": \"192.168.1.102\",\n      \"instance_id\": \"169942e0-9b53-42df-95ef-1a8b6525c2bd\",\n      \"protocol_port\": 8000,\n      \"weight\": 4\n    }\n  ],\n  \"secret_id\": \"<string>\",\n  \"session_persistence\": {\n    \"cookie_name\": \"cookie_name\",\n    \"type\": \"APP_COOKIE\"\n  },\n  \"timeout_client_data\": 50000,\n  \"timeout_member_connect\": 50000,\n  \"timeout_member_data\": 43200000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/lbpools/{project_id}/{region_id}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"pool_name\",\n  \"ca_secret_id\": \"<string>\",\n  \"crl_secret_id\": \"<string>\",\n  \"healthmonitor\": {\n    \"delay\": 10,\n    \"domain_name\": \"example.com\",\n    \"http_method\": \"GET\",\n    \"http_version\": \"1.1\",\n    \"max_retries\": 3,\n    \"max_retries_down\": 3,\n    \"timeout\": 5,\n    \"type\": \"HTTP\",\n    \"url_path\": \"/\"\n  },\n  \"listener_id\": \"<string>\",\n  \"load_balancer_id\": \"bbb35f84-35cc-4b2f-84c2-a6a29bba68aa\",\n  \"members\": [\n    {\n      \"address\": \"192.168.1.101\",\n      \"instance_id\": \"a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9\",\n      \"protocol_port\": 8000,\n      \"weight\": 2\n    },\n    {\n      \"address\": \"192.168.1.102\",\n      \"instance_id\": \"169942e0-9b53-42df-95ef-1a8b6525c2bd\",\n      \"protocol_port\": 8000,\n      \"weight\": 4\n    }\n  ],\n  \"secret_id\": \"<string>\",\n  \"session_persistence\": {\n    \"cookie_name\": \"cookie_name\",\n    \"type\": \"APP_COOKIE\"\n  },\n  \"timeout_client_data\": 50000,\n  \"timeout_member_connect\": 50000,\n  \"timeout_member_data\": 43200000\n}"

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

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}

Authorizations

Authorization

string

header

required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id

integer

required

Project ID

Example:

1

region_id

integer

required

Region ID

Example:

1

Body

application/json

lb_algorithm

enum<string>

required

Load balancer algorithm

Available options:

LEAST_CONNECTIONS,

ROUND_ROBIN,

SOURCE_IP

Example:

"ROUND_ROBIN"

name

string

required

Pool name

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$

Example:

"pool_name"

protocol

enum<string>

required

Protocol

Available options:

HTTP,

HTTPS,

PROXY,

PROXYV2,

TCP,

UDP

Example:

"HTTP"

ca_secret_id

string<uuid4> | null

Secret ID of CA certificate bundle

crl_secret_id

string<uuid4> | null

Secret ID of CA revocation list file

healthmonitor

CreateLbHealthMonitorSerializer · object | null

Health monitor details

Show child attributes

Example:

{
  "delay": 10,
  "domain_name": "example.com",
  "http_method": "GET",
  "http_version": "1.1",
  "max_retries": 3,
  "max_retries_down": 3,
  "timeout": 5,
  "type": "HTTP",
  "url_path": "/"
}

listener_id

string<uuid4> | null

Listener ID

load_balancer_id

string<uuid4> | null

Loadbalancer ID

Example:

"bbb35f84-35cc-4b2f-84c2-a6a29bba68aa"

members

CreateLbPoolMemberSerializer · object[]

Pool members

Show child attributes

Example:

[
  {
    "address": "192.168.1.101",
    "instance_id": "a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9",
    "protocol_port": 8000,
    "weight": 2
  },
  {
    "address": "192.168.1.102",
    "instance_id": "169942e0-9b53-42df-95ef-1a8b6525c2bd",
    "protocol_port": 8000,
    "weight": 4
  }
]

secret_id

string<uuid4> | null

Secret ID for TLS client authentication to the member servers

session_persistence

MutateLbSessionPersistence · object | null

Session persistence details

Show child attributes

Example:

{
  "cookie_name": "cookie_name",
  "type": "APP_COOKIE"
}

timeout_client_data

integer | null

deprecated

Frontend client inactivity timeout in milliseconds. We are recommending to use listener.timeout_client_data instead.

Required range: 0 <= x <= 86400000

Example:

50000

timeout_member_connect

integer | null

Backend member connection timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

50000

timeout_member_data

integer | null

Backend member inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000

Response

200 - application/json

tasks

string[]

required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.

Example:

["d478ae29-dedc-4869-82f0-96104425f565"]

List load balancer pools Update load balancer pool

⌘I