Create - ngrok documentation

Create - ngrok documentation

Bearer authentication header of the form Bearer <token> , where <token> is your auth token.

the domain that you own to be used as the base domain name to generate regional agent ingress domains.

human-readable description of the use of this Agent Ingress. optional, max 255 bytes.

arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes

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

Show child attributes

Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.

unique Agent Ingress resource identifier

URI to the API resource of this Agent ingress

a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok

a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions

timestamp when the Agent Ingress was created, RFC 3339 format

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

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

Was this page helpful?