Skip to contentSkip to navigationSkip to topbar
On this page

Retrieve a specific allowed IP



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.


GET/v3/access_settings/whitelist/{rule_id}

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 retreive a specific IP address that has been allowed to access your account.

You must include the ID for the specific IP address you want to retrieve in your call. You can retrieve the IDs associated with your allowed IP addresses 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.

Property nameTypeRequiredDescription
rule_idstring
required

The ID of the allowed IP address that you want to retrieve.

200
SchemaExample
Property nameTypeRequiredDescriptionChild properties
resultarray[object]

Optional

An array listing one or more of your allowed IPs.

Retrieve a specific allowed IPLink to code sample: Retrieve a specific allowed IP
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const rule_id = "rule_id";
5
6
const request = {
7
url: `/v3/access_settings/whitelist/${rule_id}`,
8
method: "GET",
9
};
10
11
client
12
.request(request)
13
.then(([response, body]) => {
14
console.log(response.statusCode);
15
console.log(response.body);
16
})
17
.catch((error) => {
18
console.error(error);
19
});