GET all IP Pools that have Associated IPs
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.
Info
Regional Email sending in the European Union (EU) is available for Twilio SendGrid Pro plan or above. EU Regional Email sending requires use of an EU IP address and EU subuser. Learn more about sending emails with Twilio SendGrid on EU servers.
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.
GET/v3/send_ips/pools
Base url: https://api.sendgrid.com (for global users and subusers)
Base url: https://api.eu.sendgrid.com (for EU regional subusers)
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.
Bearer <<YOUR_API_KEY_HERE>>Optional
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.
Optional
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.
Optional
Specifies an IP address. The ip query parameter can be used to filter results by IP address.
Optional
Allowed values are all, eu, and us. If you provide a specific region, results will include all pools that have at least one IP in the filtered region. If all, pools with at least one IP (regardless of region) will be returned. If the region filter is not provided, the query returns all pools, including empty ones.
alleuusOptional
Boolean indicating whether or not to return the IP Pool's region information in the response.
falseOK
Optional
Optional
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const request = {5url: `/v3/send_ips/pools`,6method: "GET",7};89client10.request(request)11.then(([response, body]) => {12console.log(response.statusCode);13console.log(response.body);14})15.catch((error) => {16console.error(error);17});
