Skip to contentSkip to navigationSkip to topbar
On this page

Get IPs Assigned to an IP Pool



API Overview

api-overview page anchor

The IP Address Management API combines functionality that was previously split between the Twilio SendGrid IP Address API and IP Pools API. This functionality includes adding IP addresses to your account, assigning IP addresses to IP Pools and Subusers, among other tasks. More details about each operation can be found in the descriptions and schemas for each endpoint.

(information)

Info

(warning)

Warning

The IP Address Management API is in public beta at this time. This means the API and documentation are still in development and subject to change without advanced notice.


GET/v3/send_ips/pools/{poolid}/ips

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

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

This operation returns the IP addresses that are assigned to the specified IP pool.


Authentication

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

Specifies the unique ID for an IP Pool.

Property nameTypeRequiredDescription
limitintegerOptional

Specifies the number of results to be returned by the API. This parameter can be used in combination with the before_key or after_key parameters to iterate through paginated results.


after_keyintegerOptional

Specifies which items to be returned by the API. When the after_key is specified, the API will return items beginning from the first item after the item specified. This parameter can be used in combination with limit to iterate through paginated results.


include_regionbooleanOptional

Boolean indicating whether or not to return the IP Pool's region information in the response.

Default: false
200400401500

OK

SchemaExample
Property nameTypeRequiredDescriptionChild properties
resultarray[object]

_metadataobject
Get IPs Assigned to an IP PoolLink to code sample: Get IPs Assigned to an IP Pool
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const poolid = "ZGkrHSypTsudrGkmdpJJ";
5
6
const request = {
7
url: `/v3/send_ips/pools/${poolid}/ips`,
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
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.