dkims は、DKIMドメイン及びセレクターを新規で登録する操作、セレクタの状態を取得する操作を提供します。登録されたセレクタのDNS確認、およびご利用のサーバ構成への設定反映は日次の夜間バッチで自動で行われます。自動反映の設定については「ユーザーガイド＞送信者認証＞DKIM」を参照ください。

このAPIは管理コンソールが提供します。接続先ホストについては共通仕様を参照ください。

Create

dkims/create は、DKIMセレクタを新規登録する操作を提供します。

リクエスト

/transaction/v2/dkims/create.[json|xml]

アクセス制御

パラメータ

レスポンス

JSON

{
  “message” : “success”,
  “dkim_domain” : “xxx.xxx”,
  “selector” : “sYYYYYYYYYYYYY”,
  ”dkim_name” : “sYYYYYYYYYYYYY._domainkey.xxx.xxx”,
  “type” : “TXT”,
  “dkim_value” : “v=DKIM1;...”,
  “status” : “unregistered”,
  “key_length” : 2048,
  “created” : “yyyy-mm-dd HH:MM”,
  “recommended_dkim_renewal_at” : “yyyy-mm-dd HH:MM” 
}

XML

<dkims>
  <message>success</message>
  <dkim_domain>xxx.xxx</dkim_domain>
  <selector>sYYYYYYYYYYYYY</selector>
  <dkim_name>sYYYYYYYYYYYYY._domainkey.xxx.xxx</dkim_name>
  <type>TXT</type>
  <dkim_value>“v=DKIM1;...”</dkim_value>
  <status>unregistered</status>
  <key_length>2048</key_length>
  <created>yyyy-mm-dd HH:MM</created>
  <recommended_dkim_renewal_at>yyyy-mm-dd HH:MM</recommended_dkim_renewal_at>
</dkims>

エラーメッセージ

List

dkims/list は、登録済みのDKIMセレクタを参照する操作を提供します。

リクエスト

/transaction/v2/dkims/list.[json|xml]

アクセス制御

パラメータ

レスポンス

JSON

{
  "message" : "success",
  "dkim_domain" : "example.com",
  "server_compositions": [ 
　　{
　　"name" : "test01",
　　"selectors": [ 
　　　　{
　　　　"selector" : "s1234567890123",
　　　　"dkim_name" : "s1234567890123._domainkey.example.com",
　　　　"type" : "TXT",
　　　　"dkim_value" : "v=DKIM1;...",
　　　　"status" : "registered",
　　　　"key_length" : 2048,
　　　　"created" : "2026-06-30 12:30",
　　　　"recommended_dkim_renewal_at" : "2027-06-30 12:30" 
　　　　"deploy_status" : 1 
　　　　},
　　　　{
　　　　"selector" : "s987654321987",
　　　　"dkim_name" : "s987654321987._domainkey.example.com",
　　　　"type" : "TXT",
　　　　"dkim_value" : "v=DKIM1;...",
　　　　"status" : "unregistered",
　　　　"key_length" : 2048,
　　　　"created" : "2026-03-30 12:30",
　　　　"recommended_dkim_renewal_at" : "2027-03-30 12:30" 
　　　　"deploy_status" : 0 
　　　　},
　　　　… 
　　]
　　},
　　"name" : "test02",
　　"selectors": [ 
　　　　{
　　　　"selector" : "s1234567890123",
　　　　"dkim_name" : "s1234567890123._domainkey.example.com",
　　　　"type" : "TXT",
　　　　"dkim_value" : "v=DKIM1;...",
　　　　"status" : "registered",
　　　　"key_length" : 2048,
　　　　"created" : "2026-06-30 12:30",
　　　　"recommended_dkim_renewal_at" : "2027-06-30 12:30" 
　　　　"deploy_status" : 1 
　　　　},
　　　　{
　　　　"selector" : "s987654321987",
　　　　"dkim_name" : "s987654321987._domainkey.example.com",
　　　　"type" : "TXT",
　　　　"dkim_value" : "v=DKIM1;...",
　　　　"status" : "unregistered",
　　　　"key_length" : 2048,
　　　　"created" : "2026-03-30 12:30",
　　　　"recommended_dkim_renewal_at" : "2027-03-30 12:30" 
　　　　"deploy_status" : 0 
　　　　},
　　　　… 
　　]
　　},
　　…
]
}

XML

<dkims>
  <message>success</message>
  <dkim_domain>example.com</dkim_domain>
  <server_compositions>
    <server_composition>
      <name>test01</name>
      <selectors>
        <selector>
          <selector>s1234567890123</selector>
          <dkim_name>s1234567890123._domainkey.example.com</dkim_name>
          <type>TXT</type>
          <dkim_value>"v=DKIM1;..."</dkim_value>
          <status>unregistered</status>
          <key_length>2048</key_length>
          <created>2026-06-30 12:30</created>
          <recommended_dkim_renewal_at>2027-03-30 12:30</recommended_dkim_renewal_at>
          <deploy_status>1</deploy_status>
        </selector>
        <selector>
          <selector>s987654321987</selector>
          <dkim_name>s987654321987._domainkey.example.com</dkim_name>
          <type>TXT</type>
          <dkim_value>"v=DKIM1;..."</dkim_value>
          <status>unregistered</status>
          <key_length>2048</key_length>
          <created>2026-06-30 12:30</created>
          <recommended_dkim_renewal_at>2027-03-30 12:30</recommended_dkim_renewal_at>
          <deploy_status>0</deploy_status>
        </selector>
        … 
      </selectors>
    </server_composition>
    <server_composition>
      <name>test02</name>
      <selectors>
        <selector>
          <selector>s1234567890123</selector>
          <dkim_name>s1234567890123._domainkey.example.com</dkim_name>
          <type>TXT</type>
          <dkim_value>"v=DKIM1;..."</dkim_value>
          <status>unregistered</status>
          <key_length>2048</key_length>
          <created>2026-06-30 12:30</created>
          <recommended_dkim_renewal_at>2027-03-30 12:30</recommended_dkim_renewal_at>
          <deploy_status>1</deploy_status>
        </selector>
        <selector>
          <selector>s987654321987</selector>
          <dkim_name>s987654321987._domainkey.example.com</dkim_name>
          <type>TXT</type>
          <dkim_value>"v=DKIM1;..."</dkim_value>
          <status>unregistered</status>
          <key_length>2048</key_length>
          <created>2026-06-30 12:30</created>
          <recommended_dkim_renewal_at>2027-03-30 12:30</recommended_dkim_renewal_at>
          <deploy_status>0</deploy_status>
        </selector>
        … 
      </selectors>
    </server_composition>
    …
  </server_compositions>
</dkims>

エラーメッセージ