Skip to contentSkip to navigationSkip to topbar
On this page

Add one or more IPs to the allow list



API Overview

api-overview page anchor

IP access management allows you to control which IP addresses can access your account. You can use either the Console or the API.

Twilio SendGrid limits the number of allowed IP addresses to 1000.

(error)

Allowed IP addresses must include your IP address

The list of the allowed IP addresses doesn't include your IP address without your action. You can remove from your IP address from the list of allowed IP addresses and block your access to your account. While Twilio can restore your access, this requires thorough proof of your identity and ownership of your account.

To prevent the accidental removal of your IP address from the allowed addresses, the Console displays your IP address in the Add IP Addresses pane.

To learn more, see IP access management.


POST/v3/access_settings/whitelist

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to add one or more allowed IP addresses.

To allow one or more IP addresses, pass them to this endpoint in an array. Once an IP address is added to your allow list, it will be assigned an id that can be used to remove the address. You can retrieve the ID associated with an IP using the "Retrieve a list of currently allowed IPs" endpoint.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

Optional

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.

Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
ipsarray[object]
required

An array containing the IP(s) you want to allow.

201401403404500
SchemaExample
Property nameTypeRequiredDescriptionChild properties
resultarray[object]

Optional

An array listing one or more of your allowed IPs.

Add one or more IPs to the allow listLink to code sample: Add one or more IPs to the allow list
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const data = {
5
ips: [
6
{
7
ip: "192.168.1.1",
8
},
9
{
10
ip: "192.*.*.*",
11
},
12
{
13
ip: "192.168.1.3/32",
14
},
15
],
16
};
17
18
const request = {
19
url: `/v3/access_settings/whitelist`,
20
method: "POST",
21
body: data,
22
};
23
24
client
25
.request(request)
26
.then(([response, body]) => {
27
console.log(response.statusCode);
28
console.log(response.body);
29
})
30
.catch((error) => {
31
console.error(error);
32
});