Skip to main content
GET
/
account
/
ippool
List IPPools
curl --request GET \
  --url https://api.sendpost.io/api/v1/account/ippool \
  --header 'X-Account-ApiKey: <api-key>'
[
  {
    "id": 746,
    "name": "Transactional",
    "created": 1597511124804000,
    "ips": [
      {
        "id": 6,
        "publicIP": "3.238.19.86",
        "reverseDNSHostname": "sp0006.mtaspb.email",
        "type": 1,
        "created": 1597511124804000
      }
    ],
    "thirdPartySendingProviders": [
      {
        "id": 2,
        "name": "mailgun",
        "type": 2,
        "domain": "your_domain",
        "endpoint": "https://api.mailgun.net/v3",
        "key": "your_public_key",
        "secret": "your_private_key",
        "port": 0,
        "oauthToken": "",
        "retryTime": 0,
        "created": 1597511124704000
      }
    ],
    "routingStrategy": 0,
    "routingMetaData": "{}",
    "autoWarmupEnabled": false,
    "infraMonitor": true,
    "ipDomainWarmupStatus": null
  }
]

Authorizations

​
X-Account-ApiKey
string
header
required

This api key can be used for all account level operations

Query Parameters

​
limit
integer

Number of records to return per request

Example:

10

​
offset
integer

Number of initial records to skip

Example:

0

​
search
string

Case insensitive search against IPPool name

Example:

"Transactional"

Response

A list of IPPools

​
id
integer
Example:

746

​
name
string
Example:

"Transactional"

​
created
integer
Example:

1597511124804000

​
ips
object[]
​
thirdPartySendingProviders
object[]
​
routingStrategy
integer
Example:

0

​
routingMetaData
string
Example:

"{}"

​
autoWarmupEnabled
boolean
Example:

false

​
infraMonitor
boolean
Example:

true

​
ipDomainWarmupStatus
string | null
Example:

null

​
shouldOverflow
boolean

Indicates whether the IP should overflow, once email capacity of the IP Pool has been reached, should we send remaining emails over shared IP or not

Example:

true

​
overflowPoolName
string

The name of the overflow pool

Example:

"Transactional"

​
warmupInterval
integer

The interval for the warmup

Example:

60