List IPPools

curl --request GET \
  --url https://api.sendpost.io/api/v1/account/ippool \
  --header 'X-Account-ApiKey: <api-key>'

const options = {method: 'GET', headers: {'X-Account-ApiKey': '<api-key>'}};

fetch('https://api.sendpost.io/api/v1/account/ippool', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sendpost.io/api/v1/account/ippool",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Account-ApiKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sendpost.io/api/v1/account/ippool"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Account-ApiKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sendpost.io/api/v1/account/ippool")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Account-ApiKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "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
  }
]

GET

account

ippool

List IPPools

curl --request GET \
  --url https://api.sendpost.io/api/v1/account/ippool \
  --header 'X-Account-ApiKey: <api-key>'

const options = {method: 'GET', headers: {'X-Account-ApiKey': '<api-key>'}};

fetch('https://api.sendpost.io/api/v1/account/ippool', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sendpost.io/api/v1/account/ippool",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Account-ApiKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sendpost.io/api/v1/account/ippool"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Account-ApiKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sendpost.io/api/v1/account/ippool")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Account-ApiKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "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

string

Case insensitive search against IPPool name

Example:

"Transactional"

Response

A list of IPPools

integer

Example:

746

name

string

Example:

"Transactional"

created

integer

Example:

1597511124804000

ips

object[]

Show child attributes

thirdPartySendingProviders

object[]

Show child attributes

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

API Reference

Email

Domain

Stats

Suppression

IP

Message

IPPools

Stats (A)

Sub-Account

Webhook

List IPPools

Authorizations

Query Parameters

Response