> ## 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

> Общие правила работы с API Axottle: подтверждения, фильтры, идемпотентность, троттлинг.

Единые правила, действующие для большинства методов API. Понимание этих соглашений упрощает интеграцию и снижает риск нежелательных изменений.

## Подтверждение опасных операций

Деструктивные и необратимые операции требуют явного подтверждения в теле запроса — как правило, флага `confirm: true`. Без подтверждения метод возвращает предпросмотр или отказ, но не выполняет действие.

Примеры операций с подтверждением:

* восстановление панели из резервной копии (перезаписывает базу данных);
* применение конфигурации Connection Unit;
* деструктивные действия ассистента Axosun (дополнительно проходят через карточку подтверждения).

<Warning>
  Всегда сначала запрашивайте предпросмотр (`preview`/`restore-preview`/`compile-plan`), убеждайтесь в ожидаемом результате и только затем отправляйте подтверждённый запрос.
</Warning>

## Фильтры и ограничение выборок

Списковые методы поддерживают фильтрацию и ограничение размера ответа там, где это применимо:

* аудит-лог принимает подстрочный фильтр `?q=` и параметр ограничения количества записей;
* метрики нод ограничиваются временным окном (`?since=`);
* ответы, где полная выборка была бы избыточной, возвращают счётчики и ограниченные образцы, а не полные списки.

Точные параметры указаны на страницах соответствующих методов.

## «Сохранено» ≠ «Применено»

Для функций, где конфигурация сначала сохраняется, а затем применяется на нодах (Connection Units, Egress Guard), API различает эти состояния. Ответ показывает, было ли изменение уже применено (`applied`) или только сохранено и ожидает применения. Не считайте изменение вступившим в силу, пока оно не применено и не проверено.

## Идемпотентность и провижининг

Операции провижининга (например, автоматизация CDN) идемпотентны: повторный запуск не создаёт дубликатов, а продолжает с текущего состояния. Такие операции ведут журнал состояний, по которому отслеживается прогресс и возможен откат.

## Троттлинг

## Статусы и ошибки

Методы возвращают стандартные HTTP-статусы. Полный разбор — [Коды ошибок](/ru/reference/error-codes).

## Асинхронные операции

Длительные операции (провижининг CDN, задания обновления агентов, восстановление) выполняются асинхронно: метод создаёт операцию/задание и возвращает её идентификатор, а статус запрашивается отдельным методом. Не считайте операцию завершённой по факту создания — дождитесь финального статуса.

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