ドメイン管理機能

DKIMドメイン更新

DKIMドメイン更新

登録済みのDKIM情報を更新します。

メソッドとURL

メソッド URL
PUT https://{HOST名}/domain/dkim/{sign_domain}/{selector}

リクエスト

URLパラメーター

項目 説明
sign_domain 対象のドメイン
selector dkim情報を識別するためのセレクタ

ボディパラメーター

JSON形式で設定します。

項目 型 必須 説明
domains Object Array ◯ 署名ドメインの情報。
start_date String ※ 対象のセレクタの設定を有効とする日。
default Number ※ 対象のセレクタを第三者署名で利用する指定。
enable Boolean ※ 対象のセレクタを、有効・無効とする指定。start_date以降の場合に有効となる。

補足説明
※ は、いずれかの指定が必須です。

レスポンス

ステータスコード

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

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

HTTPレスポンスステータスコード一覧

 

ボディーパラメーター

項目 型 説明
items Object Array レスポンス情報が設定されます。
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 登録日時。

 

サンプル

リクエスト

{
  "domains": [
    {
      "start_date": "2021-07-01T00:00+09:00",
      "default": 0,
      "enable": true
    }
  ]
}

レスポンス

正常

{
  "items": [
    {
      "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"
    }
  ]
}

エラー

{
 "message": "Internal Server Error"
}

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