v1

latestOpenAPI 3.0.3AGPL-3.0-only2026-07-17120116247.0 KB
IP Lists

Get IP list entries

Returns an array with one or more IP list entry

get/iplists/{type}

Query parameters

filterstring

restrict results to ipornet matching or starting with this filter

fromstring

ipornet to start from

limitinteger

The maximum number of items to return. Max value is 500, default is 100

order'ASC' | 'DESC'
Example:ASC

Ordering entries by ipornet field. Default ASC

Response

successful operation

ipornetstring

IP address or network in CIDR format, for example 192.168.1.2/32, 192.168.0.0/24, 2001:db8::/32

descriptionstring

optional description

type1 | 2 | 3

IP List types:

  • 1 - allow list
  • 2 - defender
  • 3 - rate limiter safe list
mode1 | 2

IP list modes

  • 1 - allow
  • 2 - deny, supported for defender list type only
protocolsinteger

Defines the protocol the entry applies to. 0 means all the supported protocols, 1 SSH, 2 FTP, 4 WebDAV, 8 HTTP. Protocols can be combined, for example 3 means SSH and FTP

created_atinteger

creation time as unix timestamp in milliseconds

updated_atinteger

last update time as unix timestamp in millisecond