ByCloud Docs
GuidesCLIAPISDK
post/v1/load-balancers/{load_balancer_id}/pools

Create pool

Create a new pool

Path Parameters

load_balancer_id

string<uuid>required

path

Load Balancer ID

Example: "550e8400-e29b-41d4-a716-446655440000"

Header Parameters

X-Region

stringrequired

header

Region code to query resources from. Required for all resource operations.

Example: "sao1"

Request Body

required

Content-Type: application/json

name

stringoptional

description

stringoptional

load_balancer_id

string<uuid>optional

listener_id

string<uuid>optional

Listener to attach (optional)

protocol

stringrequired

Enum: "HTTP", "HTTPS", "PROXY", "PROXYV2", "TCP", "UDP", "SCTP"

lb_algorithm

stringrequired

Enum: "ROUND_ROBIN", "LEAST_CONNECTIONS", "SOURCE_IP", "SOURCE_IP_PORT"

session_persistence

objectoptional

tags

arrayoptional

Responses

201

Pool created

Content-Type: application/json

pool

objectoptional
400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
404

Load balancer or listener not found

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X POST "https://api.spo1.mycloud.com/v1/load-balancers/550e8400-e29b-41d4-a716-446655440000/pools" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "load_balancer_id": "550e8400-e29b-41d4-a716-446655440000",
    "listener_id": "550e8400-e29b-41d4-a716-446655440000",
    "protocol": "HTTP",
    "lb_algorithm": "ROUND_ROBIN",
    "session_persistence": {
      "type": "HTTP_COOKIE",
      "cookie_name": "string",
      "persistence_timeout": 1,
      "persistence_granularity": "string"
    },
    "tags": [
      "web",
      "frontend"
    ]
  }'

Response

Pool created

{
  "pool": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "crn": "crn:spo1:loadbalancer:pool:550e8400-e29b-41d4-a716-446655440000",
    "name": "web-pool",
    "description": "string",
    "provisioning_status": "ACTIVE",
    "operating_status": "ONLINE",
    "protocol": "HTTP",
    "lb_algorithm": "ROUND_ROBIN",
    "session_persistence": {
      "type": "HTTP_COOKIE",
      "cookie_name": "string",
      "persistence_timeout": 0,
      "persistence_granularity": "string"
    },
    "listeners": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "members": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "healthmonitor_id": "550e8400-e29b-41d4-a716-446655440000",
    "load_balancer_id": "550e8400-e29b-41d4-a716-446655440000",
    "tags": [
      "web",
      "frontend"
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}