Get domain connection status
Yandex.Mail for Domain checks the connection status of all domains according to a schedule (without the user's participation).
The request is used for getting the results of the last check, the date and time the check was performed, and the date and time of the next check.
Request syntax
The request should be sent over the HTTPS protocol using the GET method.
GET /api2/admin/domain/registration_status?
domain=<domain name>
Host: pddimp.yandex.ru
PddToken: <PDD token>
Headers:
Parameters:
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
GET /api2/registrar/domain/registration_status?
domain=<domain name>
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. |
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Request example
GET /api2/admin/domain/registration_status?domain=domain.com HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/domain/registration_status?domain=domain.com'
GET /api2/admin/domain/registration_status?domain=domain.com 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/domain/registration_status?domain=domain.com'
Response structure
{
"domain": "{domain name}",
"status": "{domain status}",
"stage":"{service key}",
"check_results": "{result of last verification}",
"next_check": "{date and time of next verification}",
"last_check": "{date and time of last verification}",
"secrets":
{
"name": "{name of the verification file}",
"content": "{contents of verification file}"
},
"success": "{status of request execution}"
}
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
status | String | Domain status. Possible values:
|
stage | String | The key duplicates Possible values:
|
check_results | String | Results of the last check. Possible values:
|
next_check | String | Date and time of the next check. |
last_check | String | Date and time of the last check. |
secrets | Object | Secret data of the verification file (or CNAME record). Included in the response if the status value is set to |
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 secrets object | ||
name | String | The secret part of the name of the verification file (or CNAME record). |
content | String | Secret content of the verification file. |
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
status | String | Domain status. Possible values:
|
stage | String | The key duplicates Possible values:
|
check_results | String | Results of the last check. Possible values:
|
next_check | String | Date and time of the next check. |
last_check | String | Date and time of the last check. |
secrets | Object | Secret data of the verification file (or CNAME record). Included in the response if the status value is set to |
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 secrets object | ||
name | String | The secret part of the name of the verification file (or CNAME record). |
content | String | Secret content of the verification file. |