NGngrok
ReservedAddrs

Create

Create a new reserved address.

post/reserved_addrs

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/reserved_addrs
  • Auth
    HTTP bearer

Headers

ngrok-versioninteger required

Request body

descriptionstring

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

metadatastring

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

regionstring

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

Response

Create a new reserved address.

idstring

unique reserved address resource identifier

uristring

URI of the reserved address API resource

created_atstring

timestamp when the reserved address was created, RFC 3339 format

descriptionstring

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

metadatastring

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

addrstring

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

regionstring

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

Changes

No recorded changes to this operation across all 10 revisions of this API.