NGngrok
IPRestrictions

Update

Changed on

Update attributes of an IP restriction by ID

patch/ip_restrictions/{id}

Request

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

Path parameters

idstring required

Headers

ngrok-versioninteger required

Request body

idstring

n/a

descriptionstring

human-readable description of this IP restriction. optional, max 255 bytes.

metadatastring

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

enforcedboolean

true if the IP restriction will be enforced. if false, only warnings will be issued

ip_policy_idsstring[]

the set of IP policy identifiers that are used to enforce the restriction

Response

Update attributes of an IP restriction by ID

idstring

unique identifier for this IP restriction

uristring

URI of the IP restriction API resource

created_atstring

timestamp when the IP restriction was created, RFC 3339 format

descriptionstring

human-readable description of this IP restriction. optional, max 255 bytes.

metadatastring

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

enforcedboolean

true if the IP restriction will be enforced. if false, only warnings will be issued

typestring

the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpoints

Changes