On this page

Retrieve all IP pools an IP address belongs to

API Overview

Elements that can be shared among more than one endpoint definition.

Operation overview

GET/v3/ips/{ip_address}

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 see which IP pools a particular IP address has been added to.

The same IP address can be added to multiple IP pools.

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 based on the aggregate performance of all the senders who use it.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

ip_addressstringrequired

The IP address you are retrieving the IP pools for.

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

ipstring

The IP address.

subusersarray[string]

The subusers that can send email using this IP address.

rdnsstring

The reverse DNS record for this IP address.

poolsarray[string]

The list of IP pools that this IP address belongs to.

warmupboolean

Indicates if this IP address is currently warming up.

start_dateinteger or null

The date that the IP address was entered into warmup.

whitelabeledboolean

Indicates if this IP address is associated with a reverse DNS record.

Retrieve all IP pools an IP address belongs to

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