Menu

Expand
Rate this page:

IP Address Management API

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.

GET all IP Pools that have Associated IPs

The IP Address Management API is in 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/pools

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

This operation returns a list of your IP Pools and a sample of each Pools' associated IP addresses.

A maximum of 10 IPs will be returned per IP Pool by default. To retrieve additional IP addresses associated with a Pool, use the "Get IPs Assigned to an IP Pool" operation. Each user may have a maximum of 100 IP Pools.

Query String

limit
integer

Specifies the number of results to be returned by the API. This parameter can be used in combination with the before_key or after_key parameters to iterate through paginated results.

default: None
after_key
integer

Specifies which items to be returned by the API. When the after_key is specified, the API will return items beginning from the first item after the item specified. This parameter can be used in combination with limit to iterate through paginated results.

default: None
ip
string

Specifices an IP address. The ip query parameter can be used to filter results by IP address.

default: None

Responses

object
result
array[object]
name
string

The name of the IP Pool.

id
string

The unique ID of the IP Pool.

ips_preview
array[string]

A sample list of IP addresses associated with the IP Pool. The sample is limited to 10 results.

maxItems: 10
total_ip_count
integer

The total number of IP addresses in the IP Pool. An IP Pool can have a maximum of 100 associated IP addresses.

_metadata
object
next_params
object

A collection of fields that can be used to work the endpoint.

after_key
string or null

Specifies which items to be returned by the API. When the after_key is specified, the API will return items beginning from the first item after the item specified. This parameter can be used in combination with limit to iterate through paginated results. The after_key cannot be used in combination with the before_key parameter.

ip
string

The IP address specified in the request. This parameter will be returned only if it was specified in the request.

limit
string

The limit specified in the request. This parameter will be included only if it was specified in the request. This is not the default limit enforced by the API.

object

IP Address Management Error Response Schema

errors
array[object]

An array of error objects.

field
string

Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error.

message
string

An error-specific message that provides more information about the error's cause.

object

IP Address Management Error Response Schema

errors
array[object]

An array of error objects.

field
string

Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error.

message
string

An error-specific message that provides more information about the error's cause.

object

IP Address Management Error Response Schema

errors
array[object]

An array of error objects.

field
string

Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error.

message
string

An error-specific message that provides more information about the error's cause.

        
        
        
        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.

              
              
              

              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