Skip to main content
PATCH
Update a listener
Requires the IAM action loadbalancer:UpdateListener. See LOADBALANCER permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

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.

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.

Path Parameters

id
string
required
Example:

"4e1f8c2a-9b3d-4f6e-8a1c-2d5e7f9a0b3c"

listener_id
string
required
Example:

"e1f2a3b4-c5d6-4789-e0f1-a2b3c4d5e6f7"

Body

application/json

Patch a listener. Use default_certificate to select an already attached certificate as the default. Certificate renewals are picked up automatically; manage attachments through the listener's certificates collection.

Omit default_target_group to leave it unchanged, send a string reference to replace it, or send null to clear it.

default_target_group
string | null

UUID, CRN or exact account-scoped target group name. Null clears the default; omission leaves it unchanged.

Minimum string length: 1
Example:

"b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4"

exposure
enum<string>

Mutate which addresses are bound. Omit to leave unchanged.

Available options:
public_only,
private_only,
both
Example:

"both"

tags
object
Example:
default_certificate
string

UUID, CRN, or exact name of a certificate already attached to this listener. Makes it the default and demotes the previous default atomically. Does not attach new certificates.

Minimum string length: 1
Example:

"prod-web"

Response

OK

listener
object
required