Sign in

v8

latestOpenAPI 3.0.0raw.githubusercontent.com2026-01-23241216351.5 KB
ReservedDomains

Update

Update the attributes of a reserved domain.

patch/reserved_domains/{id}

Path parameters

idstring required

Headers

ngrok-versioninteger required

Request body

idstring

n/a

descriptionstring

human-readable description of what this reserved domain will be used for

metadatastring

arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.

certificate_idstring

ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.

Response

Update the attributes of a reserved domain.

idstring

unique reserved domain resource identifier

uristring

URI of the reserved domain API resource

created_atstring

timestamp when the reserved domain was created, RFC 3339 format

descriptionstring

human-readable description of what this reserved domain will be used for

metadatastring

arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.

domainstring

hostname of the reserved domain

regionstring

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_targetstring

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)

acme_challenge_cname_targetstring

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.