cURL
curl --request GET \ --url https://api.ngrok.com/ip_restrictions \ --header 'Authorization: Bearer <token>' \ --header 'ngrok-version: <ngrok-version>'
{ "ip_restrictions": [ { "id": "<string>", "uri": "<string>", "created_at": "<string>", "description": "<string>", "metadata": "<string>", "enforced": true, "type": "<string>", "ip_policies": [ { "id": "<string>", "uri": "<string>" } ] } ], "uri": "<string>", "next_page_uri": "<string>" }
List all IP restrictions on this account
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
the list of all IP restrictions on this account
Show child attributes
unique identifier for this IP restriction
URI of the IP restriction API resource
timestamp when the IP restriction was created, RFC 3339 format
human-readable description of this IP restriction. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
true if the IP restriction will be enforced. if false, only warnings will be issued
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
dashboard
api
agent
endpoints
the set of IP policies that are used to enforce the restriction
a resource identifier
a uri for locating a resource
URI of the IP restrictions list API resource
URI of the next page, or null if there is no next page
Was this page helpful?