Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Retrieve all reverse DNS records



API Overview

api-overview page anchor

Reverse DNS (formerly IP Whitelabel) allows mailbox providers to verify the sender of an email by performing a reverse DNS lookup upon receipt of the emails you send.

Reverse DNS is available for dedicated IP addresses only.

When setting up reverse DNS, Twilio SendGrid will provide an A Record (address record) for you to add to your DNS records. The A Record maps your sending domain to a dedicated Twilio SendGrid IP address.

A Reverse DNS consists of a subdomain and domain that will be used to generate a reverse DNS record for a given IP address. Once Twilio SendGrid has verified that the appropriate A record for the IP address has been created, the appropriate reverse DNS record for the IP address is generated.

You can also manage your reverse DNS settings in the Sender Authentication setion of the Twilio SendGrid App(link takes you to an external page).

For more about Reverse DNS, see "How to set up reverse DNS" in the Twilio SendGrid documentation.


GET/v3/whitelabel/ips

Base url: https://api.sendgrid.com

This endpoint allows you to retrieve a paginated list of all the Reverse DNS records created by this account.

You may include a search key by using the ip query string parameter. This enables you to perform a prefix search for a given IP segment (e.g., ?ip="192.").

You can use the limit query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the offset query parameter to control the position in the list from which to start retrieving additional items.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

limitinteger

limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used.


offsetinteger

The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list.

Minimum: 0Default: 0

ipstring

The IP address segment that you'd like to use in a prefix search.

200
SchemaExample

Array of:

idinteger

The ID of the Reverse DNS.


ipstring

The IP address that this Reverse DNS was created for.


rdnsstring

The reverse DNS record for the IP address. This points to the Reverse DNS subdomain.


usersarray[object]

The users who are able to send mail from the IP address.


subdomainstring

The subdomain created for this reverse DNS. This is where the rDNS record points.


domainstring

The root, or sending, domain.


validboolean

Indicates if this is a valid Reverse DNS.


legacyboolean

Indicates if this Reverse DNS was created using the legacy whitelabel tool. If it is a legacy whitelabel, it will still function, but you'll need to create a new Reverse DNS if you need to update it.


last_validation_attempt_atinteger

A Unix epoch timestamp representing the last time of a validation attempt.


a_recordobject

Retrieving paginated results

retrieving-paginated-results page anchor

To perform a request for the first page of the paginated list of all reverse DNS records using the default page size, you can omit the limit and offset query parameters:

Retrieve first page from list of all reverse DNS records

retrieve-first-page-from-list-of-all-reverse-dns-records page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_18
const client = require('@sendgrid/client');
_18
client.setApiKey(process.env.SENDGRID_API_KEY);
_18
_18
_18
const request = {
_18
url: `/v3/whitelabel/ips`,
_18
method: 'GET',
_18
_18
}
_18
_18
client.request(request)
_18
.then(([response, body]) => {
_18
console.log(response.statusCode);
_18
console.log(response.body);
_18
})
_18
.catch(error => {
_18
console.error(error);
_18
});

If you want to specify a page size of your choice, you can use the limit query parameter. Assume you want a page size of no more than 5 items per request, to retrieve the first page you can use the limit parameter without specifying an offset:

Retrieve first page from list of all reverse DNS records with a specified page size

retrieve-first-page-from-list-of-all-reverse-dns-records-with-a-specified-page-size page anchor

Setting page size to 5 using the limit query parameter

Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_21
const client = require('@sendgrid/client');
_21
client.setApiKey(process.env.SENDGRID_API_KEY);
_21
_21
const queryParams = {
_21
"limit": 5
_21
};
_21
_21
const request = {
_21
url: `/v3/whitelabel/ips`,
_21
method: 'GET',
_21
qs: queryParams
_21
}
_21
_21
client.request(request)
_21
.then(([response, body]) => {
_21
console.log(response.statusCode);
_21
console.log(response.body);
_21
})
_21
.catch(error => {
_21
console.error(error);
_21
});

If you want to retrieve items beyond the first page, you can use the offset parameter as follows. Assume you are still working with a page size of 5 as determined by your limit query parameter and you have more than 15 items. To request the fourth page of items, you can use the offset parameter to skip over the first 15 items, i.e. you start retrieving items starting after the first three pages of 5 items each:

Retrieve a specific page from the list of all reverse DNS records

retrieve-a-specific-page-from-the-list-of-all-reverse-dns-records page anchor

Using the offset query parameter in combination with the limit query parameter

Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const queryParams = {
_22
"limit": 5,
_22
"offset": 15
_22
};
_22
_22
const request = {
_22
url: `/v3/whitelabel/ips`,
_22
method: 'GET',
_22
qs: queryParams
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
console.error(error);
_22
});


Rate this page: