Getting a list of user domains
This request is used for getting the list of a user's domains.
The response is paginated, and its parameters can be set in the request.
Request syntax
The request should be sent over the HTTPS protocol using the GET method.
GET /api2/admin/domain/domains?
[page=<page number in the response>]
[on_page=<number of domains per response page>]
Host: pddimp.yandex.ru
PddToken: <PDD token>
Headers:
Parameters:
Parameter | Type | Value |
---|---|---|
Optional | ||
page | Integer | Page number in the response. The default value is 1. |
on_page | Integer | Number of domains on each response page. Acceptable values are from 1 to 20. The default value is 10. |
Parameter | Type | Value |
---|---|---|
Optional | ||
page | Integer | Page number in the response. The default value is 1. |
on_page | Integer | Number of domains on each response page. Acceptable values are from 1 to 20. The default value is 10. |
GET /api2/registrar/domain/domains?
[page=<page number in the response>]
[on_page=<number of domains per response page>]
Host: pddimp.yandex.ru
PddToken: <PDD token>
Authorization: OAuth <OAuth token>
Headers:
Name | Description |
---|---|
PddToken | |
Authorization |
Name | Description |
---|---|
PddToken | |
Authorization |
Parameters:
Parameter | Type | Value |
---|---|---|
Optional | ||
page | Integer | Page number in the response. The default value is 1. |
on_page | Integer | Number of domains on each response page. Acceptable values are from 1 to 20. The default value is 10. |
Parameter | Type | Value |
---|---|---|
Optional | ||
page | Integer | Page number in the response. The default value is 1. |
on_page | Integer | Number of domains on each response page. Acceptable values are from 1 to 20. The default value is 10. |
Request example
GET /api2/admin/domain/domains?page=2&on_page=5 HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/domain/domains'
GET /api2/admin/domain/domains?page=2&on_page=5 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/domains'
Response structure
{
"page": "{page number in the response}",
"on_page": "{number of domains per response page}",
"total": "{total number of user domains}",
"found": "{number of domains on the current response page}",
"domains":
[
{
"name":"{domain name}",
"status": "{domain status}",
"stage":"{service key}",
"aliases":
[
"{alias name}",
...
],
"logo_enabled": "{whether there is a logotype}",
"logo_url": "{logotype URL}",
"nsdelegated": "{domain delegation status}",
"master_admin": "{user status}",
"emails-max-count": "maximum possible number of mailboxes}",
"emails-count": "{number of mailboxes}",
"nodkim": "{DKIM is not enabled}"
},
...
],
"success": "{status of request execution}"
}
Name | Type of value | Description |
---|---|---|
page | Integer | Page number in the response. Value of the page parameter set in the request. If the parameter value is omitted, the default value is used. |
on_page | Integer | Number of domains on each response page. Value of the on_page parameter set in the request. |
total | Integer | Total number of the user's domains. |
found | Integer | The number of domains on the current response page (may be less than the on_page value for the last page). |
domains | Array | Properties of domains. Each object in the array corresponds to a single domain. Included in the response if the user has at least one domain that has been verified or is pending verification. |
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 objects in the domains array | ||
name | String | Name of the domain. |
status | String | Domain status. Possible values:
|
stage | String | The key duplicates Possible values:
|
aliases | Array | List of . |
logo_enabled | Boolean | Whether the domain has a logo. Possible values:
|
logo_url | String | URL of the domain's logo. |
nsdelegated | String | Status of domain delegation to the Yandex servers ( Possible values:
|
master_admin | Boolean | The user's status. Possible values:
|
dkim-ready | Boolean | Whether DKIM is enabled. Possible values:
|
emails-max-count | Integer | The maximum number of mailboxes that can be created for the domain. |
emails-count | Integer | The number of existing mailboxes. |
nodkim | Boolean | Indicates that is not enabled for the domain. The key is included in the response for a verified domain. Possible value: |
Name | Type of value | Description |
---|---|---|
page | Integer | Page number in the response. Value of the page parameter set in the request. If the parameter value is omitted, the default value is used. |
on_page | Integer | Number of domains on each response page. Value of the on_page parameter set in the request. |
total | Integer | Total number of the user's domains. |
found | Integer | The number of domains on the current response page (may be less than the on_page value for the last page). |
domains | Array | Properties of domains. Each object in the array corresponds to a single domain. Included in the response if the user has at least one domain that has been verified or is pending verification. |
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 objects in the domains array | ||
name | String | Name of the domain. |
status | String | Domain status. Possible values:
|
stage | String | The key duplicates Possible values:
|
aliases | Array | List of . |
logo_enabled | Boolean | Whether the domain has a logo. Possible values:
|
logo_url | String | URL of the domain's logo. |
nsdelegated | String | Status of domain delegation to the Yandex servers ( Possible values:
|
master_admin | Boolean | The user's status. Possible values:
|
dkim-ready | Boolean | Whether DKIM is enabled. Possible values:
|
emails-max-count | Integer | The maximum number of mailboxes that can be created for the domain. |
emails-count | Integer | The number of existing mailboxes. |
nodkim | Boolean | Indicates that is not enabled for the domain. The key is included in the response for a verified domain. Possible value: |