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)
description
string
human-readable description of what this reserved domain will be used for
metadata
string
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
certificate_id
string
ID of a user-uploaded to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.
timestamp when the reserved domain was created, RFC 3339 format
description
string
human-readable description of what this reserved domain will be used for
metadata
string
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
domain
string
hostname of the reserved domain
region
string
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)
cname_target
string
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.
status of the automatic certificate management for this domain, or null if automatic management is disabled
acme_challenge_cname_target
string
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.
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).
msg
string
a message describing the current status or error
started_at
string
timestamp when the provisioning job started, RFC 3339 format
retries_at
string
timestamp when the provisioning job will be retried
timestamp when the reserved domain was created, RFC 3339 format
description
string
human-readable description of what this reserved domain will be used for
metadata
string
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
domain
string
hostname of the reserved domain
region
string
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)
cname_target
string
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.
status of the automatic certificate management for this domain, or null if automatic management is disabled
acme_challenge_cname_target
string
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.
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).
msg
string
a message describing the current status or error
started_at
string
timestamp when the provisioning job started, RFC 3339 format
retries_at
string
timestamp when the provisioning job will be retried
timestamp when the reserved domain was created, RFC 3339 format
description
string
human-readable description of what this reserved domain will be used for
metadata
string
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
domain
string
hostname of the reserved domain
region
string
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)
cname_target
string
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.
status of the automatic certificate management for this domain, or null if automatic management is disabled
acme_challenge_cname_target
string
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.
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).
msg
string
a message describing the current status or error
started_at
string
timestamp when the provisioning job started, RFC 3339 format
retries_at
string
timestamp when the provisioning job will be retried
human-readable description of what this reserved domain will be used for
metadata
string
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
certificate_id
string
ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.
timestamp when the reserved domain was created, RFC 3339 format
description
string
human-readable description of what this reserved domain will be used for
metadata
string
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
domain
string
hostname of the reserved domain
region
string
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)
cname_target
string
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.
status of the automatic certificate management for this domain, or null if automatic management is disabled
acme_challenge_cname_target
string
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.
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).
msg
string
a message describing the current status or error
started_at
string
timestamp when the provisioning job started, RFC 3339 format
retries_at
string
timestamp when the provisioning job will be retried
Detach Certificate Management Policy from Reserved Domain
Detach the certificate management policy attached to a reserved domain.