Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReservedDomain

Hierarchy

  • ReservedDomain

Index

Properties

Optional acmeChallengeCnameTarget

acmeChallengeCnameTarget: 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.

Optional certificate

certificate: Ref

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.

Optional certificateManagementPolicy

certificateManagementPolicy: ReservedDomainCertPolicy

configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled

Optional certificateManagementStatus

certificateManagementStatus: ReservedDomainCertStatus

status of the automatic certificate management for this domain, or null if automatic management is disabled

Optional cnameTarget

cnameTarget: 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)

createdAt

createdAt: Date

timestamp when the reserved domain was created, RFC 3339 format

Optional description

description: string

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

domain

domain: string

hostname of the reserved domain

id

id: string

unique reserved domain resource identifier

Optional metadata

metadata: string

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

region

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)

uri

uri: string

URI of the reserved domain API resource

Generated using TypeDoc