справка

Коды ошибок

Полный список кодов ошибок платформы и рекомендации по их обработке на стороне клиента.

Формат ошибки

Все ошибки API возвращаются в едином формате с машиночитаемым кодом и человекочитаемым сообщением:

{
  "error": {
    "code": "invalid_route",
    "message": "Маршрут /v1/unknown не найден",
    "request_id": "req_7f3a91"
  }
}

Указывайте request_id при обращении в поддержку — это ускоряет диагностику в 90% случаев.

HTTP-коды и их значение

КодЗначениеЧто делать
400Некорректный запросПроверьте формат тела запроса и обязательные поля
401Ключ недействителен или отсутствуетПроверьте заголовок Authorization и срок действия ключа
403Недостаточно прав (scope)Убедитесь, что ключу назначена нужная область действия
404Маршрут или ресурс не найденПроверьте конфигурацию маршрутов в проекте
409Конфликт состояния ресурсаНапример, повторное создание с тем же идемпотентным ключом
422Запрос синтаксически корректен, но не проходит валидациюСмотрите поле details в теле ответа
429Превышен лимит запросовСм. раздел «Лимиты и квоты»
502Upstream-сервис недоступен или вернул некорректный ответПроверьте доступность вашего сервиса за шлюзом
504Upstream не ответил вовремяПроверьте производительность бэкенда или увеличьте таймаут в конфигурации

Коды ошибок платформы

КодОписание
invalid_routeЗапрошенный путь не соответствует ни одному настроенному маршруту
upstream_timeoutВаш сервис не ответил в течение установленного таймаута
signature_mismatchПодпись вебхука не прошла проверку — вероятно, использован неверный секрет
quota_exceededИсчерпан месячный лимит запросов тарифа
invalid_configКонфигурация hexly.config.yaml не прошла валидацию при деплое