On this page

Add one or more IPs to the allow list

API Overview

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 a limit of 1000 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.

Operation overview

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.

Operation details

Authentication

API Key

Headers

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.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

ipsarray[object]required

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

Show child properties for ips

Responses

201401403404500

SchemaExample

Property nameTypeRequiredDescriptionChild properties

resultarray[object]

An array listing one or more of your allowed IPs.

Show child properties for result

Add one or more IPs to the allow list

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const 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
18const request = {
19  url: `/v3/access_settings/whitelist`,
20  method: "POST",
21  body: data,
22};
23
24client
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  });