Skip to content

Get Load Balancer Custom Domain

GET
/gateway/{gateway_id}/custom-domain/
curl --request GET \
--url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/gateway/{gateway_id}/custom-domain/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
--header 'Authorization: Bearer <API_TOKEN>'

Returns the custom domain of the Load Balancer, its status and the DNS target to point it at. data is null when no custom domain is set. Each call also checks whether DNS points at the Load Balancer and moves the status on.

gateway_id
required
integer

Load Balancer ID

project_id
required
integer

Project ID

active_iam
integer

Active IAM ID (To access contact person account) Find your Active IAM ID here

location
required
string
Allowed values: Delhi Chennai

Location

The custom domain, or null

Media typeapplication/json
object
code
integer
message
string
data
object
domain
string
status

pending_dns until DNS points at the Load Balancer, issuing while the certificate is being issued, active, or failed.

string
Allowed values: pending_dns issuing active failed
cname_target

The name to point a CNAME record for the domain at.

string
dns_verified

true when the domain resolves to the Load Balancer.

boolean
reason

The certificate issuer’s message when issuing is stuck or failed.

string
certificate

The certificate for the domain.

object
id
integer
name
string
source

ACME for a free certificate, UPLOADED for your own.

string
Allowed values: ACME UPLOADED
status

Active, Pending or Expired.

string
Allowed values: Active Pending Expired
cert_chain

The certificate chain as PEM text. It can be empty.

string
domains
Array<string>
not_before
string
nullable
not_after
string
nullable
issuer
string
nullable
key_type
string
nullable
fingerprint
string
nullable
days_remaining
integer
nullable
is_expired
boolean
in_use_by
Array<object>
object
created_by

The user who created the certificate.

object
id
integer
name
string
email
string
username
string
created_at
string
updated_at
string
errors
object

Example

{
"code": 200,
"message": "Success",
"data": {
"domain": "www.example.com",
"status": "pending_dns",
"cname_target": "lb-12-abc123.e2enetworks.net",
"dns_verified": false,
"reason": "",
"certificate": {
"id": 15,
"name": "acme-12-1a2b3c4d-www.example.com",
"source": "ACME",
"status": "Active",
"cert_chain": "",
"not_before": null,
"not_after": null,
"issuer": null,
"key_type": null,
"fingerprint": null,
"days_remaining": null,
"is_expired": false,
"created_by": {
"id": 1,
"name": "A User",
"email": "user@example.com",
"username": "auser"
},
"created_at": "2026-10-21T11:30:00Z",
"updated_at": "2026-10-21T11:30:00Z"
}
},
"errors": {}
}

The project ID is missing or is not a number.

Media typeapplication/json
object
code
integer
message
string
data
object
errors
string

Example

{
"code": 400,
"message": "Bad Request",
"data": {},
"errors": "Project ID is missing or invalid"
}

No Load Balancer with that ID in the project and region.

Media typeapplication/json
object
code
integer
message
string
data
object
errors
string

Example

{
"code": 404,
"message": "Bad Request",
"data": {},
"errors": "Gateway not found"
}