API / Начало работы / Ошибки и коды ответа

Ошибки и коды ответа

Структура ответа с ошибкой

ПолеТипОписание
statusnumberHTTP-статус ответа
codestringКороткий текстовый код для программной обработки, например token_scope_missing. Ориентируйтесь на него
errorstringОписание по-английски для людей. Текст может меняться
requestIdstringID запроса, тот же, что в заголовке X-Request-ID. Приложите его к обращению в поддержку — так мы быстрее найдём ваш запрос

Пример:

HTTP
HTTP/2 403 Forbidden
{
  "status": 403,
  "code": "token_scope_missing",
  "error": "this API token lacks the servers:power scope",
  "requestId": "3f1c9a2e-7b4d-4e8a-9c21-5d6e7f8a9b0c"
}

HTTP-статусы

СтатусЗначение
200Готово, в теле ответ
201Создано
204Готово, тела нет
400Неверное тело или параметры
401Нет токена, или он неверный, отозван, просрочен
402Не хватает денег на балансе
403Токену это нельзя: нет права, чужой проект, IP или лимит трат
404Нет такого проекта, услуги или объекта
409Конфликт состояния: сервер выключен, на ноде нет места, запрос ещё выполняется
413Файл больше 1 МБ или не текст
429Слишком много запросов, подождите Retry-After секунд
503Панель или нода не ответили — повторите позже

Коды ошибок

КодСтатусЧто делать
token_invalid401Токен неверный, отозван или просрочен — создайте новый
token_route_forbidden403Метод недоступен по токену — сделайте это в браузере
token_scope_missing403Добавьте токену право, указанное в error
token_project_forbidden403Токен ограничен другими проектами или услугами
token_ip_forbidden403Запрос с адреса, которого нет в списке токена
token_spend_limit403Покупка превысит лимит трат токена — поднимите лимит
insufficient_balance402Пополните баланс
idempotency_key_required400Добавьте заголовок Idempotency-Key — см. лимиты и повторы
idempotency_in_progress409Запрос с этим ключом ещё выполняется — подождите
token_rate_limited429Подождите Retry-After секунд
server_offline409Сервер не запущен
node_full409На ноде нет места — выберите другую
file_not_found404Нет такого файла или папки
file_too_large413Файл больше 1 МБ — используйте SFTP
path_invalid400Неверный путь к файлу
upstream_unavailable503Повторите через минуту; не помогло — напишите в поддержку с requestId

Если у ошибки нет своего кода, code повторяет статус: bad_request, forbidden, not_found, conflict и т. д.