POST


Add IP Addresses.

URI Parameter Required Requirements Description
count Yes Integer The amount of IPs to add to the account.
subuser No String Array of usernames to be assigned a send IP.

Request

1
POST https://api.sendgrid.com/v3/ips HTTP/1.1
Request Body
1
2
3
4
5
6
7
8
9
{
  "count": 2,
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "warmup": true,
  "user_can_send": true
}

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
HTTP/1.1 201 OK

{
  "ips": [
    {
      "ip": "1.2.3.4",
      "subusers": [
        "user",
        "subuser1"
      ]
    },
    {
      "ip": "1.2.3.5",
      "subusers": [
        "user",
        "subuser1"
      ]
    }
  ],
  "remaining_ips": 1,
  "warmup": true
}

GET

Get amount of IP Addresses that can still be created during a given period and the price of those IPs.

Request

1
GET https://api.sendgrid.com/v3/ips/remaining HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
HTTP/1.1 200 OK

[
  {
  "results": [
    {
      "remaining": 2,
      "period": "month",
      "price_per_ip": 30
    }
  ]

GET

See a list of all assigned and unassigned IPs. Response includes warm up status, pools, assigned subusers, and whitelabel info. The start_date field corresponds to when warmup started for that IP.

Request

1
GET https://api.sendgrid.com/v3/ips HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
HTTP/1.1 200 OK

[
  {
    "ip":"000.00.00.0",
    "warmup":true,
    "start_date":1409616000,
    "subusers": ["username1", "username2"],
    "rdns": "01.email.test.com",
    "pools": ["pool1", "pool2"]
  }
]

GET

See only assigned IPs.

Request

1
GET https://api.sendgrid.com/v3/ips/assigned HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
HTTP/1.1 200 OK

[
  {
    "ip":"167.89.21.3",
    "pools":["new_test5"],
    "warmup":true,
    "start_date":1409616000,
  }
]

GET


See which pools an IP address belongs to.

Request

1
GET https://api.sendgrid.com/v3/ips/{ip_address} HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
HTTP/1.1 200 OK 

{
  "ip": "000.00.00.0",
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "rdns": "o1.em.example.com",
  "pools": ["test1"],
  "warmup": false,
  "start_date": null,
  "whitelabeled": true
}