SFTPGo Octri Preview
GET/iplists/{type}

Get IP list entries

Returns the entries in the specified IP list. Use the filter parameter to search for specific IP addresses or networks

5 parameters
typeintegerrequired
IP list type
Allowed:1234
filterstringoptional
restrict results to ipornet matching or starting with this filter
fromstringoptional
ipornet to start from
limitintegeroptional
The maximum number of items to return. Max value is 500, default is 100
Default:100
orderstringoptional
Ordering entries by ipornet field. Default ASC
Allowed:ASCDESC

6 status codes
200successful operation
created_atintegeroptional
creation time as unix timestamp in milliseconds
descriptionstringoptional
optional description
ipornetstringoptional
IP address or network in CIDR format, for example `192.168.1.2/32`, `192.168.0.0/24`, `2001:db8::/32`
modeintegeroptional
IP list modes * `1` - allow * `2` - deny, supported for defender list type only
Allowed:12
protocolsintegeroptional
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
typeintegeroptional
IP List types: * `1` - allow list * `2` - defender * `3` - rate limiter safe list * `4` - trusted list
Allowed:1234
updated_atintegeroptional
last update time as unix timestamp in milliseconds
400Bad Request
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Unauthorized
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Forbidden
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Internal Server Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty

Error handling

A 400 is returned: Bad Request. A 401 is returned: Unauthorized. A 403 is returned: Forbidden. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.