ByCloud Docs
GuidesCLIAPISDK
patch/v1/listeners/{listener_id}

Update listener

Update a listener

Path Parameters

listener_id

string<uuid>required

path

Listener ID

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

Request Body

required

Content-Type: application/json

name

stringoptional

description

stringoptional

connection_limit

integeroptional

default_pool_id

string<uuid>optional

nullable

default_tls_container_ref

stringoptional

nullable

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

200

Listener updated

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

Resource not found

Content-Type: application/json

error

objectrequired
409

Listener is not in updatable state

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X PATCH "https://api.spo1.mycloud.com/v1/listeners/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "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"
    ]
  }'

Response

Listener updated

{
  "listener": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "crn": "crn:spo1:loadbalancer:listener:550e8400-e29b-41d4-a716-446655440000",
    "name": "http-listener",
    "description": "string",
    "provisioning_status": "ACTIVE",
    "operating_status": "ONLINE",
    "protocol": "HTTP",
    "protocol_port": 80,
    "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": 0,
    "timeout_member_connect": 0,
    "timeout_member_data": 0,
    "timeout_tcp_inspect": 0,
    "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"
  }
}