Universal Gateway
Traffic Policy
Secure Tunnels
Observability
SSH Certificates
Partners
Vaults & Secrets
Deprecated
curl --request GET \
--url https://api.ngrok.com/reserved_domains \
--header 'Authorization: Bearer <token>' \
--header 'ngrok-version: <ngrok-version>'{
"reserved_domains": [
{
"id": "<string>",
"uri": "<string>",
"created_at": "<string>",
"description": "<string>",
"metadata": "<string>",
"domain": "<string>",
"region": "<string>",
"cname_target": "<string>",
"certificate": {
"id": "<string>",
"uri": "<string>"
},
"certificate_management_policy": {
"authority": "<string>",
"private_key_type": "<string>"
},
"certificate_management_status": {
"renews_at": "<string>",
"provisioning_job": {
"error_code": "<string>",
"msg": "<string>",
"started_at": "<string>",
"retries_at": "<string>"
}
},
"acme_challenge_cname_target": "<string>"
}
],
"uri": "<string>",
"next_page_uri": "<string>"
}List
List all reserved domains on this account.
curl --request GET \
--url https://api.ngrok.com/reserved_domains \
--header 'Authorization: Bearer <token>' \
--header 'ngrok-version: <ngrok-version>'{
"reserved_domains": [
{
"id": "<string>",
"uri": "<string>",
"created_at": "<string>",
"description": "<string>",
"metadata": "<string>",
"domain": "<string>",
"region": "<string>",
"cname_target": "<string>",
"certificate": {
"id": "<string>",
"uri": "<string>"
},
"certificate_management_policy": {
"authority": "<string>",
"private_key_type": "<string>"
},
"certificate_management_status": {
"renews_at": "<string>",
"provisioning_job": {
"error_code": "<string>",
"msg": "<string>",
"started_at": "<string>",
"retries_at": "<string>"
}
},
"acme_challenge_cname_target": "<string>"
}
],
"uri": "<string>",
"next_page_uri": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Response
List all reserved domains on this account.
the list of all reserved domains on this account
Show child attributes
Show child attributes
unique reserved domain resource identifier
URI of the reserved domain API resource
timestamp when the reserved domain was created, RFC 3339 format
human-readable description of what this reserved domain will be used for
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
hostname of the reserved domain
deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)
DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of an ngrok owned domain (e.g. *.ngrok.app)
object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
Show child attributes
Show child attributes
certificate authority to request certificates from. The only supported value is letsencrypt.
type of private key to use when requesting certificates. Defaults to ecdsa, can be either rsa or ecdsa.
status of the automatic certificate management for this domain, or null if automatic management is disabled
Show child attributes
Show child attributes
timestamp when the next renewal will be requested, RFC 3339 format
status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed
Show child attributes
Show child attributes
if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).
a message describing the current status or error
timestamp when the provisioning job started, RFC 3339 format
timestamp when the provisioning job will be retried
DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
URI of the reserved domain list API resource
URI of the next page, or null if there is no next page
Was this page helpful?