Skip to main content
POST
/
reserved_addrs
Create
curl --request POST \
  --url https://api.ngrok.com/reserved_addrs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '{
  "description": "<string>",
  "metadata": "<string>",
  "region": "<string>"
}'
{
  "id": "<string>",
  "uri": "<string>",
  "created_at": "<string>",
  "description": "<string>",
  "metadata": "<string>",
  "addr": "<string>",
  "region": "<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
​
description
string

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

​
metadata
string

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

​
region
string

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

Response

201 - application/json

Create a new reserved address.

​
id
string

unique reserved address resource identifier

​
uri
string

URI of the reserved address API resource

​
created_at
string

timestamp when the reserved address was created, RFC 3339 format

​
description
string

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

​
metadata
string

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

​
addr
string

hostname:port of the reserved address that was assigned at creation time

​
region
string

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