Create a listener on this load balancer
curl --request POST \
--url https://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"protocol": "https",
"port": 443,
"certificates": [
"prod-web"
],
"default_target_group": "b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4",
"exposure": "both",
"tags": {
"environment": "production",
"team": "backend"
}
}
'import requests
url = "https://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners"
payload = {
"protocol": "https",
"port": 443,
"certificates": ["prod-web"],
"default_target_group": "b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4",
"exposure": "both",
"tags": {
"environment": "production",
"team": "backend"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
protocol: 'https',
port: 443,
certificates: ['prod-web'],
default_target_group: 'b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4',
exposure: 'both',
tags: {environment: 'production', team: 'backend'}
})
};
fetch('https://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners', 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://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners",
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([
'protocol' => 'https',
'port' => 443,
'certificates' => [
'prod-web'
],
'default_target_group' => 'b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4',
'exposure' => 'both',
'tags' => [
'environment' => 'production',
'team' => 'backend'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners"
payload := strings.NewReader("{\n \"protocol\": \"https\",\n \"port\": 443,\n \"certificates\": [\n \"prod-web\"\n ],\n \"default_target_group\": \"b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4\",\n \"exposure\": \"both\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"protocol\": \"https\",\n \"port\": 443,\n \"certificates\": [\n \"prod-web\"\n ],\n \"default_target_group\": \"b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4\",\n \"exposure\": \"both\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"protocol\": \"https\",\n \"port\": 443,\n \"certificates\": [\n \"prod-web\"\n ],\n \"default_target_group\": \"b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4\",\n \"exposure\": \"both\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n }\n}"
response = http.request(request)
puts response.read_body{
"listener": {
"crn": "<string>",
"id": "e1f2a3b4-c5d6-4789-e0f1-a2b3c4d5e6f7",
"protocol": "https",
"port": 443,
"exposure": "both",
"tags": {
"environment": "production",
"team": "backend"
},
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-15T09:30:00Z",
"default_certificate": {
"id": "550e8400-e29b-41d4-a716-446655440012",
"crn": "crn:certificate::my-account:certificate/prod-web",
"name": "prod-web"
},
"default_target_group": {
"id": "550e8400-e29b-41d4-a716-446655440013",
"crn": "crn:loadbalancer:sa-saopaulo-1:my-account:target-group/web",
"name": "web"
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "CONFLICT",
"message": "Resource with this name already exists",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Listeners
Create a listener on this load balancer
POST
/
v1
/
load-balancers
/
{id}
/
listeners
Create a listener on this load balancer
curl --request POST \
--url https://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"protocol": "https",
"port": 443,
"certificates": [
"prod-web"
],
"default_target_group": "b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4",
"exposure": "both",
"tags": {
"environment": "production",
"team": "backend"
}
}
'import requests
url = "https://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners"
payload = {
"protocol": "https",
"port": 443,
"certificates": ["prod-web"],
"default_target_group": "b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4",
"exposure": "both",
"tags": {
"environment": "production",
"team": "backend"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
protocol: 'https',
port: 443,
certificates: ['prod-web'],
default_target_group: 'b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4',
exposure: 'both',
tags: {environment: 'production', team: 'backend'}
})
};
fetch('https://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners', 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://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners",
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([
'protocol' => 'https',
'port' => 443,
'certificates' => [
'prod-web'
],
'default_target_group' => 'b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4',
'exposure' => 'both',
'tags' => [
'environment' => 'production',
'team' => 'backend'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners"
payload := strings.NewReader("{\n \"protocol\": \"https\",\n \"port\": 443,\n \"certificates\": [\n \"prod-web\"\n ],\n \"default_target_group\": \"b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4\",\n \"exposure\": \"both\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"protocol\": \"https\",\n \"port\": 443,\n \"certificates\": [\n \"prod-web\"\n ],\n \"default_target_group\": \"b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4\",\n \"exposure\": \"both\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://loadbalancer.{region}.basaltic.sh/v1/load-balancers/{id}/listeners")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"protocol\": \"https\",\n \"port\": 443,\n \"certificates\": [\n \"prod-web\"\n ],\n \"default_target_group\": \"b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4\",\n \"exposure\": \"both\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n }\n}"
response = http.request(request)
puts response.read_body{
"listener": {
"crn": "<string>",
"id": "e1f2a3b4-c5d6-4789-e0f1-a2b3c4d5e6f7",
"protocol": "https",
"port": 443,
"exposure": "both",
"tags": {
"environment": "production",
"team": "backend"
},
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-15T09:30:00Z",
"default_certificate": {
"id": "550e8400-e29b-41d4-a716-446655440012",
"crn": "crn:certificate::my-account:certificate/prod-web",
"name": "prod-web"
},
"default_target_group": {
"id": "550e8400-e29b-41d4-a716-446655440013",
"crn": "crn:loadbalancer:sa-saopaulo-1:my-account:target-group/web",
"name": "web"
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "CONFLICT",
"message": "Resource with this name already exists",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Requires the IAM action
loadbalancer:CreateListener. See LOADBALANCER permissions for the full list, what each one covers, and an example policy.Authorizations
An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>.
This is the recommended way to authenticate.
Get one by exchanging a service account's access key pair at
POST /v1/oauth/token with grant_type=client_credentials. It is the
standard client-credentials grant, so any OAuth-aware library will
obtain and refresh it for you.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.
Headers
Optional client-generated key that makes a create replay-safe. Retrying a request with the same key returns the original outcome verbatim instead of creating a duplicate resource. Reusing a key with a different request body is rejected (422); a request whose key is still being processed returns 409. Records are honored for 24 hours. Use a UUID or similarly unique token.
Maximum string length:
255Path Parameters
Example:
"4e1f8c2a-9b3d-4f6e-8a1c-2d5e7f9a0b3c"
Body
application/json
Target group relationships accept UUID, CRN or exact account-scoped names in this region.
HTTPS listeners require >=1 certificate, named by CRN, UUID or exact account-scoped name in
certificates; the first entry becomes the default (the fallback when
SNI doesn't match). No key material is accepted — the agent fetches it
from the certificate service against the CRN.
Available options:
http, https, tcp, udp Example:
"https"
Required range:
1 <= x <= 65535Example:
443
Certificate UUID, CRN, or exact account-scoped name.
Minimum string length:
1Example:
["prod-web"]
Example:
"b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4"
Which LB addresses are bound. Defaults to 'both'; pick private_only when the LB has no FIP yet.
Available options:
public_only, private_only, both Example:
"both"
Show child attributes
Show child attributes
Example:
{
"environment": "production",
"team": "backend"
}
Response
Created
Show child attributes
Show child attributes