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.
Operation overview
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.
Operation details
Authentication
Headers
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Path parameters
Property nameTypeRequiredDescription
poolidstringrequired
Specifies the unique ID for an IP Pool.
Query string
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.)
A sample list of IP addresses associated with the IP Pool. The sample is limited to 10 results.
total_ip_countinteger
The total number of IP addresses in the IP Pool. An IP Pool can have a maximum of 100 associated IP addresses.
ip_count_by_regionarray[object]
The total number of IP addresses by region. this object is only returned if the include_region parameter is included and set to true in the API request.