Skip to main content

Get Whitelisted IPs API

POST /getWhitelistedIPs​

Description​

This endpoint retrieves a list of IP addresses that have been whitelisted.

Request​

Endpoint: /getWhitelistedIPs

Method: POST

Body:

query getWhitelistedIPs {
    getWhitelistedIPs {
        id
        ipAddress
    }
}

GraphQL Variables:

{}

Example Request​

cURL:

curl --location 'YOUR_API_ENDPOINT' \
--header 'Content-Type: application/json' \
--data '{"query":"query getWhitelistedIPs {\n    getWhitelistedIPs {\n        id\n        ipAddress\n    }\n}","variables":{}}'

Response​

The response will include a list of whitelisted IP addresses with the following fields:

  • id: Unique identifier of the whitelist record.
  • ipAddress: The IP address that has been whitelisted.

Errors​

  • 500 Internal Server Error: Server error while processing the request.
  • 403 Forbidden: User does not have permission to view whitelisted IPs.

Notes​

  • This endpoint returns all IP addresses that are currently whitelisted. Ensure you have appropriate permissions to access this data.
  • Whitelisted IPs are typically trusted IPs that are allowed to access the system. Regularly review and update the list to maintain security.
  • If you have a large number of whitelisted IPs, consider implementing pagination to manage the dataset efficiently.