IPs

IP Whitelabel

IP Whitelabel設定はサブドメインとドメインから構成されます。これらは、指定されたIPアドレスのリバースDNSレコード設定に使用されます。SendGridはユーザにより作成された適切なAレコードを確認できたら、そのIPアドレスに対するリバースDNSレコードを作成します。

List all IPs [GET]

IP Whitelabel設定の一覧を取得します。検索条件が指定された場合、マッチする結果が返ります。
URI引数 必須 条件 説明
ip No string IPアドレスの前方一致検索に使用されます。 Example: 192.*
limit No integer 一度に取得する設定数
offset No integer オフセット

Request

1
GET https://api.sendgrid.com/v3/whitelabel/ips{?limit,offset,ip} HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
HTTP/1.1 200
[
  {
    "id": 1,
    "ip": "192.168.1.1",
    "rdns": "o1.email.example.com",
    "users": [
      {
        "username": "john@example.com",
        "user_id": 7
      },
      {
        "username": "jane@example.com",
        "user_id": 8
      }
    ],
    "subdomain": "email",
    "domain": "example.com",
    "valid": true,
    "legacy": false,
    "a_record": {
      "valid": true,
      "type": "a",
      "host": "o1.email.example.com",
      "data": "192.168.1.1"
    }
  },
  {
    "id": 2,
    "ip": "192.168.1.2",
    "rdns": "o2.email.example.com",
    "users": [
      {
        "username": "john@example.com",
        "user_id": 7
      },
      {
        "username": "jane@example2.com",
        "user_id": 9
      }
    ],
    "subdomain": "email",
    "domain": "example.com",
    "valid": true,
    "legacy": false,
    "a_record": {
      "valid": true,
      "type": "a",
      "host": "o2.email.example.com",
      "data": "192.168.1.2"
    }
  }
]

Create an IP [POST]

IP Whitelabel設定の作成
Body引数 必須 条件 説明
ip Yes string Whitelabel設定するIPアドレス.
Example: 192.168.1.1
domain Yes string このIPアドレスを使用してメール送信するドメイン.
Example: example.com
subdomain Yes string このIPアドレスを使用してメール送信するサブドメイン.
Example: email

Request

1
POST https://api.sendgrid.com/v3/whitelabel/ips HTTP/1.1
Request Body
1
2
3
4
5
{
  "ip": "192.168.1.1",
  "subdomain": "email",
  "domain": "example.com"
}

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
HTTP/1.1 201
{
  "id": 123,
  "ip": "192.168.1.2",
  "rdns": "o1.email.example.com",
  "users": [

  ],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.2"
  }
}

Retrieve an IP [GET]

IP Whitelabel設定の取得

Request

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

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
HTTP/1.1 200
{
  "ip": "192.168.1.1",
  "rdns": "o1.email.example.com",
  "users": [
    {
      "username": "john@example.com",
      "user_id": 7
    }
  ],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.1"
  }
}

Delete an IP [DELETE]

IP Whitelabel設定の削除

Request

1
DELETE https://api.sendgrid.com/v3/whitelabel/ips/{id} HTTP/1.1

Response

1
HTTP/1.1 204

Validate an IP [POST]

IP Whitelabel設定の確認

Request

1
POST https://api.sendgrid.com/v3/whitelabel/ips/{id}/validate HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
HTTP/1.1 200
{
  "id": 1,
  "valid": true,
  "validation_results": {
    "a_record": {
      "valid": true,
      "reason": null
    }
  }
}

Request

1
POST https://api.sendgrid.com/v3/whitelabel/ips/{id}/validate HTTP/1.1

Response

1
2
3
4
5
6
7
8
HTTP/1.1 500
{
  "errors": [
    {
      "message": "internal error getting rDNS"
    }
  ]
}