Sending a page for reindexing

Sends the URL for reindexing.

  1. Request format
  2. Response format
  3. Response codes

Request format

In the request body, pass the URL of the page to reindex:

POST https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/recrawl/queue/

Path parameters

Name Required Type Default value Description
user-id Yes int64 User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /user/ method.
host-id Yes host id The site ID. To get it, use the GET /user/{user-id}/hosts/ method.

Example

{
  "url": "http://example.com"
}
Parameter Description
url The URL of the page to be sent for reindexing.

Response format

Examples

{
  "task_id": "c7fe80c0-36e3-11e6-8b2d-df96aa592c0a",
  "quota_remainder": 1
}
Name Required Type Description
task_id Yes UUID ID of the reindexing task.
quota_remainder Yes int32 The remainder of the daily quota.

Response codes

To view the response structure in detail, click the reason.

Code Reason Description
202 ACCEPTED
400 INVALID_URL
Wrong URL was passed.
{
  "error_code": "INVALID_URL",
  "error_message": "some string"
}
403

INVALID_USER_ID

The ID of the user who issued the token differs from the one specified in the request. In the examples below, {user_id} shows the correct uid of the OAuth token owner.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_VERIFIED
Site management rights are not verified.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
409 URL_ALREADY_ADDED
The URL was already added for reindexing.
{
  "error_code": "URL_ALREADY_ADDED",
  "error_message": "some string"
}
429 QUOTA_EXCEEDED
The daily quota for requests was exceeded.
{
  "error_code": "QUOTA_EXCEEDED",
  "daily_quota": 1,
  "exceeded_until": "2016-01-01T00:00:00,000+0300",
  "error_message": "some string"
}