Menu

IP Address

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

Retrieve all IP addresses

Retrieve all IP addresses

GET /ips

This endpoint allows you to retrieve a list of all assigned and unassigned IPs.

Response includes warm up status, pools, assigned subusers, and reverse DNS info. The start_date field corresponds to when warmup started for that IP.

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.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Query String

ip
string

The IP address to get

default: None
exclude_whitelabels
boolean

Should we exclude reverse DNS records (whitelabels)?

default: None
limit
integer

The number of results to return.

default: None
offset
integer

The point in the list to begin retrieving results.

default: None
subuser
string

The subuser you are requesting for.

default: None
sort_by_direction
string

The direction to sort the results.

default: None

Responses

array[object]
ip
string

An IP address.

subusers
array[string]

The subusers that are able to send email from this IP.

rdns
string

The reverse DNS record for this IP address.

pools
array[string]

The IP pools that this IP has been added to.

warmup
boolean

Indicates if this IP address is currently warming up.

start_date
number or null

The date that the IP address was entered into warmup.

whitelabeled
boolean

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

assigned_at
integer or null

The date that the IP address was assigned to the user.

Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more