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 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.


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
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.

Property nameTypeRequiredDescription
rule_idstringrequired

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

200
SchemaExample
Property nameTypeRequiredDescriptionChild properties
resultarray[object]

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 = "ZGkrHSypTsudrGkmdpJJ";
5
6
const request = {
7
url: `/v3/access_settings/whitelist/${rule_id}`,
8
method: 'GET',
9
10
}
11
12
client.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
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.