ドメイン管理機能

DKIMドメイン登録

DKIMドメイン登録

DKIMを利用するドメインを登録します。

メソッドとURL

メソッド URL
POST https://{HOST名}/domain/dkim

リクエスト

ボディパラメーター

JSON形式で設定します。

項目 型 必須 説明
domains Object Array ◯ オブジェクトのリスト。配列で複数のドメインを同時に指定が可能。
 詳細説明は以下をご参照ください。
domains(DKIMドメイン)
sign_domain String ◯ 認証の対象となるドメイン。
selector String DKIM設定で一意となるラベル。省略が可能。
key_len Number 鍵を生成する際の長さ。1024と2048が指定可能(単位:bit)。省略時は「1024bit」。
start_date String 対象のセレクタの設定を有効とする日。省略時は、登録日から有効。
default Number 登録したセレクタ&ドメインの組み合わせを第三者署名で利用する指定。省略時は「OFF(0)」
enable Boolean 登録したセレクタ＆ドメインの組み合わせを、有効・無効とする指定。省略時は「有効(true)」。

レスポンス

ステータスコード

コード メッセージ 説明
200 OK リクエスト受付、正常終了。
400 Bad Request 構文不正。フォーマットやパラメーターの不正。
500 Internal Server Error 想定外のエラー。
しばらく経ってから再度実施し、状況が改善しなければ、弊社までお問い合わせください。

上記以外のステータスコードが返却される場合もあります。
その場合は、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。

関連記事HTTPレスポンスステータスコード一覧

ボディーパラメーター

項目 型 説明
items Object Array レスポンス情報が設定されます。
result Object 一つのドメインの処理結果。
code String 処理結果のコード。
message String 処理結果に対する補足メッセージ。
sign_domain String 対象のドメイン。
selector String dkim情報を識別するためのセレクタ。
key_len Number 鍵生成時のキー長。
start_date String 対象セレクタの利用開始日時。
default Number 第三者署名として利用可能とする指定。
enable Boolean 対象セレクタの利用有効フラグ。
setting_values Object DNSにDKIM情報を設定する際に利用するデータ。
 詳細説明は以下をご参照ください。
setting_values(DKIMドメイン登録)
fqdn String 作成した公開鍵を登録するFQDN。
type String レコードタイプ。
value String 作成した公開鍵のデータ。オプションなども含めた文字列。
regist_date String 登録日時。
count Number itemsの設定された個数が設定されます。
total Number 返却できないデータも含めた検索結果数が設定されます。

リザルトコード

各登録処理で返却されるリザルトコードは、以下の通りです。

コード 説明
201 登録完了。
400 構文不正。フォーマットやパラメーターの不正。
409 sign_domainとselectorの組み合わせが登録済み。ユーザー自身で登録した内容であれば、レスポンスで登録済みのデータが参照できます。
500 しばらく経ってから再実施頂き、状況が改善しなければ、弊社までお問い合わせください。

サンプル

リクエスト

{
  "domains": [
    {
      "sign_domain": "example.com",
      "key_len": 1024,
      "start_date": "2021-07-01T00:00+09:00"
    },
    {...},
    {...}
  ]
}

レスポンス

正常

{
  "items": [
    {
      "result": {
          "code": "201",
          "message": "created"
      },
      "sign_domain": "example.com",
      "selector": "sample0001",
      "key_len": 1024,
      "start_date": "2021-07-01T00:00+09:00",
      "default": 0,
      "enable": true,
      "setting_values": {
        "fqdn": "sample0001._domainkey.example.com",
        "type": "TXT",
        "value": "v=DKIM1; g=*; k=rsa; p=MIGfMA0GCSqGSIb3...<省略>"
      },
      "regist_date": "2021-07-01T00:00:00+09:00"
    },
    {...},
    {...}
  ],
  "count": 3,
  "total": 3
}

エラー

{
 "message": "Internal Server Error"
}

補足情報が返却されます。