v8

latestOpenAPI 3.0.0raw.githubusercontent.com2026-01-23241216351.5 KB
IPPolicies

Create

Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.

post/ip_policies

Headers

ngrok-versioninteger required

Request body

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

Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.

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.