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 returns details for a specified IP address. Details include whether the IP is assigned to a parent account, set to warm up automatically, which Pools the IP is associated with, when the IP was added and modified, whether the IP is leased, and whether the IP is enabled. Note that this operation will not return Subuser information associated with the IP. To retrieve Subuser information, use the "Get a List of Subusers Assigned to an IP" endpoint.
Bearer <<YOUR_API_KEY_HERE>>The ip path parameter specifies an IP address to make the request against.
Optional
Boolean indicating whether or not to return the IP Pool's region information in the response.
falseOK
The IP address specified in the request.
Indicates if a parent on the account is able to send email from the IP address.
An array of IP Pools the IP address is assigned to.
A timestamp indicating when the IP address was added to your account.
A timestamp indicating when the IP was last updated.
Indicates if the IP address is billed and able to send email. This parameter applies to non-Twilio SendGrid APIs that been added to your Twilio SendGrid account. This parameter's value is null for Twilio SendGrid IP addresses.
Indicates whether an IP address is leased from Twilio SendGrid. If false, the IP address is not a Twilio SendGrid IP; it is a customer's own IP that has been added to their Twilio SendGrid account.
The region to which the IP address is assigned. This property will only be returned if the include_region query parameter is included and set to true as part of the API request. Possible values are us or eu.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const ip = "ZGkrHSypTsudrGkmdpJJ";56const request = {7url: `/v3/send_ips/ips/${ip}`,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});