SFTPGo Octri Preview
GET/iplists/{type}/{ipornet}

Get an IP list entry by IP or network

Retrieves an IP list entry by its type and IP address or network. Use type to select the list and ipornet to identify the entry; IP addresses and networks use CIDR notation.

2 parameters
typeintegerrequired
The IP list to search: 1 for allow list, 2 for defender, 3 for rate limiter safe list, or 4 for trusted list.
Allowed:1234
ipornetstringrequired
The IP address or network to retrieve, in CIDR format.

7 status codes
200Returns the IP list entry, including its address or network, type, mode, protocols, description, and creation and update timestamps.
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
400Returned when a parameter or request value is invalid.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Returned when the request is unauthorized.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Returned when access to the IP list entry is forbidden.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
404Returned when the specified IP list entry is not found.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Returned when an internal server error occurs.
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 when a parameter is invalid. A 401 is returned when authentication is missing or invalid. A 403 is returned when access is forbidden. A 404 is returned when the entry is not found. A 500 is returned when an internal server error occurs. The type path parameter must be 1 (allow list), 2 (defender), 3 (rate limiter safe list), or 4 (trusted list). The ipornet path parameter must identify an IP address or network in CIDR format.