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.create(
project_id=1,
region_id=1,
load_balancer_id="30f4f55b-4a7c-48e0-9954-5cddfee216e7",
name="my_listener",
protocol="HTTP",
protocol_port=80,
)
print(task_id_list.tasks)package main
import (
"context"
"fmt"
"github.com/G-Core/gcore-go"
"github.com/G-Core/gcore-go/cloud"
"github.com/G-Core/gcore-go/option"
)
func main() {
client := gcore.NewClient(
option.WithAPIKey("My API Key"),
)
taskIDList, err := client.Cloud.LoadBalancers.Listeners.New(context.TODO(), cloud.LoadBalancerListenerNewParams{
ProjectID: gcore.Int(1),
RegionID: gcore.Int(1),
LoadBalancerID: "30f4f55b-4a7c-48e0-9954-5cddfee216e7",
Name: "my_listener",
Protocol: cloud.LbListenerProtocolHTTP,
ProtocolPort: 80,
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", taskIDList.Tasks)
}
curl --request POST \
--url https://api.gcore.com/cloud/v1/lblisteners/{project_id}/{region_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"load_balancer_id": "30f4f55b-4a7c-48e0-9954-5cddfee216e7",
"name": "my_listener",
"protocol": "HTTP",
"protocol_port": 80,
"allowed_cidrs": [
"10.0.0.0/8"
],
"connection_limit": 100000,
"default_pool_id": "00000000-0000-4000-8000-000000000000",
"insert_x_forwarded": false,
"secret_id": "f2e734d0-fa2b-42c2-ad33-4c6db5101e00",
"sni_secret_id": [
"f2e734d0-fa2b-42c2-ad33-4c6db5101e00",
"eb121225-7ded-4ff3-ae1f-599e145dd7cb"
],
"timeout_client_data": 50000,
"timeout_member_connect": 50000,
"timeout_member_data": null,
"user_list": [
{
"encrypted_password": "$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5",
"username": "admin"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
load_balancer_id: '30f4f55b-4a7c-48e0-9954-5cddfee216e7',
name: 'my_listener',
protocol: 'HTTP',
protocol_port: 80,
allowed_cidrs: ['10.0.0.0/8'],
connection_limit: 100000,
default_pool_id: '00000000-0000-4000-8000-000000000000',
insert_x_forwarded: false,
secret_id: 'f2e734d0-fa2b-42c2-ad33-4c6db5101e00',
sni_secret_id: ['f2e734d0-fa2b-42c2-ad33-4c6db5101e00', 'eb121225-7ded-4ff3-ae1f-599e145dd7cb'],
timeout_client_data: 50000,
timeout_member_connect: 50000,
timeout_member_data: null,
user_list: [
{
encrypted_password: '$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5',
username: 'admin'
}
]
})
};
fetch('https://api.gcore.com/cloud/v1/lblisteners/{project_id}/{region_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gcore.com/cloud/v1/lblisteners/{project_id}/{region_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'load_balancer_id' => '30f4f55b-4a7c-48e0-9954-5cddfee216e7',
'name' => 'my_listener',
'protocol' => 'HTTP',
'protocol_port' => 80,
'allowed_cidrs' => [
'10.0.0.0/8'
],
'connection_limit' => 100000,
'default_pool_id' => '00000000-0000-4000-8000-000000000000',
'insert_x_forwarded' => false,
'secret_id' => 'f2e734d0-fa2b-42c2-ad33-4c6db5101e00',
'sni_secret_id' => [
'f2e734d0-fa2b-42c2-ad33-4c6db5101e00',
'eb121225-7ded-4ff3-ae1f-599e145dd7cb'
],
'timeout_client_data' => 50000,
'timeout_member_connect' => 50000,
'timeout_member_data' => null,
'user_list' => [
[
'encrypted_password' => '$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5',
'username' => 'admin'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.gcore.com/cloud/v1/lblisteners/{project_id}/{region_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"load_balancer_id\": \"30f4f55b-4a7c-48e0-9954-5cddfee216e7\",\n \"name\": \"my_listener\",\n \"protocol\": \"HTTP\",\n \"protocol_port\": 80,\n \"allowed_cidrs\": [\n \"10.0.0.0/8\"\n ],\n \"connection_limit\": 100000,\n \"default_pool_id\": \"00000000-0000-4000-8000-000000000000\",\n \"insert_x_forwarded\": false,\n \"secret_id\": \"f2e734d0-fa2b-42c2-ad33-4c6db5101e00\",\n \"sni_secret_id\": [\n \"f2e734d0-fa2b-42c2-ad33-4c6db5101e00\",\n \"eb121225-7ded-4ff3-ae1f-599e145dd7cb\"\n ],\n \"timeout_client_data\": 50000,\n \"timeout_member_connect\": 50000,\n \"timeout_member_data\": null,\n \"user_list\": [\n {\n \"encrypted_password\": \"$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5\",\n \"username\": \"admin\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/cloud/v1/lblisteners/{project_id}/{region_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"load_balancer_id\": \"30f4f55b-4a7c-48e0-9954-5cddfee216e7\",\n \"name\": \"my_listener\",\n \"protocol\": \"HTTP\",\n \"protocol_port\": 80,\n \"allowed_cidrs\": [\n \"10.0.0.0/8\"\n ],\n \"connection_limit\": 100000,\n \"default_pool_id\": \"00000000-0000-4000-8000-000000000000\",\n \"insert_x_forwarded\": false,\n \"secret_id\": \"f2e734d0-fa2b-42c2-ad33-4c6db5101e00\",\n \"sni_secret_id\": [\n \"f2e734d0-fa2b-42c2-ad33-4c6db5101e00\",\n \"eb121225-7ded-4ff3-ae1f-599e145dd7cb\"\n ],\n \"timeout_client_data\": 50000,\n \"timeout_member_connect\": 50000,\n \"timeout_member_data\": null,\n \"user_list\": [\n {\n \"encrypted_password\": \"$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5\",\n \"username\": \"admin\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"tasks": [
"d478ae29-dedc-4869-82f0-96104425f565"
]
}Load Balancers
Create load balancer listener
POST
/
cloud
/
v1
/
lblisteners
/
{project_id}
/
{region_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.create(
project_id=1,
region_id=1,
load_balancer_id="30f4f55b-4a7c-48e0-9954-5cddfee216e7",
name="my_listener",
protocol="HTTP",
protocol_port=80,
)
print(task_id_list.tasks)package main
import (
"context"
"fmt"
"github.com/G-Core/gcore-go"
"github.com/G-Core/gcore-go/cloud"
"github.com/G-Core/gcore-go/option"
)
func main() {
client := gcore.NewClient(
option.WithAPIKey("My API Key"),
)
taskIDList, err := client.Cloud.LoadBalancers.Listeners.New(context.TODO(), cloud.LoadBalancerListenerNewParams{
ProjectID: gcore.Int(1),
RegionID: gcore.Int(1),
LoadBalancerID: "30f4f55b-4a7c-48e0-9954-5cddfee216e7",
Name: "my_listener",
Protocol: cloud.LbListenerProtocolHTTP,
ProtocolPort: 80,
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", taskIDList.Tasks)
}
curl --request POST \
--url https://api.gcore.com/cloud/v1/lblisteners/{project_id}/{region_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"load_balancer_id": "30f4f55b-4a7c-48e0-9954-5cddfee216e7",
"name": "my_listener",
"protocol": "HTTP",
"protocol_port": 80,
"allowed_cidrs": [
"10.0.0.0/8"
],
"connection_limit": 100000,
"default_pool_id": "00000000-0000-4000-8000-000000000000",
"insert_x_forwarded": false,
"secret_id": "f2e734d0-fa2b-42c2-ad33-4c6db5101e00",
"sni_secret_id": [
"f2e734d0-fa2b-42c2-ad33-4c6db5101e00",
"eb121225-7ded-4ff3-ae1f-599e145dd7cb"
],
"timeout_client_data": 50000,
"timeout_member_connect": 50000,
"timeout_member_data": null,
"user_list": [
{
"encrypted_password": "$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5",
"username": "admin"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
load_balancer_id: '30f4f55b-4a7c-48e0-9954-5cddfee216e7',
name: 'my_listener',
protocol: 'HTTP',
protocol_port: 80,
allowed_cidrs: ['10.0.0.0/8'],
connection_limit: 100000,
default_pool_id: '00000000-0000-4000-8000-000000000000',
insert_x_forwarded: false,
secret_id: 'f2e734d0-fa2b-42c2-ad33-4c6db5101e00',
sni_secret_id: ['f2e734d0-fa2b-42c2-ad33-4c6db5101e00', 'eb121225-7ded-4ff3-ae1f-599e145dd7cb'],
timeout_client_data: 50000,
timeout_member_connect: 50000,
timeout_member_data: null,
user_list: [
{
encrypted_password: '$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5',
username: 'admin'
}
]
})
};
fetch('https://api.gcore.com/cloud/v1/lblisteners/{project_id}/{region_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gcore.com/cloud/v1/lblisteners/{project_id}/{region_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'load_balancer_id' => '30f4f55b-4a7c-48e0-9954-5cddfee216e7',
'name' => 'my_listener',
'protocol' => 'HTTP',
'protocol_port' => 80,
'allowed_cidrs' => [
'10.0.0.0/8'
],
'connection_limit' => 100000,
'default_pool_id' => '00000000-0000-4000-8000-000000000000',
'insert_x_forwarded' => false,
'secret_id' => 'f2e734d0-fa2b-42c2-ad33-4c6db5101e00',
'sni_secret_id' => [
'f2e734d0-fa2b-42c2-ad33-4c6db5101e00',
'eb121225-7ded-4ff3-ae1f-599e145dd7cb'
],
'timeout_client_data' => 50000,
'timeout_member_connect' => 50000,
'timeout_member_data' => null,
'user_list' => [
[
'encrypted_password' => '$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5',
'username' => 'admin'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.gcore.com/cloud/v1/lblisteners/{project_id}/{region_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"load_balancer_id\": \"30f4f55b-4a7c-48e0-9954-5cddfee216e7\",\n \"name\": \"my_listener\",\n \"protocol\": \"HTTP\",\n \"protocol_port\": 80,\n \"allowed_cidrs\": [\n \"10.0.0.0/8\"\n ],\n \"connection_limit\": 100000,\n \"default_pool_id\": \"00000000-0000-4000-8000-000000000000\",\n \"insert_x_forwarded\": false,\n \"secret_id\": \"f2e734d0-fa2b-42c2-ad33-4c6db5101e00\",\n \"sni_secret_id\": [\n \"f2e734d0-fa2b-42c2-ad33-4c6db5101e00\",\n \"eb121225-7ded-4ff3-ae1f-599e145dd7cb\"\n ],\n \"timeout_client_data\": 50000,\n \"timeout_member_connect\": 50000,\n \"timeout_member_data\": null,\n \"user_list\": [\n {\n \"encrypted_password\": \"$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5\",\n \"username\": \"admin\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/cloud/v1/lblisteners/{project_id}/{region_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"load_balancer_id\": \"30f4f55b-4a7c-48e0-9954-5cddfee216e7\",\n \"name\": \"my_listener\",\n \"protocol\": \"HTTP\",\n \"protocol_port\": 80,\n \"allowed_cidrs\": [\n \"10.0.0.0/8\"\n ],\n \"connection_limit\": 100000,\n \"default_pool_id\": \"00000000-0000-4000-8000-000000000000\",\n \"insert_x_forwarded\": false,\n \"secret_id\": \"f2e734d0-fa2b-42c2-ad33-4c6db5101e00\",\n \"sni_secret_id\": [\n \"f2e734d0-fa2b-42c2-ad33-4c6db5101e00\",\n \"eb121225-7ded-4ff3-ae1f-599e145dd7cb\"\n ],\n \"timeout_client_data\": 50000,\n \"timeout_member_connect\": 50000,\n \"timeout_member_data\": null,\n \"user_list\": [\n {\n \"encrypted_password\": \"$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5\",\n \"username\": \"admin\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"tasks": [
"d478ae29-dedc-4869-82f0-96104425f565"
]
}Authorizations
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
Example:
1
Region ID
Example:
1
Body
application/json
ID of already existent Load Balancer.
Example:
"30f4f55b-4a7c-48e0-9954-5cddfee216e7"
Load balancer listener name
Pattern:
^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$Example:
"my_listener"
Load balancer listener protocol
Available options:
HTTP, HTTPS, PROMETHEUS, TCP, TERMINATED_HTTPS, UDP Example:
"HTTP"
Protocol port
Required range:
1 <= x <= 65535Example:
80
Network CIDRs from which service will be accessible. Order-insensitive.
Maximum array length:
100Example:
["10.0.0.0/8"]
Limit of the simultaneous connections. If -1 is provided, it is translated to the default value 100000.
Required range:
-1 <= x <= 1000000Example:
100000
ID of already existent Load Balancer Pool to attach listener to.
Example:
"00000000-0000-4000-8000-000000000000"
Add headers X-Forwarded-For, X-Forwarded-Port, X-Forwarded-Proto to requests. Only used with HTTP or TERMINATED_HTTPS protocols.
Example:
false
ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS listener
Allowed value:
""Example:
"f2e734d0-fa2b-42c2-ad33-4c6db5101e00"
List of secrets IDs containing PKCS12 format certificate/key bundles for TERMINATED_HTTPS or PROMETHEUS listeners
Example:
[
"f2e734d0-fa2b-42c2-ad33-4c6db5101e00",
"eb121225-7ded-4ff3-ae1f-599e145dd7cb"
]
Frontend client inactivity timeout in milliseconds
Required range:
0 <= x <= 86400000Example:
50000
Backend member connection timeout in milliseconds. We are recommending to use pool.timeout_member_connect instead.
Required range:
0 <= x <= 86400000Example:
50000
Backend member inactivity timeout in milliseconds. We are recommending to use pool.timeout_member_data instead.
Required range:
0 <= x <= 86400000Example:
null
Load balancer listener list of username and encrypted password items
Maximum array length:
3Show child attributes
Show child attributes
Example:
[
{
"encrypted_password": "$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5",
"username": "admin"
}
]
Response
200 - application/json
OK
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"]
Was this page helpful?