ByCloud Docs
GuidesCLIAPISDK
post/v1/listeners

Create listener

Create a new listener on a load balancer

Request Body

required

Content-Type: application/json

name

stringoptional

description

stringoptional

admin_state_up

booleanoptional

Default: true

load_balancer_id

string<uuid>required

protocol

stringrequired

Enum: "HTTP", "HTTPS", "TCP", "TERMINATED_HTTPS", "UDP", "SCTP"

protocol_port

integerrequired

connection_limit

integeroptional

Default: -1

default_pool_id

string<uuid>optional

default_tls_container_ref

stringoptional

sni_container_refs

arrayoptional

insert_headers

objectoptional

timeout_client_data

integeroptional

timeout_member_connect

integeroptional

timeout_member_data

integeroptional

timeout_tcp_inspect

integeroptional

tags

arrayoptional

Responses

201

Listener created

Content-Type: application/json

listener

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 not found

Content-Type: application/json

error

objectrequired
409

Port already in use on this load balancer

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/listeners" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "admin_state_up": true,
    "load_balancer_id": "550e8400-e29b-41d4-a716-446655440000",
    "protocol": "HTTP",
    "protocol_port": 1,
    "connection_limit": -1,
    "default_pool_id": "550e8400-e29b-41d4-a716-446655440000",
    "default_tls_container_ref": "string",
    "sni_container_refs": [
      "string"
    ],
    "insert_headers": {},
    "timeout_client_data": 1,
    "timeout_member_connect": 1,
    "timeout_member_data": 1,
    "timeout_tcp_inspect": 1,
    "tags": [
      "web",
      "frontend"
    ]
  }'