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 Details for an IP Pool
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/pools/{poolid}
Base url: https://api.sendgrid.com
This operation will return the details for a specified IP Pool, including the Pool's name, ID, a sample list of the IPs associated with the Pool, and the total number of IPs belonging to the Pool.
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.
Path Parameters
Specifies the unique ID for an IP Pool.
default: NoneQuery String
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: FalseResponses
The name of the IP Pool.
The unique ID of the IP Pool.
A sample list of IP addresses associated with the IP Pool. The sample is limited to 10 results.
The total number of IP addresses in the IP Pool. An IP Pool can have a maximum of 100 associated IP addresses.
The region of the IP Pool. This is only returned if include_region is set to True in the API request.
IP Address Management Error Response Schema
An array of error objects.
Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error.
An error-specific message that provides more information about the error's cause.
IP Address Management Error Response Schema
An array of error objects.
Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error.
An error-specific message that provides more information about the error's cause.
IP Address Management Error Response Schema
An array of error objects.
Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error.
An error-specific message that provides more information about the error's cause.
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.
