Skip to main content
All endpoints live under /api/v1 and, except for public and setup endpoints, require an authorized admin session.
For whom: Administrator, SRE, Integration Developer, Rights Required: Depending on Endpoint.
The full machine catalog of error codes in the product has not yet been published. This table describes the observed behavior of API: which HTTP statuses return, in what situations and what to do for the operator. As the directory stabilizes, the page will expand.

HTTP Statuses

Examples of 409 conflicts

  • Backup is already executed by - no more than one run is running for each profile at the same time; a repeat POST /api/v1/backups/runs for the same profile will return 409. Wait for the current launch to complete.
  • Remnawave auto-binding disabled - POST /api/v1/setup/remnawave/bootstrap returns 409 if the AXOTTLE_RW_BOOTSTRAP variable is not enabled.
  • Second session of the Telegram assistant Helper session to configure notifications single; parallel attempt to open the second receives 409.

Special cases

Test of Telegram notifications

POST /api/v1/notifications/telegram/test is the only notification endpoint that returns a real delivery error. In other cases, the delivery of notifications is best-effort: the failure of sending does not break the operation that caused it, the error is recorded in the audit log.

Diagnosis by step

1

Determine the error class

4xx is a request, rights, or state problem; 5xx is a panel-side problem.
2

For 401/403, check the session and account permissions

Sign in again and check the permissions required for the requested action.
3

For 5xx see Logistics and Doctor

CLI axottle

Teams logs, doctor.