IP Lists
Endpoints for discovering the IP lists available to rule conditions.
List IP lists
List team-owned and global IP lists that can be referenced by IP-list rule conditions. The response indicates whether a list supports confidence thresholds.
query Parameters
querySearch results by name.
per_pageNumber of results per page.
pagePage number to return.
List IP lists › Responses
Paginated set of IPList
Create an IP list
Create an empty custom IP list for the authenticated team. Managed global lists cannot be created through this API.
Create an IP list › Request Body
nameHuman-readable IP-list name.
Create an IP list › Responses
The IP list was created.
List IP-list entries
List entries in a team-owned or managed global IP list. Search by address, network, comment, or formatted entry ID.
path Parameters
ipListquery Parameters
querySearch by IP address, CIDR, comment, or formatted entry ID.
per_pagepageList IP-list entries › Responses
Paginated set of IPListEntry
Import IP-list entries
Add up to 1,000 entries to a custom IP list. Values are normalized, and duplicates in the request or list are skipped.
path Parameters
ipListImport IP-list entries › Request Body
Entries to normalize and add to the custom IP list.
Import IP-list entries › Responses
Every supplied entry already existed.
Show an IP-list entry
Show one entry from a team-owned or managed global IP list available to the authenticated team.
path Parameters
ipListentryShow an IP-list entry › Responses
IPListEntry
Update an IP-list entry
Update an entry in a custom IP list belonging to the authenticated team. Omitted fields retain their current values.
path Parameters
ipListentryUpdate an IP-list entry › Request Body
contentIPv4, IPv6, or CIDR value.
commentOptional note associated with the entry.
Update an IP-list entry › Responses
IPListEntry
Show an IP list
Show one team-owned or managed global IP list available to the authenticated team.
path Parameters
ipListShow an IP list › Responses
IPList
Update an IP list
Rename a custom IP list belonging to the authenticated team. Managed global lists are read-only.
path Parameters
ipListUpdate an IP list › Request Body
nameHuman-readable IP-list name.
Update an IP list › Responses
IPList