Menu

Expand
Rate this page:

IP Address

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

Retrieve all IP addresses

GET /v3/ips

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

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 determined by the aggregate performance of all email traffic sent from 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 IPs you want returned at the same time.

default: 10
offset
integer

The offset for the number of IPs that you are requesting.

default: 0
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.

required
subusers
array[string]

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

required
rdns
string

The reverse DNS record for this IP address.

pools
array[string]

The IP pools that this IP has been added to.

required
warmup
boolean

Indicates if this IP address is currently warming up.

required
start_date
number or null

The date that the IP address was entered into warmup.

required
whitelabeled
boolean

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

required
assigned_at
integer or null

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

required
Loading Code Sample...
        
        

        Retrieve all IP addresses

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

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

              Thanks for your feedback!

              thanks-feedback-gif