Skip to main content
PATCH
/
cloud
/
v1
/
lblisteners
/
{project_id}
/
{region_id}
/
{listener_id}
Update load balancer listener
curl --request PATCH \
  --url https://api.gcore.com/cloud/v1/lblisteners/{project_id}/{region_id}/{listener_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "admin_state_up": true,
  "allowed_cidrs": [
    "10.0.0.0/8"
  ],
  "connection_limit": 499999,
  "creator_task_id": "de105b9c-c095-4f1c-9b76-aaa9bc60e32a",
  "id": "<string>",
  "insert_headers": {},
  "load_balancer_id": "67149a91-739b-42bf-bbd1-cb64f723dad7",
  "name": "<string>",
  "operating_status": "DEGRADED",
  "pool_count": 1,
  "protocol": "HTTP",
  "protocol_port": 32768,
  "provisioning_status": "ACTIVE",
  "secret_id": "e36200c7-114b-44e6-ba1a-043b2bd53879",
  "sni_secret_id": [
    "e36200c7-114b-44e6-ba1a-043b2bd53879",
    "c5d156ce-0925-4aef-b458-cce46bd346f0"
  ],
  "stats": {
    "active_connections": 0,
    "bytes_in": 34942398609,
    "bytes_out": 304777113641,
    "request_errors": 4,
    "total_connections": 21095970
  },
  "task_id": "<string>",
  "timeout_client_data": 50000,
  "timeout_member_connect": 5000,
  "timeout_member_data": 50000,
  "user_list": [
    {
      "encrypted_password": "<string>",
      "username": "<string>"
    }
  ]
}

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

​
listener_id
string<uuid4>
required

Listener ID

Example:

"00000000-0000-4000-8000-000000000000"

Body

application/json
​
name
string
required

Name.

Example:

"some_name"

Response

200 - application/json

OK

​
admin_state_up
boolean
required

Administrative state of the resource. When set to true, the resource is enabled and operational. When set to false, the resource is disabled and will not process traffic. Defaults to true.

Examples:

true

false

​
allowed_cidrs
string<ipvanynetwork>[] | null
required

Network CIDRs from which service will be accessible

Example:
["10.0.0.0/8"]
​
connection_limit
integer
required

Limit of simultaneous connections

Required range: -1 <= x <= 1000000
​
creator_task_id
string<uuid4> | null
required

Task that created this entity

Example:

"de105b9c-c095-4f1c-9b76-aaa9bc60e32a"

​
id
string<uuid4>
required

Load balancer listener ID

Example:

"43658ea9-54bd-4807-90b1-925921c9a0d1"

​
insert_headers
Insert Headers · object
required

Dictionary of additional header insertion into HTTP headers. Only used with HTTP and TERMINATED_HTTPS protocols.

​
load_balancer_id
string<uuid4> | null
required

Load balancer ID

Example:

"67149a91-739b-42bf-bbd1-cb64f723dad7"

​
name
string
required

Load balancer listener name

Example:

"lbaas_test_listener"

​
operating_status
enum<string>
required

Listener operating status

Available options:
DEGRADED,
DRAINING,
ERROR,
NO_MONITOR,
OFFLINE,
ONLINE
​
pool_count
integer | null
required

Number of pools (for UI)

Example:

1

​
protocol
enum<string>
required

Load balancer protocol

Available options:
HTTP,
HTTPS,
PROMETHEUS,
TCP,
TERMINATED_HTTPS,
UDP
Example:

"TCP"

​
protocol_port
integer
required

Protocol port

Required range: 1 <= x <= 65535
Example:

80

​
provisioning_status
enum<string>
required

Listener lifecycle status

Available options:
ACTIVE,
DELETED,
ERROR,
PENDING_CREATE,
PENDING_DELETE,
PENDING_UPDATE
​
secret_id
string | null
required

ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS load balancer

Example:

"e36200c7-114b-44e6-ba1a-043b2bd53879"

​
sni_secret_id
string[] | null
required

List of secret's ID containing PKCS12 format certificate/key bundles for TERMINATED_HTTPS or PROMETHEUS listeners

Example:
[
  "e36200c7-114b-44e6-ba1a-043b2bd53879",
  "c5d156ce-0925-4aef-b458-cce46bd346f0"
]
​
stats
LoadbalancerStatsSerializer · object
required

Statistics of the load balancer. It is available only in get functions by a flag.

Example:
{
  "active_connections": 0,
  "bytes_in": 34942398609,
  "bytes_out": 304777113641,
  "request_errors": 4,
  "total_connections": 21095970
}
​
task_id
string<uuid4> | null
required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

​
timeout_client_data
integer | null
required

Frontend client inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000
Example:

50000

​
timeout_member_connect
integer | null
required
deprecated

Backend member connection timeout in milliseconds

Required range: 0 <= x <= 86400000
Example:

5000

​
timeout_member_data
integer | null
required
deprecated

Backend member inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000
Example:

50000

​
user_list
UserListItem · object[]
required

Load balancer listener users list

Example:
[
  {
    "encrypted_password": "$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5",
    "username": "admin"
  }
]