NGngrok
IPPolicies

Update

Changed on

Update attributes of an IP policy by ID

patch/ip_policies/{id}

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/ip_policies/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Headers

ngrok-versioninteger required

Request body

idstring

n/a

descriptionstring

human-readable description of the source IPs of this IP policy. optional, max 255 bytes.

metadatastring

arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.

Response

Update attributes of an IP policy by ID

idstring

unique identifier for this IP policy

uristring

URI of the IP Policy API resource

created_atstring

timestamp when the IP policy was created, RFC 3339 format

descriptionstring

human-readable description of the source IPs of this IP policy. optional, max 255 bytes.

metadatastring

arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.

Changes