Отправка файла Sitemap на приоритетный переобход

Позволяет отправить файл Sitemap на приоритетный переобход.

POST /v4.1/user/{user-id}/hosts/{host-id}/sitemaps/{sitemap_id}/recrawl
  ? [parent_id=<string>]

Параметр

Тип

Обязательно

Описание

user-id

int64

Да

ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

host-id

string

Да

ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

sitemap_id

string

Да

ID файла Sitemap.

parent_id

string

Нет

ID родительского Sitemap.

Пример запроса

POST https://api.webmaster.yandex.net/v4.1/user/{user-id}/hosts/{host-id}/sitemaps/{sitemap_id}/recrawl?parent_id=parent_id

Формат ответа

Пример

{
  "sitemap_recrawl_info": {
    "last_request_time": "2026-01-21T19:43:04.205+03:00",
    "pending": true,
    "allowed": false
  },
  "host_sitemaps_recrawl_limit_info": {
    "monthly_limit_requests": 10,
    "requests_count": 4,
    "nearest_allowed_day": "2026-01-21T00:00:00.000+03:00"
  }
}

Параметр

Тип

Обязательно

Описание

sitemap_recrawl_info

object

Да

Информация о статусе последнего запроса на переобход.

last_request_time

string

Да

Дата и время последнего запроса на приоритетный переобход.

pending

boolean

Да

Указывает наличие активной задачи на переобход. Значение true означает, что переобход в процессе.

allowed

boolean

Да

Определяет возможность запуска нового переобхода. Значение false означает, что новый запуск невозможен.

host_sitemaps_recrawl_limit_info

object

Да

Информация о лимитах приоритетного переобхода.

monthly_limit_requests

integer

Да

Общее количество запросов на приоритетный переобход, доступное в месяц.

requests_count

integer

Да

Количество использованных запросов на приоритетный переобход в текущем месяце.

nearest_allowed_day

string

Да

Ближайшая дата, когда можно будет сделать очередной запрос на переобход. Если квота не превышена, возвращается текущая дата.

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код

Причина

Описание

200

OK

Успешно.

429

HOST_RECRAWLS_QUOTA_EXCEEDED

Исчерпан лимит на приоритетный переобход Sitemap за текущий месяц.

{
  "code": "HOST_RECRAWLS_QUOTA_EXCEEDED",
  "message": "Host recrawls per month quota exceeded",
  "quotaInfo": {
    "monthlyQuota": 10,
    "quotaUsed": 10,
    "nearestAllowedDay": "2024-02-01T00:00:00.000Z"
  }
}

409

RECRAWL_IN_PROCESS

Переобход уже выполняется. Новый запуск невозможен до завершения текущей задачи.

{
  "code": "RECRAWL_IN_PROCESS",
  "message": "Recrawl in process",
  "sitemapRecrawlInfo": {
    "isAllowed": false,
    "isPending": true,
    "lastRequestTime": "2024-01-14T08:15:00.000Z"
  }
}

404

SITEMAP_NOT_FOUND

Файл Sitemap не найден.

{
  "code": "SITEMAP_NOT_FOUND",
  "message": "Sitemap not found"
}

Узнайте больше

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

Тип: string. ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

Тип: string. ID файла Sitemap.

ID родительского Sitemap.