Bearer authentication header of the form Bearer <token> , where <token> is your auth token.
a resource identifier
Get the details of a reserved domain.
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.
Show child attributes
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
status of the automatic certificate management for this domain, or null if automatic management is disabled
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.
Region and IP resolution targets configured for the Domain.
Was this page helpful?