NGngrok
IPPolicyRules

Update

Changed on

Update attributes of an IP policy rule by ID

patch/ip_policy_rules/{id}

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/ip_policy_rules/{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 rule. optional, max 255 bytes.

metadatastring

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

cidrstring

an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.

Response

Update attributes of an IP policy rule by ID

idstring

unique identifier for this IP policy rule

uristring

URI of the IP policy rule API resource

created_atstring

timestamp when the IP policy rule was created, RFC 3339 format

descriptionstring

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

metadatastring

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

cidrstring

an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.

actionstring

the action to apply to the policy rule, either allow or deny

Changes