v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-224341,4072.0 MB

Session Settings

Test Source Ip

TestSourceIP checks whether a given IP address would be allowed by the specified CIDR allowlist rules.

post/api/v1/settings/session/test-source-ip

Request body

allowCidrstring[] nullable

The CIDR allowlist rules to test against. If empty, uses the tenant's current allowlist. Accepts IPv4 (e.g. 10.0.0.0/24) or IPv6 (e.g. 2001:db8::/32) CIDRs.

sourceIpstring

if unset, uses the source IP of the request. Accepts IPv4 (e.g. 10.0.0.5) or IPv6 (e.g. 2001:db8::1) addresses, optionally with a CIDR prefix.

Response

Successful response

allowedboolean

Whether the tested IP address is allowed by the CIDR rules.

checkedIpstring

The IP address that was checked, either from the request or inferred from the caller.