Get information about DKIM
DKIM (DomainKeys Identified Mail) is a way to sign email messages so that the sender's domain can be identified.
- information about why outgoing messages are not signed (for example, the DNS settings do not have a record with the public DKIM key).
- a public DKIM key, in order to manually add it to DNS settings.
- a private DKIM key, in order to configure the message signature on your own mail server.
Request syntax
The request should be sent over the HTTPS protocol using the GET method.
GET /api2/admin/dkim/status?
domain=<domain name>
&secretkey=<get secret key>
Host: pddimp.yandex.ru
PddToken: <PDD token>
Headers:
Parameters:
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Optional | ||
secretkey | String | This parameter is used for requesting a private DKIM key. Only the |
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Optional | ||
secretkey | String | This parameter is used for requesting a private DKIM key. Only the |
GET /api2/registrar/dkim/status?
domain=<domain name>
&secretkey=<get secret key>
Host: pddimp.yandex.ru
PddToken: <PDD token>
Authorization: OAuth <OAuth token>
Headers:
Name | Description |
---|---|
PddToken | |
Authorization |
Name | Description |
---|---|
PddToken | |
Authorization |
Parameters:
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Optional | ||
secretkey | String | This parameter is used for requesting a private DKIM key. Only the |
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Optional | ||
secretkey | String | This parameter is used for requesting a private DKIM key. Only the |
Request example
GET /api2/admin/dkim/status?domain=domain.com&secretkey=yes HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/dkim/status?domain=domain.com&secretkey=yes'
GET /api2/admin/dkim/status?domain=domain.com&secretkey=yes HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/dkim/status?domain=domain.com&secretkey=yes'
Response structure
{
"domain": "{domain name}",
"dkim":
{
"enabled": "{whether DKIM is enabled}",
"txtrecord": "{TXT record}",
"nsready": "{whether there is a TXT record}",
"mailready": "{Yandex.Mail for Domain readiness to sign messages}",
"secretkey": "{private DKIM key}"
},
"success": "{status of request execution}"
}
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
dkim | Object | Information about enabling DKIM, and the public and private DKIM keys. |
success | String | Status of request execution. Possible values:
|
error | String | Error code. Included in the response if the request resulted in an error. Possible values:
|
Keys for the dkim object | ||
enabled | String | Status of enabling DKIM for the domain. Possible values:
|
txtrecord | String | A TXT record with a public DKIM key for independently making settings. The record consists of three parts:
Example of a TXT record: |
nsready | String | Whether there is a TXT record. Possible values:
|
mailready | String | Whether Yandex.Mail for Domain is ready to sign email using DKIM. Possible values:
Yandex.Mail for Domain checks DKIM data with some delay. So if a user added a TXT record, the |
secretkey | String | Private DKIM key. |
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
dkim | Object | Information about enabling DKIM, and the public and private DKIM keys. |
success | String | Status of request execution. Possible values:
|
error | String | Error code. Included in the response if the request resulted in an error. Possible values:
|
Keys for the dkim object | ||
enabled | String | Status of enabling DKIM for the domain. Possible values:
|
txtrecord | String | A TXT record with a public DKIM key for independently making settings. The record consists of three parts:
Example of a TXT record: |
nsready | String | Whether there is a TXT record. Possible values:
|
mailready | String | Whether Yandex.Mail for Domain is ready to sign email using DKIM. Possible values:
Yandex.Mail for Domain checks DKIM data with some delay. So if a user added a TXT record, the |
secretkey | String | Private DKIM key. |