Navigation

Whitelist

The whitelist resource lets you retrieve and update a user’s whitelist, which controls the user’s access to whitelisted API operations. Users can issue whitelisted API operations only from addresses on their own whitelists. To use the whitelist resource you must know the ID of the user who owns the whitelist. To retrieve a user’s ID, see Get All Users in a Group.

The whitelist resource’s POST and DELETE operations are themselves whitelisted. They must originate from an address already on the user’s whitelist.

You can access whitelist information only for the user issuing the request. The USER-ID in the URL must match the ID of the user associated with the Public API key used to send the request.

Endpoints

The following endpoints are available for hosts.

Method Endpoint Description
GET /api/public/v1.0/users/{USER-ID}/whitelist Retrieves the whitelist for the current user.
GET /api/public/v1.0/users/{USER-ID}/whitelist/{IP-ADDRESS} Retrieves the whitelist for the specified IP address.
POST /api/public/v1.0/users/{USER-ID}/whitelist/{IP-ADDRESS} Adds entries to the whitelist for the current user.
DELETE /api/public/v1.0/users/{USER-ID}/whitelist/{IP-ADDRESS} Deletes an entry from the whitelist for the current user.