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 all IP Pools that have Associated IPs
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
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.
Query String
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.
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.
Specifices an IP address. The ip query parameter can be used to filter results by IP address.
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. (Regional email is in Public Beta and requires SendGrid Pro plan or above.)
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.)
default: FalseResponses
The name of the IP Pool.
The unique ID of the IP Pool.
The region of the IP Pool. This is only returned if include_region is set to True in the API request.
A sample list of IP addresses associated with the IP Pool. The sample is limited to 10 results.
maxItems: 10The total number of IP addresses in the IP Pool. An IP Pool can have a maximum of 100 associated IP addresses.
A collection of fields that can be used to work the endpoint.
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. The after_key cannot be used in combination with the before_key parameter.
The IP address specified in the request. This parameter will be returned only if it was specified in the request.
The limit specified in the request. This parameter will be included only if it was specified in the request. This is not the default limit enforced by the API.
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.
