> ## Documentation Index
> Fetch the complete documentation index at: https://docs.axottle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Обзор API

> REST API панели Axottle: базовый адрес, версия, публичные и защищённые области.

Панель Axottle управляется через REST API. Тот же API использует встроенный веб-интерфейс, поэтому любое действие в панели доступно и программно.

<Info>
  Для кого: разработчик, интегрирующийся с Axottle; администратор, автоматизирующий рутину.
  Требуемые права: действующая сессия администратора (см. [Аутентификация](/ru/api-reference/authentication)).
</Info>

## Базовый адрес и версия

Все административные методы располагаются под префиксом `/api/v1` на адресе вашей панели:

```
https://panel.example.com/api/v1
```

Версия API указывается в пути (`v1`). Несовместимые изменения будут выпускаться под новой версией пути.

## Области API

<CardGroup cols={2}>
  <Card title="Публичные методы" icon="globe">
    Не требуют аутентификации. Сюда относятся проверка здоровья (`GET /health`), скрипты и файлы установки агента (`/install/...`).
  </Card>

  <Card title="Административные методы" icon="lock">
    Всё под `/api/v1/*`. Требуют токен сессии администратора. Часть методов дополнительно проверяет статус лицензии.
  </Card>

  <Card title="Методы агента" icon="server">
    Под `/agent/v1/*`. Используются агентами нод и аутентифицируются токеном агента, а не сессией администратора. Не предназначены для ручного вызова.
  </Card>
</CardGroup>

## Режим «только чтение»

Если лицензия панели просрочена или отсутствует, административный API переходит в деградированный режим: методы, изменяющие состояние, отклоняются, а чтение продолжает работать. Методы восстановления (лицензия, аутентификация, обновление панели, маршруты агента) остаются доступными. Подробнее — [Лицензия](/ru/operations/license).

## Формат

* Тело запросов и ответов — JSON (`Content-Type: application/json`).
* Ошибки возвращаются с соответствующим HTTP-статусом. Справочник — [Коды ошибок](/ru/reference/error-codes).
* Публичный шлюз применяет троттлинг: при превышении возвращается `429` с заголовком `Retry-After`.

## Дальше

<CardGroup cols={3}>
  <Card title="Аутентификация" icon="key" href="/ru/api-reference/authentication">
    Как получить и использовать токен сессии.
  </Card>

  <Card title="Соглашения" icon="list-check" href="/ru/api-reference/conventions">
    Пагинация, фильтры, идемпотентность, подтверждения.
  </Card>

  <Card title="Методы" icon="table-list" href="/ru/api-reference/endpoints">
    Справочник методов по разделам.
  </Card>
</CardGroup>

<Note>Проверено для версии Axottle текущей ветки. Дата проверки: 2026-07-11.</Note>