Menu

Expand
Rate this page:

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 a List of Subusers Assigned to an IP

The IP Address Management API is in 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}/subusers

Base url: https://api.sendgrid.com

This operation returns a list of Subuser IDs that have been assigned the specified IP address. To retrieve more information about the returned Subusers, use the Subusers API.

You can use the after_key and limit query parameters to iterate through paginated results. The maximum limit is 100, meaning you may retrieve up to 100 Subusers per request. If the after_key in the API response is not null, there are more Subusers assigned to the IP address than those returned in the request. You can repeat the request with the non-null after_key value and the same limit to retrieve the next group of Subusers.

Path Parameters

ip
string

The ip path parameter specifies an IP address to make the request against.

default: None
required

Query String

after_key
integer

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.

default: None
limit
integer

Specifies the number of results to be returned by the API. This parameter can be used in combination with the after_key parameters to iterate through paginated results. The maximum limit is 100.

default: None

Responses

object
result
array[string]

An array of Subuser IDs that have been assigned the specified IP address.

_metadata
object
next_params
object

A collection of fields that can be used to work the endpoint.

after_key
string or null

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.

limit
string

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.

object

IP Address Management Error Response Schema

errors
array[object]

An array of error objects.

field
string

Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error.

message
string

An error-specific message that provides more information about the error's cause.

object

IP Address Management Error Response Schema

errors
array[object]

An array of error objects.

field
string

Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error.

message
string

An error-specific message that provides more information about the error's cause.

object

IP Address Management Error Response Schema

errors
array[object]

An array of error objects.

field
string

Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error.

message
string

An error-specific message that provides more information about the error's cause.

        
        
        
        Rate this page:

        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.

              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif