On this page

Get Details for an IP Pool

API Overview

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

Regional Email sending in the European Union (EU) is GA for Twilio SendGrid Pro plan or above. Learn More

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

Operation overview

GET/v3/send_ips/pools/{poolid}

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

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

This operation will return the details for a specified IP Pool, including the Pool's name, ID, a sample list of the IPs associated with the Pool, and the total number of IPs belonging to the Pool.

A maximum of 10 IPs will be returned per IP Pool by default. To retrieve additional IP addresses associated with a Pool, use the "Get IPs Assigned to an IP Pool" operation.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

poolidstringrequired

Specifies the unique ID for an IP Pool.

Query string

Property nameTypeRequiredDescription

include_regionbooleanOptional

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

Default: false

Responses

200400401500

SchemaExample

Property nameTypeRequiredDescriptionChild properties

namestring

The name of the IP Pool.

idstring

The unique ID of the IP Pool.

ips_previewarray[string]

A sample list of IP addresses associated with the IP Pool. The sample is limited to 10 results.

total_ip_countinteger

The total number of IP addresses in the IP Pool. An IP Pool can have a maximum of 100 associated IP addresses.

ip_count_by_regionarray[object]

The total number of IP addresses by region. this object is only returned if the include_region parameter is included and set to true in the API request.

Show child properties for ip_count_by_region

Bad Request

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

An array of error objects.

Show child properties for errors

Unauthorized

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

An array of error objects.

Show child properties for errors

Internal Server Error

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

An array of error objects.

Show child properties for errors

Get Details for an IP Pool

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const poolid = "ZGkrHSypTsudrGkmdpJJ";
5
6const request = {
7  url: `/v3/send_ips/pools/${poolid}`,
8  method: 'GET',
9  
10}
11
12client.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  });