Sign in
ReservedAddrs

Update

Update the attributes of a reserved address.

patch/reserved_addrs/{id}

Path parameters

idstring required

Headers

ngrok-versioninteger required

Request body

idstring

n/a

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.

Response

Update the attributes of a 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 endpoint across all 9 revisions of this API.