Skip to Content
ReferenceAPI referenceSystem

Get the caller's IP address

GET
/api/v1/system/client-ip

Returns the address this server sees for the request, so a client can filter out its own traffic. Behind a reverse proxy, it is the real address only when the proxy is in APP_TRUSTED_PROXIES. behindUntrustedProxy is true when it is not.

Authorization

cookiesession<token>

Session cookie authentication.

Response Body

Request fulfilled, document follows

application/json
  1. response

The address this server sees for the caller.

behindUntrustedProxy*boolean

True when the request carried an X-Forwarded-For header that was not used, so ip is most likely the reverse proxy's address. Add the proxy to APP_TRUSTED_PROXIES to fix it.

ip*|

The caller's address, read from X-Forwarded-For when the request came through a proxy in APP_TRUSTED_PROXIES. Null when the connection has no usable address.

Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/system/client-ip'
Example Response200
{  "behindUntrustedProxy": true,  "ip": "string"}