POST
IPプールにIPアドレスを追加します。
一つのIPアドレスは複数のIPプールに所属することができます。IPプールへの追加リクエスト送信後、実際にIPプールに追加されるまで60秒程度の時間がかかります。
| URI引数 |
必須 |
条件 |
説明 |
| ip |
Yes |
有効なIPアドレス |
IPプールに追加するIPアドレス |
Request
1
| POST https://api.sendgrid.com/v3/ips/pools/{pool_name}/ips HTTP/1.1
|
Request Body
1
2
3
| {
"ip": "0.0.0.0"
}
|
Response
1
2
3
4
5
6
7
8
9
10
| HTTP/1.1 201 OK
{
"ip": "000.00.00.0",
"pools": [
"test1"
],
"start_date": 1409616000,
"warmup": true
}
|
GET
割り当て済みか否かに関わらず全てのIPアドレスのリストを取得します。応答にはウォームアップ状態、IPプール、割り当てられたサブユーザ、Whitelabel情報などが含まれます。start_dateはウォームアップを開始した日時を表します。
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
割り当て済み IPアドレスを取得します。
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
指定したIPアドレスが所属しているIPプールを取得します。
Request
1
| GET https://api.sendgrid.com/v3/ips/0.0.0.0 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
}
|
DELETE
IPプールからIPアドレスを削除します。
Request
1
| DELETE https://api.sendgrid.com/v3/ips/pools/:pool_name/ips/:ip HTTP/1.1
|
Response
1
| HTTP/1.1 204 NO CONTENT (OK)
|