Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Remove one or more IPs from the allow list



API Overview

api-overview page anchor

IP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API.

There is no limit to the number of IP addresses that you can allow.

(information)

Info

It is possible to remove your own IP address from your list of allowed addresses, thus blocking your own access to your account. While we are able to restore your access, we do require thorough proof of your identify and ownership of your account. We take the security of your account very seriously, and wish to prevent any 'bad actors' from maliciously gaining access to your account.

Your current IP is clearly displayed to help prevent you from accidentally removing it from the allowed addresses.

For more information, please see our IP Access Management documentation.


DELETE/v3/access_settings/whitelist

Base url: https://api.sendgrid.com

This endpoint allows you to remove one or more IP addresses from your list of allowed addresses.

To remove one or more IP addresses, pass this endpoint an array containing the ID(s) associated with the IP(s) you intend to remove. You can retrieve the IDs associated with your allowed IP addresses using the "Retrieve a list of currently allowed IPs" endpoint.

It is possible to remove your own IP address, which will block access to your account. You will need to submit a support ticket if this happens. For this reason, it is important to double check that you are removing only the IPs you intend to remove when using this endpoint.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

SchemaExample
Property nameTypeRequiredDescriptionChild properties
idsarray[integer]Optional

An array of the IDs of the IP address that you want to remove from your allow list.

204401403404500
Schema
Property nameTypeRequiredDescriptionChild properties

No properties defined

Remove one or more IPs from the allow list

remove-one-or-more-ips-from-the-allow-list page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_25
const client = require('@sendgrid/client');
_25
client.setApiKey(process.env.SENDGRID_API_KEY);
_25
_25
const data = {
_25
"ids": [
_25
1,
_25
2,
_25
3
_25
]
_25
};
_25
_25
const request = {
_25
url: `/v3/access_settings/whitelist`,
_25
method: 'DELETE',
_25
body: data
_25
}
_25
_25
client.request(request)
_25
.then(([response, body]) => {
_25
console.log(response.statusCode);
_25
console.log(response.body);
_25
})
_25
.catch(error => {
_25
console.error(error);
_25
});


Rate this page: