Ошибки

Все ошибки будут возвращать наиболее конкретный и подходящий код HTTP-ответа из следующей таблицы:

Коды возврата

Код	Ошибка	Описание
400	Некорректный запрос	От клиента был получен некорректно сформированный запрос. Это наиболее общий ответ, возвращаемый API
401	Неавторизован	У вас нет авторизации, и вы не можете получить доступ к запрошенному ресурсу
403	Запрещено	У вас нет разрешения на доступ к запрошенному ресурсу
404	Не найдено	Запрошенный ресурс не может быть найден. Возможно, он станет доступен позже
405	Метод не разрешён	Для запрошенного ресурса был использован неподдерживаемый HTTP-метод
406	Неприемлемо	Запрошенный клиентом тип Accept или Accept-Encoding недоступен
409	Конфликт	Запрос не может быть выполнен, поскольку существует конфликт с уже имеющимся ресурсом
410	Больше недоступен	Запрошенный ресурс больше недоступен и никогда не будет доступен в будущем
411	Требуется Content-Length	Запрошенный ресурс ожидает, что клиент укажет Content-Length
413	Слишком большой объём запроса	Тело запроса, переданное клиентом, было слишком большим, и ресурс отказывается его обрабатывать
415	Неподдерживаемый тип содержимого	Клиент указал неверный (или не указал) Content-Type
422	Необрабатываемая сущность	Запрос не является некорректным, а тип содержимого приемлем, но ресурс не может обработать запрос
429	Слишком много запросов	Достигнут лимит запросов. Дополнительную информацию см. в разделе ограничения частоты запросов
500	Внутренняя ошибка сервера	Сервер не смог обработать ваш запрос из-за непредвиденной внутренней ошибки сервера
501	Не реализовано	Запрошенный ресурс не реализован
503	Сервис недоступен	Запрошенная служба временно недоступна

Стандартный формат ответа

У всех ошибок будет стандартное тело ответа с двумя полями, код и сообщение. Могут использоваться и другие поля, но они необязательны.

Примеры

Это простейшая форма тела ответа об ошибке; клиенты могут рассчитывать на то, что эти поля будут присутствовать в каждой ошибке.

Ответы с ошибками - пример 1 (базовый)

{
  "код": 429,
  "сообщение": "Вы превысили допустимое число запросов. Пожалуйста, попробуйте позже"
}

Следующий пример содержит, помимо стандартных полей, поля для ошибок, связанных с этим конкретным запросом.

Ответы с ошибками - пример 2 (более сложный)

{
  "код": 422,
  "сообщение": "Необрабатываемая сущность",
  "причина": "Проверка не пройдена",
  "ошибки": [
    {
      "ресурс": "Issue",
      "поле": "title",
      "код": "missing_field"
    },
    ...
  ]
}