List all IP addresses you have under your account, and retrieve details about those IP addresses.
View all IPs under your account.
URI Parameter
Required
Requirements
Description
task
Yes
Must be set to all
Retrieve all IPs available for your account.
ip
No
Can be a complete or partial IP address.
Filter your search results.
system
No
Must be set to true
Include IPs assigned by SendGrid.
JSON
XML
POST
https://api.sendgrid.com/apiv2/reseller.ip.json
POST Data
api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=all
[
{
"ip": "255.255.255.250"
},
{
"ip": "255.255.255.251"
},
{
"ip": "255.255.255.251"
},
{
"ip": "255.255.255.252"
},
{
"ip": "255.255.255.253"
},
{
"ip": "255.255.255.254"
}
]
POST
https://api.sendgrid.com/apiv2/reseller.ip.xml
POST Data
api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=all
<ips>
<ip>255.255.255.0</ip>
<ip>255.255.254.0</ip>
<ip>255.255.253.0</ip>
<ip>255.255.252.0</ip>
</ips>
A listing of all free IPs under your account. A Free IP is any IP that is either not in use by a user or not linked to an IP grouping.
URI Parameter
Required
Requirements
Description
task
Yes
Must be set to free
Retrieve all free IPs for your account.
ip
No
Can be a complete or partial IP address.
Filter your search results.
JSON
XML
POST
https://api.sendgrid.com/apiv2/reseller.ip.json
POST Data
api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=free
[
{
"ip": "255.255.255.250"
},
{
"ip": "255.255.255.251"
},
{
"ip": "255.255.255.251"
},
{
"ip": "255.255.255.252"
},
{
"ip": "255.255.255.253"
},
{
"ip": "255.255.255.254"
}
]
POST
https://api.sendgrid.com/apiv2/reseller.ip.xml
POST Data
api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=free
<ips>
<ip>255.255.255.0</ip>
<ip>255.255.254.0</ip>
<ip>255.255.253.0</ip>
<ip>255.255.252.0</ip>
</ips>
A listing of all taken IPs under your account. A Taken IP is any IP that is either in use by a user or linked to an IP grouping.
URI Parameter
Required
Requirements
Description
task
Yes
Must be set to taken
Retrieve all taken IPs for your account.
ip
No
Can be a complete or partial IP address.
Filter your search results.
JSON
XML
POST
https://api.sendgrid.com/apiv2/reseller.ip.json
POST Data
api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=taken
[
{
"ip": "255.255.255.250"
},
{
"ip": "255.255.255.251"
},
{
"ip": "255.255.255.251"
},
{
"ip": "255.255.255.252"
},
{
"ip": "255.255.255.253"
},
{
"ip": "255.255.255.254"
}
]
POST
https://api.sendgrid.com/apiv2/reseller.ip.xml
POST Data
api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=taken
<ips>
<ip>255.255.255.0</ip>
<ip>255.255.254.0</ip>
<ip>255.255.253.0</ip>
<ip>255.255.252.0</ip>
</ips>
A listing of all available IPs under your account. An Available IP is any IP in one of three states: currently free, not linked to an IP grouping, or in use by an inactive user.
URI Parameter
Required
Requirements
Description
task
Yes
Must be set to available
Retrieve all available IPs for your account.
ip
No
Can be a complete or partial IP address.
Filter your search results.
JSON
XML
POST
https://api.sendgrid.com/apiv2/reseller.ip.json
POST Data
api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=available
[
{
"ip": "255.255.255.250"
},
{
"ip": "255.255.255.251"
},
{
"ip": "255.255.255.251"
},
{
"ip": "255.255.255.252"
},
{
"ip": "255.255.255.253"
},
{
"ip": "255.255.255.254"
}
]
POST
https://api.sendgrid.com/apiv2/reseller.ip.xml
POST Data
api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=available
<ips>
<ip>255.255.255.0</ip>
<ip>255.255.254.0</ip>
<ip>255.255.253.0</ip>
<ip>255.255.252.0</ip>
</ips>
The current breakdown of users who are utilizing your IPs.
URI Parameter
Required
Requirements
Description
task
Yes
Must be set to usage
Retrieve all IPs in use broken down by user.
ip
No
Can be a complete or partial IP address.
Filter your search results.
user
No
Can be a complete or partial username.
Filter your search results.
group
No
Can be a complete or partial group name.
Filter your search results.
system
No
Must be set to true
Include IPs assigned by SendGrid.
JSON
XML
POST
https://api.sendgrid.com/apiv2/reseller.ip.json
POST Data
api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=usage&user=example.com
[
{
"ip": "255.255.253.0",
"user": "example@example.com"
},
{
"ip": "255.255.254.0",
"user": "example@example.com"
}
]
POST
https://api.sendgrid.com/apiv2/reseller.ip.xml
POST Data
api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=usage&user=example.com
<ips>
<entry>
<ip>255.255.253.0</ip>
<user>example@example.com</user>
</entry>
<entry>
<ip>255.255.254.0</ip>
<user>example@example.com</user>
</entry>
</ips>