Skip to content
mxHeadless
REST API gateway для headless-фронтендов на MODX 3. Ресурсы, объекты, OpenAPI, API keys и OAuth
  1. Компоненты
  2. mxHeadless
  3. API
  4. Ошибки

Ошибки

Неуспешный ответ приходит в формате RFC 9457 (application/problem+json). Обёртки {data, meta} нет.

Формат

json
{
  "type": "https://mxheadless.dev/problems/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication required",
  "instance": "/api/v1/resources",
  "code": "token_required"
}
ПолеРоль
typeURI категории
titleКраткий заголовок
statusHTTP-код
detailТекст, безопасный для production
instanceПуть запроса
codeСтабильный код для клиентов
errorsОпционально: ошибки по полям

Коды

codeHTTPКогда
service_disabled503mxheadless_enabled=false
token_required401Нет credentials
invalid_token401Неверный / истёкший / отозванный
scope_denied403Нет нужного scope
rate_limited429Rate limit
idempotency_conflict409Конфликт Idempotency-Key
invalid_grant400OAuth отклонён

Не у каждой ошибки есть code. Для общей обработки используйте status + type.

HTTP

КодКогда
400Неподдерживаемый media type
401 / 403Auth
404Маршрут или сущность
405Метод
422Валидация, неизвестный filter/field/sort
429Rate limit
500Сервер
503Kill switch

При mxheadless_debug=false в ответе нет SQL, stack trace и путей к файлам.