v8

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

AgentIngresses

Create

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.

post/agent_ingresses

ngrok-versioninteger required

descriptionstring

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

metadatastring

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

domainstring required

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

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.

idstring

unique Agent Ingress resource identifier

uristring

URI to the API resource of this Agent ingress

descriptionstring

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

metadatastring

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

domainstring

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

ns_targetsstring[]

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

region_domainsstring[]

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

created_atstring

timestamp when the Agent Ingress was created, RFC 3339 format