COconductorone
Session Settings

Test Source Ip

Changed on

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

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/settings/session/test-source-ip
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

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.

Changes

  • f2cf3228f366Revision changes
    • breaking

      the request property became not nullable

    • breaking

      added subschema #2 to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

  • 17f9f3bcedd5Revision changes
    • info

      endpoint added