Get domain settings
Use this request to get current domain properties: the status of connecting and delegating the domain to Yandex, the mailbox interface language and design, and the POP and IMAP modes.
Request syntax
The request should be sent over the HTTPS protocol using the GET method.
GET /api2/admin/domain/details?
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/details?
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/details?domain=domain.com HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/domain/details?domain=domain.com'
GET /api2/admin/domain/details?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/details?domain=domain.com'
Response structure
{
"domain": "{domain name}",
"status": "{domain status}",
"stage": "{service key}",
"delegated": "{status of delegating domain to Yandex}",
"country": "{interface language}",
"imap_enabled": "{status of IMAP operation}",
"pop_enabled": "{status of POP operation}",
"default_theme": "{design theme ID}",
"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:
|
delegated | String | Status of domain delegation to the Yandex servers ( Possible values:
|
country | String | The default language of the mailbox interface for the domain. Included in the response if the domain has been verified (the Possible values:
|
pop_enabled | Integer | Status of POP operation on the domain. Included in the response if the domain has been verified (the Possible values:
Note. When the status changes, the new mode will only apply for newly created mailboxes. |
imap_enabled | Integer | Status of IMAP operation on the domain. Included in the response if the domain has been verified (the Possible values:
Note. When the status changes, the new mode will only apply for newly created mailboxes. |
default_theme | String | ID of the default design theme for all the domain mailboxes (for example, Included in the response if the domain has been verified (the If the theme is not set, the value will be an empty string. |
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:
|
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
status | String | Domain status. Possible values:
|
stage | String | The key duplicates Possible values:
|
delegated | String | Status of domain delegation to the Yandex servers ( Possible values:
|
country | String | The default language of the mailbox interface for the domain. Included in the response if the domain has been verified (the Possible values:
|
pop_enabled | Integer | Status of POP operation on the domain. Included in the response if the domain has been verified (the Possible values:
Note. When the status changes, the new mode will only apply for newly created mailboxes. |
imap_enabled | Integer | Status of IMAP operation on the domain. Included in the response if the domain has been verified (the Possible values:
Note. When the status changes, the new mode will only apply for newly created mailboxes. |
default_theme | String | ID of the default design theme for all the domain mailboxes (for example, Included in the response if the domain has been verified (the If the theme is not set, the value will be an empty string. |
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:
|