Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReservedDomainCreate

Hierarchy

  • ReservedDomainCreate

Index

Properties

Optional certificateId

certificateId: string

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

Optional certificateManagementPolicy

certificateManagementPolicy: ReservedDomainCertPolicy

configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.

Optional description

description: string

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

domain

domain: string

hostname of the reserved domain

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)

Generated using TypeDoc