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.

  1. Request syntax
  2. Request example
  3. Response structure

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:

NameDescription
PddToken

PDD token.

Parameters:

ParameterTypeValue
Mandatory
domainString

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
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' '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}"
        }
NameType of valueDescription
domainString

Name of the domain.

statusString

Domain status.

Possible values:
  • domain-activate — The domain has been added to Mail for Domain, but has not been verified.
  • mx-activate — The domain has been verified, but the MX record is not set up (email does not work).
  • added — The domain has been verified and the MX record is set up.
stageString

The key duplicates status for internal use.

Possible values:
  • owner-check — The domain has been added to Mail for Domain, but has not been verified.
  • mx-check — The domain has been verified, but the MX record has not been set up.
  • added — The domain has been verified and the MX record is set up.
check_resultsString

Results of the last check.

Possible values:
  • ok — The domain was verified, and the MX record was set up (email is working).
  • no-cname,no-file — The CNAME record and private file were not found.
  • bad-cname,bad-file — The CNAME record and private file are invalid.
  • no-cname,bad-file — The CNAME record was not found, and the private file is invalid.
  • bad-cname,no-file — The CNAME record is invalid and the private file was not found.
  • domain-not-found — The domain was not found.
  • occupied — The domain name is already used by another user.
  • mx-wrong — The MX record is invalid.
  • mx-not-found — The MX record was not found.
next_checkString

Date and time of the next check.

last_checkString

Date and time of the last check.

secretsObject

Secret data of the verification file (or CNAME record).

Included in the response if the status value is set to domain-activate.

successString

Status of request execution.

Possible values:
  • ok — Request executed successfully.
  • error — Request executed with error.
errorString

Error code.

Included in the response if the request resulted in an error.

Possible values:
  • unknown — A temporary failure or API error occurred (repeat the request again later).
  • no_token (no_domain, no_ip ) — A mandatory parameter was omitted.
  • bad_domain — The domain name was not specified or does not conform to the RFC.
  • prohibited — A forbidden domain name.
  • bad_token (bad_login, bad_passwd) — An invalid PDD token (or username/password) was passed.
  • no_auth — The PddToken header was omitted.
  • not_allowed — This operation is not allowed for this user (the user is not the domain administrator).
  • blocked — Blocked domain (for example, due to spam and so on).
  • occupied — The domain name is in use by another user.
  • domain_limit_reached — Exceeded the acceptable number of connected domains (50).
  • no_reply — Yandex.Mail for Domain cannot connect to the server source for the import.
Keys for the secrets object
nameStringThe secret part of the name of the verification file (or CNAME record).
contentStringSecret content of the verification file.