Sending a page for reindexing

Sends the URL for reindexing.

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

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.

Example

{
  "url": "http://example.com"
}
<Data>
    <url>http://example.com</url>
</Data>
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
}
<Data>  
  <task_id>c7fe80c0-36e3-11e6-8b2d-df96aa592c0a</task_id>  
  <quota_remainder>1</quota_remainder>
</Data>

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" 
}
<Data>   
    <error_code>INVALID_URL</error_code>     
    <error_message>some string</error_message> 
</Data>

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."
}
<Data>     
    <error_code>INVALID_USER_ID</error_code>     
    <available_user_id>1</available_user_id>     
    <error_message>Invalid user id. {user_id} should be used.</error_message> 
</Data>

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"
}
<Data>   
    <error_code>HOST_NOT_VERIFIED</error_code>     
    <host_id>http:ya.ru:80</host_id>   
    <error_message>some string</error_message> 
</Data>

409

URL_ALREADY_ADDED

The URL was already added for reindexing.

{   
    "error_code": "URL_ALREADY_ADDED",   
    "error_message": "some string"
}
<Data>   
    <error_code>URL_ALREADY_ADDED</error_code>     
    <error_message>some string</error_message> 
</Data>

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"
}
<Data>   
    <error_code>QUOTA_EXCEEDED</error_code>     
    <daily_quota>1</daily_quota>     
    <exceeded_until>2016-01-01T00:00:00,000+0300</exceeded_until>     
    <error_message>some string</error_message>
</Data>

Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.

Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.

Description

The URL of the page to be sent for reindexing.

Description

Error code.

Description

ID of the user who allowed access.

Description

ID of the requested site.

Description

Error message.

Required

Yes

Type

UUID

Description

ID of the reindexing task.

Required

Yes

Type

int32

Description

The remainder of the daily quota.