Skip to contentSkip to navigationSkip to topbar
On this page

Retrieve the warmup status for a specific IP address



API Overview

api-overview page anchor

IP warming is the practice of gradually increasing the volume of mail sent with a dedicated IP address according to a predetermined schedule. This gradual process helps to establish a reputation with ISPs (Internet Service Providers) as a legitimate email sender.

SendGrid can automatically warm up dedicated IP addresses by limiting the amount of mail that can be sent through them per hour. The limit determined by how long the IP address has been warming up.

See the warmup schedule to learn how SendGrid limits your email traffic for IPs in warmup.

You can also choose to use Twilio SendGrid's automated IP warmup for any of your IPs from the "IP Addresses" settings menu in the Twilio SendGrid App(link takes you to an external page).


GET/v3/ips/warmup/{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 retrieve the warmup status for a specific IP address.

You can retrieve all of your warming IPs using the "Retrieve all IPs currently in warmup" endpoint.


Authentication

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

The IP address that you want to retrieve the warmup status for.

200404
SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties
ipstring

The IP address.


start_dateinteger

A Unix timestamp indicating when the IP address entered warmup mode.

Retrieve the warmup status for a specific IP addressLink to code sample: Retrieve the warmup status for a specific IP address
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const ip_address = "196.215.224.146";
5
6
const request = {
7
url: `/v3/ips/warmup/${ip_address}`,
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
});