Enable DKIM
This request is used for enabling DKIM for a domain delegated to Yandex. The DNS records will be set up automatically.
If the domain is delegated to third-party servers, user this request to get the public key and set up the DNS records yourself.
Request syntax
The request should be sent over the HTTPS protocol using the POST method.
POST /api2/admin/dkim/enable
Host: pddimp.yandex.ru
PddToken: <PDD token>
...
domain=<domain name>
Headers:
Parameters:
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
POST /api2/registrar/dkim/enable
Host: pddimp.yandex.ru
PddToken: <PDD token>
Authorization: OAuth <OAuth token>
...
domain=<domain name>
Headers:
Name | Description |
---|---|
PddToken | |
Authorization |
Name | Description |
---|---|
PddToken | |
Authorization |
Parameters:
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Request example
POST /api2/admin/dkim/enable HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com' 'https://pddimp.yandex.ru/api2/admin/dkim/enable'
POST /api2/admin/dkim/enable HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
...
domain=domain.com
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' -d 'domain=domain.com' 'https://pddimp.yandex.ru/api2/admin/dkim/enable'
Response structure
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: |
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: |