Getting the list of the user's sites
Returns the list of sites added by the user and information about each of them.
Request format
GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts
user-id | Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method. |
user-id | Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method. |
Response format
Example
{
"hosts": [
{
"host_id": "http:ya.ru:80",
"ascii_host_url": "http://xn--d1acpjx3f.xn--p1ai/",
"unicode_host_url": "http://яндекс.рф/",
"verified": true,
"main_mirror": {
"host_id": "http:ya.ru:80",
"verified": true,
"ascii_host_url": "http://xn--d1acpjx3f.xn--p1ai/",
"unicode_host_url": "http://яндекс.рф/"
}
}, ...
]
}
<Data>
<host>
<host_id>http:ya.ru:80</host_id>
<ascii_host_url>http://xn--d1acpjx3f.xn--p1ai/</ascii_host_url>
<unicode_host_url>http://яндекс.рф/</unicode_host_url>
<verified>yes</verified>
<main_mirror>
<host_id>http:ya.ru:80</host_id>
<verified>false</verified>
<ascii_host_url>http://xn--d1acpjx3f.xn--p1ai/</ascii_host_url>
<unicode_host_url>http://яндекс.рф/</unicode_host_url>
</main_mirror>
</host>
...
</Data>
Name | Required | Type | Description |
---|---|---|---|
host_id | Yes | host id (string) | The site ID. |
ascii_host_url | Yes | string | The site's ASCII URL |
unicode_host_url | No | string | The site's UTF-8 URL. |
verified | Yes | boolean | Whether the site is verified. |
main_mirror | Yes | The site's main mirror, if there is one. |
Name | Required | Type | Description |
---|---|---|---|
host_id | Yes | host id (string) | The site ID. |
ascii_host_url | Yes | string | The site's ASCII URL |
unicode_host_url | No | string | The site's UTF-8 URL. |
verified | Yes | boolean | Whether the site is verified. |
main_mirror | Yes | The site's main mirror, if there is one. |
The status of verifying the right to manage the site (ApiVerificationState)
Status | Description |
---|---|
NONE | Verification wasn't completed and rights are not confirmed. |
VERIFIED | The rights are verified. |
IN_PROGRESS | The rights verification is in progress. |
VERIFICATION_FAILED | Verification was performed but rights are not confirmed. |
INTERNAL_ERROR | An unexpected error occurred when verifying the rights. |
Status | Description |
---|---|
NONE | Verification wasn't completed and rights are not confirmed. |
VERIFIED | The rights are verified. |
IN_PROGRESS | The rights verification is in progress. |
VERIFICATION_FAILED | Verification was performed but rights are not confirmed. |
INTERNAL_ERROR | An unexpected error occurred when verifying the rights. |
Reasons for refusal to verify site management rights (ApiVerificationFailReason)
Reason for refusal | Description |
---|---|
DELEGATION CANCELLED | Delegation of site management rights was canceled. |
DNS_RECORD_NOT_FOUND | The specified DNS record doesn't exist. |
META_TAG_NOT_FOUND | The meta tag is missing in the site's home page header. |
PDD_VERIFICATION_CANCELLED | Verification of site management rights via Yandex.Mail for Domain isn't allowed for this site. |
WHOIS_EMAIL_NOT_FOUND | The specified email address is missing in the WHOIS record for this site. |
WRONG_HTML_PAGE_CONTENT | The HTML file content is set incorrectly. |
Reason for refusal | Description |
---|---|
DELEGATION CANCELLED | Delegation of site management rights was canceled. |
DNS_RECORD_NOT_FOUND | The specified DNS record doesn't exist. |
META_TAG_NOT_FOUND | The meta tag is missing in the site's home page header. |
PDD_VERIFICATION_CANCELLED | Verification of site management rights via Yandex.Mail for Domain isn't allowed for this site. |
WHOIS_EMAIL_NOT_FOUND | The specified email address is missing in the WHOIS record for this site. |
WRONG_HTML_PAGE_CONTENT | The HTML file content is set incorrectly. |
Response codes
To view the response structure in detail, click the reason.
Code | Reason | Description |
---|---|---|
200 | OK | |
403 | The ID of the user who issued the token differs from the one specified in the request. In the examples below, |
Code | Reason | Description |
---|---|---|
200 | OK | |
403 | The ID of the user who issued the token differs from the one specified in the request. In the examples below, |