Skip to main content
GET
/
account
/
ippool
/
{ippool_id}
Get IPPool
curl --request GET \
  --url https://api.sendpost.io/api/v1/account/ippool/{ippool_id} \
  --header 'X-Account-ApiKey: <api-key>'
{
  "id": 74,
  "name": "Transactional",
  "created": 1567512491586102000,
  "overflowPool": true,
  "ips": [],
  "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
    },
    {
      "id": 1,
      "name": "sendgrid",
      "type": 1,
      "domain": "",
      "endpoint": "",
      "key": "",
      "secret": "your_api_key",
      "port": 0,
      "oauthToken": "",
      "retryTime": 0,
      "created": 1597511124701000
    }
  ],
  "routingStrategy": 0,
  "routingMetaData": "{}"
}

Authorizations

​
X-Account-ApiKey
string
header
required

This api key can be used for all account level operations

Path Parameters

​
ippool_id
integer
required

The ID of the IPPool whose information you want to retrieve

Example:

74

Response

Details of a specific IPPool

​
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