Skip to main content
PATCH
/
cloud
/
v2
/
lblisteners
/
{project_id}
/
{region_id}
/
{listener_id}
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
task_id_list = client.cloud.load_balancers.listeners.update(
    listener_id="00000000-0000-4000-8000-000000000000",
    project_id=1,
    region_id=1,
)
print(task_id_list.tasks)
{
  "tasks": [
    "<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
​
admin_state_up
boolean

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

Network CIDRs from which service will be accessible

Maximum array length: 100
Example:
["10.0.0.0/8"]
​
connection_limit
integer

Limit of simultaneous connections. If -1 is provided, it is translated to the default value 100000.

Required range: -1 <= x <= 1000000
Example:

100000

​
name
string

Load balancer listener name

Example:

"new_listener_name"

​
secret_id
string<uuid4> | null

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

Example:

"af4a64e7-03ca-470f-9a09-b77d54c5abd8"

​
sni_secret_id
string<uuid4>[] | null

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

Example:
[
  "af4a64e7-03ca-470f-9a09-b77d54c5abd8",
  "12b43d95-d420-4c79-a883-49bf146cbdff"
]
​
timeout_client_data
integer | null

Frontend client inactivity timeout in milliseconds

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

50000

​
timeout_member_connect
integer | null
deprecated

Backend member connection timeout in milliseconds. We are recommending to use pool.timeout_member_connect instead.

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

50000

​
timeout_member_data
integer | null
deprecated

Backend member inactivity timeout in milliseconds. We are recommending to use pool.timeout_member_data instead.

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

null

​
user_list
UserListItem · object[] | null

Load balancer listener users list

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

Response

200 - application/json

OK

​
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"]