Checking the reindexing quota

Returns the daily quota for reindexing site pages.

Request format

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

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

Examples

{
  "daily_quota": 1,
  "quota_remainder": 1
}
<Data>  
  <daily_quota>1</daily_quota>  
  <quota_remainder>1</quota_remainder>
</Data>

Name

Required

Type

Description

daily_quota

Yes

int32

The daily quota.

quota_remainder

Yes

int32

The remainder of the daily quota, taking into account previously sent requests.

Response codes

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

Code

Reason

Description

200

OK

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>

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.

Required

Yes

Type

int32

Description

The daily quota

Required

Yes

Type

int32

Description

The remainder of the daily quota, taking into account previously sent requests.

Description

Error code.

Description

ID of the user who allowed access.

Description

ID of the requested site.

Description

Error message.