IP Lists

Download schema

Endpoints for discovering the IP lists available to rule conditions.

List IP lists

GET

https://flowguard.network/api/v1

/ip-lists

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

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.

List IP lists › query Parameters

query

string | null · maxLength: 255

Search results by name.

per_page

integer · min: 1 · max: 100

Number of results per page.

Default: 50

page

integer · min: 1

Page number to return.

Default: 1

List IP lists › Responses

Paginated set of IPList

IPList[] · required

object · required

Create an IP list

POST

https://flowguard.network/api/v1

/ip-lists

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

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

SaveIPListRequest

name

string · maxLength: 255 · required

Human-readable IP-list name.

Example: Synthetic blocked networks

Create an IP list › Responses

The IP list was created.

IPList · required

List IP-list entries

GET

https://flowguard.network/api/v1

/ip-lists/{ipList}/entries

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List entries in a team-owned or managed global IP list. Search by address, network, comment, or formatted entry ID.

List IP-list entries › path Parameters

ipList

string · required

List IP-list entries › query Parameters

query

string | null · maxLength: 255

Search by IP address, CIDR, comment, or formatted entry ID.

per_page

integer · min: 1 · max: 100

Default: 50

page

integer · min: 1

Default: 1

List IP-list entries › Responses

Paginated set of IPListEntry

IPListEntry[] · required

object · required

Import IP-list entries

POST

https://flowguard.network/api/v1

/ip-lists/{ipList}/entries

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Add up to 1,000 entries to a custom IP list. Values are normalized, and duplicates in the request or list are skipped.

Import IP-list entries › path Parameters

ipList

string · required

Import IP-list entries › Request Body

ImportIPListEntriesRequest

object[] · minItems: 1 · maxItems: 1000 · required

Entries to normalize and add to the custom IP list.

Import IP-list entries › Responses

Every supplied entry already existed.

string

Show an IP-list entry

GET

https://flowguard.network/api/v1

/ip-lists/{ipList}/entries/{entry}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Show one entry from a team-owned or managed global IP list available to the authenticated team.

Show an IP-list entry › path Parameters

ipList

string · required

entry

string · required

Show an IP-list entry › Responses

IPListEntry

IPListEntry · required

Update an IP-list entry

PATCH

https://flowguard.network/api/v1

/ip-lists/{ipList}/entries/{entry}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Update an entry in a custom IP list belonging to the authenticated team. Omitted fields retain their current values.

Update an IP-list entry › path Parameters

ipList

string · required

entry

string · required

Update an IP-list entry › Request Body

SaveIPListEntryRequest

content

string · maxLength: 255 · required

IPv4, IPv6, or CIDR value.

Example: 198.51.100.24

comment

string | null · maxLength: 255 · required

Optional note associated with the entry.

Update an IP-list entry › Responses

IPListEntry

IPListEntry · required

Delete an IP-list entry

DELETE

https://flowguard.network/api/v1

/ip-lists/{ipList}/entries/{entry}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Delete an entry from a custom IP list belonging to the authenticated team.

Delete an IP-list entry › path Parameters

ipList

string · required

entry

string · required

Delete an IP-list entry › Responses

The IP-list entry was deleted.

string

Show an IP list

GET

https://flowguard.network/api/v1

/ip-lists/{ipList}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Show one team-owned or managed global IP list available to the authenticated team.

Show an IP list › path Parameters

ipList

string · required

Show an IP list › Responses

IPList

IPList · required

Update an IP list

PATCH

https://flowguard.network/api/v1

/ip-lists/{ipList}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Rename a custom IP list belonging to the authenticated team. Managed global lists are read-only.

Update an IP list › path Parameters

ipList

string · required

Update an IP list › Request Body

SaveIPListRequest

name

string · maxLength: 255 · required

Human-readable IP-list name.

Example: Synthetic blocked networks

Update an IP list › Responses

IPList

IPList · required

Delete an IP list

DELETE

https://flowguard.network/api/v1

/ip-lists/{ipList}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Delete a custom IP list belonging to the authenticated team. A list referenced by a rule or trusted-proxy configuration must be detached first.

Delete an IP list › path Parameters

ipList

string · required

Delete an IP list › Responses

The IP list was deleted.

string

Servers