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

Get Details for an IP Address



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.

(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/ips/{ip}

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

This operation returns details for a specified IP address. Details include whether the IP is assigned to a parent account, set to warm up automatically, which Pools the IP is associated with, when the IP was added and modified, whether the IP is leased, and whether the IP is enabled. Note that this operation will not return Subuser information associated with the IP. To retrieve Subuser information, use the "Get a List of Subusers Assigned to an IP" endpoint.


Authentication

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

The ip path parameter specifies an IP address to make the request against.

Property nameTypeRequiredDescription
include_regionbooleanOptional

Boolean indicating whether or not to return the IP Pool's region information in the response. (Regional email is in Public Beta and requires SendGrid Pro plan or above.)

Default: false
200400401500

OK

SchemaExample
Property nameTypeRequiredDescriptionChild properties
ipstring

The IP address specified in the request.


is_parent_assignedboolean

Indicates if a parent on the account is able to send email from the IP address.


is_auto_warmupboolean

Indicates if the IP address is set to automatically warmup.


poolsarray[object]

An array of IP Pools the IP address is assigned to.


added_atinteger

A timestamp indicating when the IP address was added to your account.


updated_atinteger or null

A timestamp indicating when the IP was last updated.


is_enabledboolean or null

Indicates if the IP address is billed and able to send email. This parameter applies to non-Twilio SendGrid APIs that been added to your Twilio SendGrid account. This parameter's value is null for Twilio SendGrid IP addresses.


is_leasedboolean

Indicates whether an IP address is leased from Twilio SendGrid. If false, the IP address is not a Twilio SendGrid IP; it is a customer's own IP that has been added to their Twilio SendGrid account.


regionstring

The region to which the IP address is assigned. This property will only be returned if the include_region query parameter is included and set to true as part of the API request. Possible values are us or eu.

Get Details for an IP Address

get-details-for-an-ip-address page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

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


Rate this page: