API / Початок роботи / Помилки й коди відповіді

Помилки й коди відповіді

Структура відповіді з помилкою

Поле	Тип	Опис
`status`	number	HTTP-статус відповіді
`code`	string	Короткий текстовий код для програмної обробки, наприклад `token_scope_missing`. Орієнтуйтеся на нього
`error`	string	Опис англійською для людей. Текст може змінюватися
`requestId`	string	ID запиту, той самий, що в заголовку `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_invalid`	401	Токен невірний, відкликаний або прострочений — створіть новий
`token_route_forbidden`	403	Метод недоступний за токеном — зробіть це в браузері
`token_scope_missing`	403	Додайте токену право, вказане в `error`
`token_project_forbidden`	403	Токен обмежений іншими проєктами чи послугами
`token_ip_forbidden`	403	Запит з адреси, якої немає в списку токена
`token_spend_limit`	403	Покупка перевищить ліміт витрат токена — підніміть ліміт
`insufficient_balance`	402	Поповніть баланс
`idempotency_key_required`	400	Додайте заголовок `Idempotency-Key` — див. ліміти й повтори
`idempotency_in_progress`	409	Запит із цим ключем ще виконується — зачекайте
`token_rate_limited`	429	Зачекайте `Retry-After` секунд
`server_offline`	409	Сервер не запущено
`node_full`	409	На ноді немає місця — виберіть іншу
`file_not_found`	404	Немає такого файлу чи папки
`file_too_large`	413	Файл більший за 1 МБ — використовуйте SFTP
`path_invalid`	400	Невірний шлях до файлу
`upstream_unavailable`	503	Повторіть за хвилину; не допомогло — напишіть у підтримку з `requestId`

Якщо в помилки немає власного коду, code повторює статус: bad_request, forbidden, not_found, conflict тощо.