Getting site information
Returns information about the site.
Request format
GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}
user-id | Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method. |
host-id | Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method. |
user-id | Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method. |
host-id | Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method. |
Response format
Example
{
"host_id": "https:ya.ru:443",
"verified": true,
"ascii_host_url": "https://ya.ru/",
"unicode_host_url": "https://ya.ru/",
"main_mirror": {
"host_id": "http:xn--d1acpjx3f.xn--p1ai:80",
"ascii_host_url": "http://xn--d1acpjx3f.xn--p1ai/",
"unicode_host_url": "http://яндекс.рф/",
"verified": false
},
"host_data_status": "NOT_INDEXED",
"host_display_name": "Ya.ru"
}
<Data>
<host_id>https:ya.ru:443</host_id>
<verified>true</verified>
<ascii_host_url>https://ya.ru/</ascii_host_url>
<unicode_host_url>https://ya.ru/</unicode_host_url>
<main_mirror>
<host_id>http:xn--d1acpjx3f.xn--p1ai:80</host_id>
<ascii_host_url>http://xn--d1acpjx3f.xn--p1ai/</ascii_host_url>
<unicode_host_url>http://яндекс.рф/</unicode_host_url>
<verified>false</verified>
</main_mirror>
<host_data_status>NOT_INDEXED</host_data_status>
<host_display_name>Ya.ru</host_display_name>
</Data>
Name | Required | Type | Description |
---|---|---|---|
host_id | Yes | host id (string) | ID of the requested site. |
ascii_host_url | Yes | string | The site's ASCII URL |
unicode_host_url | Yes | string | The site's UTF-8 URL. |
verified | Yes | boolean | Whether the site is verified. |
main_mirror | No | The site's main mirror, if there is one. | |
host_data_status | No | string (ApiHostDataStatus) | Information about the site (shown if the site is verified). |
host_display_name | No | string | The site name to display. |
Name | Required | Type | Description |
---|---|---|---|
host_id | Yes | host id (string) | ID of the requested site. |
ascii_host_url | Yes | string | The site's ASCII URL |
unicode_host_url | Yes | string | The site's UTF-8 URL. |
verified | Yes | boolean | Whether the site is verified. |
main_mirror | No | The site's main mirror, if there is one. | |
host_data_status | No | string (ApiHostDataStatus) | Information about the site (shown if the site is verified). |
host_display_name | No | string | The site name to display. |
Site indexing status (ApiHostDataStatus)
Source | Description |
---|---|
NOT_INDEXED | The site isn't indexed yet. |
NOT_LOADED | The site data isn't uploaded to Yandex.Webmaster yet. |
OK | The site is indexed. The data is available in Yandex.Webmaster. |
Source | Description |
---|---|
NOT_INDEXED | The site isn't indexed yet. |
NOT_LOADED | The site data isn't uploaded to Yandex.Webmaster yet. |
OK | The site is indexed. The data is available in Yandex.Webmaster. |
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, | |
404 | HOST_NOT_FOUND | The site is not in the list of the user's sites. |
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, | |
404 | HOST_NOT_FOUND | The site is not in the list of the user's sites. |