SparkPost logodev

Sending IPs

Run in Postman
Import the SparkPost API as a Postman collection

Sending IP Object

Example

{
  "external_ip": "123.45.67.80",
  "hostname": "mta474a.sparkpostmail.com",
  "ip_pool": "default"
}

Request Body

external_ip string

Public-facing IP address of this sending IP

hostname string

Reverse DNS hostname associated with this IP

ip_pool string

IP pool this sending IP is held in

customer_provided boolean

Whether this sending IP was provided by the customer

auto_warmup_enabled boolean

Whether this sending IP will use auto warmup

auto_warmup_stage number

The sending IP's auto warmup stage between 1 and 29

Request

GET /api/v1/sending-ips/123.45.67.89

Response

{
  "results": {
    "external_ip": "123.45.67.89",
    "hostname": "mta472a.sparkpostmail.com",
    "ip_pool": "cool_kids",
    "customer_provided": false,
    "auto_warmup_enabled": true,
    "auto_warmup_stage": 5
  }
}

{
  "errors": [
    {
      "message": "external ip must be a valid IPv4 address"
    }
  ]
}

{
  "errors": [
    {
      "message": "Sending IP does not exist"
    }
  ]
}

Retrieve a Sending IP

GET/api/v1/sending-ips/{external_ip}

Parameters

external_ip string required

The external IP of the sending IP

Retrieves a specific sending IP.

Request

PUT /api/v1/sending-ips/123.45.67.89
{
  "ip_pool": "too_cool_for_pool"
}

Response

{
  "results": {
    "message": "Updated Sending IP."
  }
}

{
  "errors": [
    {
      "message": "IP Pool too_cool_for_pool does not exist."
    }
  ]
}

{
  "errors": [
    {
      "message": "auto_warmup_stage must be between 1 and 29"
    }
  ]
}

{
  "errors": [
    {
      "message": "auto_warmup_stage must be less than or equal to 5"
    }
  ]
}

{
  "errors": [
    {
      "message": "auto_warmup_enabled must be true to update auto_warmup_stage"
    }
  ]
}

{
  "errors": [
    {
      "message": "Sending IP does not exist"
    }
  ]
}

Update a Sending IP

PUT/api/v1/sending-ips/{external_ip}

Parameters

external_ip string required

The external IP of the sending IP to update

Request Body

ip_pool string

The IP pool to add this sending IP to.

auto_warmup_enabled boolean

Enable or Disable auto IP warmup on this IP.

auto_warmup_stage number

The auto warmup stage this IP should be set to. Must be less than or equal to current stage.

Updates which IP Pool holds the sending IP.

Request

GET /api/v1/sending-ips

Response

{
  "results": [
    {
      "external_ip": "123.45.67.89",
      "hostname": "mta472a.sparkpostmail.com",
      "ip_pool": "marketing",
      "customer_provided": false,
      "auto_warmup_enabled": true,
      "auto_warmup_stage": 5
    },
    {
      "external_ip": "123.45.67.80",
      "hostname": "mta474a.sparkpostmail.com",
      "ip_pool": "default",
      "customer_provided": false,
      "auto_warmup_enabled": false
    }
  ]
}

List all sending IPs

GET/api/v1/sending-ips

Returns a list of all sending IPs.