Skip to contentSkip to navigationSkip to topbar
On this page

Retrieve all the IPs in a specified pool



API Overview

api-overview page anchor

IP pools allow you to group your dedicated SendGrid IP addresses. For example, you could create separate one pool for your transactional email and another for your marketing email. When sending marketing emails, specify that you want to use the marketing IP pool. This allows you to maintain separate reputations for your different email traffic.

A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is determined by the aggregate performance of all email traffic sent from it.

IP pools can only be used with IP addresses for which you've set up a reverse DNS record.

If an IP pool is not specified for an email, it will use any IP available, including pooled addresses.

Each user can create up to 100 different IP pools.


GET/v3/ips/pools/{pool_name}

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 get all of the IP addresses that are in a specific IP pool.


Authentication

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

The name of the IP pool that you want to retrieve the IP addresses for.

200404
SchemaExample
Property nameTypeRequiredDescriptionChild properties
pool_namestring

The name of the IP pool.

Max length: 64

ipsarray[string]

The IP addresses that belong to this pool.

Retrieve all the IPs in a specified poolLink to code sample: Retrieve all the IPs in a specified pool
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const pool_name = "per";
5
6
const request = {
7
url: `/v3/ips/pools/${pool_name}`,
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
});