Instance Constructors

1.  new ReservedDomain(id: String, uri: URI, createdAt: OffsetDateTime, description: String, metadata: String, domain: String, region: String, cnameTarget: Option[String] = None, certificate: Option[Ref] = None, certificateManagementPolicy: Option[ReservedDomainCertPolicy] = None, certificateManagementStatus: Option[ReservedDomainCertStatus] = None, acmeChallengeCnameTarget: Option[String] = None)

   create a new ReservedDomain.

   create a new ReservedDomain.

   id

   unique reserved domain resource identifier

   uri

   URI of the reserved domain API resource

   createdAt

   timestamp when the reserved domain was created, RFC 3339 format

   description

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

   metadata

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

   domain

   hostname of the reserved domain

   region

   reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)

   cnameTarget

   DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io

   certificate

   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.

   certificateManagementPolicy

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

   certificateManagementStatus

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

   acmeChallengeCnameTarget

   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.