Skip to main content
POST
/
agent_ingresses
Create
curl --request POST \
  --url https://api.ngrok.com/agent_ingresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '{
  "description": "<string>",
  "metadata": "<string>",
  "domain": "<string>",
  "certificate_management_policy": {
    "authority": "<string>",
    "private_key_type": "<string>"
  }
}'
{
  "id": "<string>",
  "uri": "<string>",
  "description": "<string>",
  "metadata": "<string>",
  "domain": "<string>",
  "ns_targets": [
    "<string>"
  ],
  "region_domains": [
    "<string>"
  ],
  "created_at": "<string>",
  "certificate_management_policy": {
    "authority": "<string>",
    "private_key_type": "<string>"
  },
  "certificate_management_status": {
    "renews_at": "<string>",
    "provisioning_job": {
      "error_code": "<string>",
      "msg": "<string>",
      "started_at": "<string>",
      "retries_at": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
ngrok-version
integer
default:2
required

Body

application/json
​
domain
string
required

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

​
description
string

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

​
metadata
string

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

​
certificate_management_policy
object

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

Response

201 - application/json

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.

​
id
string

unique Agent Ingress resource identifier

​
uri
string

URI to the API resource of this Agent ingress

​
description
string

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

​
metadata
string

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

​
domain
string

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

​
ns_targets
string[]

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_domains
string[]

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_at
string

timestamp when the Agent Ingress was created, RFC 3339 format

​
certificate_management_policy
object

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

​
certificate_management_status
object

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