HomeGuidesAPI Reference
API Reference

Configure socket IP usage for IP allow list validation

Configures whether to use the direct TCP socket IP address or X-Forwarded-For header for IP allow list validation. When enabled (true), the system validates against the direct socket IP, ignoring proxy headers. When disabled (false, default), X-Forwarded-For headers are considered for proxy scenarios. This setting is not available for cloud/container orchestrators.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

JSON object containing the Use_socket_IP_address boolean setting. The key 'Use_socket_IP_address' is required.

Request body for configuring socket IP usage in IP allow list validation. Controls whether the system uses the direct TCP socket IP or X-Forwarded-For header for client identification.

boolean
required
Defaults to false

When true, use direct socket IP for validation. When false (default), consider X-Forwarded-For headers for proxy scenarios.

Responses
204

Successfully updated the Use Socket IP setting. No content returned.

403

Forbidden - Authentication required or session expired.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain