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 Address
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/ips/{ip}
Base url: https://api.sendgrid.com
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.
Path Parameters
The ip path parameter specifies an IP address to make the request against.
Query String
Boolean indicating whether or not to return region info in the response.
default: FalseResponses
The IP address specified in the request.
Indicates if a parent on the account is able to send email from the IP address. This parameter is returned only if the IP address is parent assigned.
Indicates if the IP address is set to automatically warmup. This parameter is returned only if the IP address is set to automatically warm up.
An array of IP Pools the IP address is assigned to.
The ID of the IP Pool.
The name of the IP Pool.
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 where the IP address is located. This is only returned if include_region is set to True in the API request. Possible values are us or eu.
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.
