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.
Regional Email sending in the European Union (EU) is GA for Twilio SendGrid Pro plan or above. Learn More
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.
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.
Bearer <<YOUR_API_KEY_HERE>>Specifies the unique ID for an IP Pool.
Optional
Boolean indicating whether or not to return the IP Pool's region information in the response.
falseOK
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 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.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const poolid = "poolid";56const request = {7url: `/v3/send_ips/pools/${poolid}`,8method: "GET",9};1011client12.request(request)13.then(([response, body]) => {14console.log(response.statusCode);15console.log(response.body);16})17.catch((error) => {18console.error(error);19});