Skip to main content

Remove From Whitelist API

POST /removeFromWhitelist

Description

This API endpoint allows removing an IP address from the whitelist. This action will revoke access for the specified IP address to certain resources.

Request Body

The request utilizes GraphQL to perform the removeFromWhitelist mutation.

Mutation:

mutation removeFromWhitelist ($ipAddress: String!) {
removeFromWhitelist (ipAddress: $ipAddress)
}

Variables:

{
"ipAddress": "<IP_Address>"
}
  • ipAddress (String): The IP address to be removed from the whitelist.

Response:

  • Success (200 OK):

    • The response confirms that the IP address has been successfully removed from the whitelist. The exact success message or data format may depend on the implementation.
    {
    "data": {
    "removeFromWhitelist": null
    }
    }
  • Error (4XX/5XX):

    • If there is an issue with removing the IP address, such as the IP address not being in the whitelist or server errors, the response will include an appropriate error message and status code.

Note:

Ensure that the IP address you wish to remove is currently on the whitelist. The response will confirm if the IP address was successfully removed from the whitelist.