Dkims ｜ドキュメント｜クラウド型メール（SMTP）リレーサービスやDMARC対策のCustomers Mail Cloud

Create
Request
Access Control
Parameter
Response
Error Message
List
Request
Access Control
Parameter
Response
Error Message

dkims provides operations to register new DKIM domains and selectors, as well as retrieve the status of registered selectors. The DNS verification of registered selectors and their application to your server configuration are performed automatically via a daily nightly batch. For details on automatic application settings, please refer to "User Guide > Sender Authentication > DKIM".

This API is provided by the management console.For access point host please refer to shared specification.

Create

dkims/create provides an operation to register a new DKIM selector.

Request

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

Access Control

Item	Value
Role	API group administrator
Authorization	none

Parameter

Parameter	Required	Data Type	Description
api_user	Yes	ASCII
api_key	Yes	ASCII
dkim_domain	Yes	ASCII	Specifies the target DKIM domain for the selector.
selector	No	ASCII	Specifies the selector name for the specified domain. Note: Auto-generated as "sNNNNNNNNNNNNN" if omitted
key_length	No	INTEGER	Specifies the encryption key length (1024 or 2048). Default: 2048

Response

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>

Propety	Description
message	API execution result.
dkim_domain	Registered DKIM domain.
selector	Registered DKIM selector name.
dkim_name	Registered DKIM configuration name.
type	DKIM key record type.
dkim_value	DKIM key value.
status	DNS verification status of the DKIM key.
key_length	Key length value.
created	Key registration date.
recommended_dkim_renewal_at	Recommended key rotation date and time for the DKIM key.

Error Message

Field	Error Code	Message (en)	Message (ja)
dkim_domain	16-001	The 'dkim_domain' must be a valid domain name	ドメインの形式が正しくありません。
selector	16-002	The 'selector' format is invalid.	セレクタの形式が正しくありません。
	16-003	The specified selector {value} already exists.	指定されたセレクタ {値} はすでに存在します。
	16-004	The specified selector {value} is already in use by another group.	指定されたセレクタ {値} はすでに他グループで利用されています。
key_length	16-005	Please specify an encryption key length of 1024 or 2048.	暗号鍵長は1024または2048を指定してください。

List

dkims/list retrieves a list of registered DKIM selectors.

Request

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

Access Control

Item	Value
Role	API group administrator, API user
Authorization	Data reference permission

Parameter

Parameter	Required	Data Type	Description
api_user	Yes	ASCII
api_key	Yes	ASCII
server_composition	No	UTF-8
dkim_domain	Yes	ASCII	Specify the DKIM domain to retrieve information for.
selector	No	ASCII	Specify the selector to retrieve information for. Note: If omitted, information for all selectors registered under the specified domain will be returned.

Response

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>

Error Message

Field	Error Code	Message (en)	Message (ja)
dkim_domain	16-006	The specified domain {value} does not exist.	指定されたドメイン {値} は存在しません。
selector	16-007	The specified selector {value} does not exist.	指定されたセレクタ {値} は存在しません。

Dkims

2026/09/30更新

Create

Request

Access Control

Parameter

Response

JSON

XML

Error Message

List

Request

Access Control

Parameter

Response

JSON

XML

Error Message

Download