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

> General rules for working with the Axottle API: confirmations, filters, idempotence, trottling.

Understanding these agreements simplifies integration and reduces the risk of unwanted changes.

## Confirmation of hazardous operations

Destructive and irreversible operations require explicit confirmation in the body of the request — usually a `confirm: true` flag. Without confirmation, the method returns a preview or failure, but does not perform the action.

Examples of confirmation transactions:

* Restore the panel from a backup (overwrite the database);
* application of the Flow configuration;
* Destructive actions of the Axosun assistant (in addition, pass through the confirmation card).

> [!WARNING]
>
> Always ask for a preview first (`preview`/`restore-preview`/`compile-plan`), make sure the result is expected, and only then submit a confirmed request.

## Filters and sampling limitation

List methods support filtering and response size limitation where applicable:

* The audit log accepts the `?q=` line filter and the entries limit parameter.
* Node metrics are limited to a time window (`?since=`).
* Answers where a complete sample would be redundant return counters and limited samples, rather than complete lists.

The exact parameters are indicated on the pages of the relevant methods.

## "Retained"  ⁇  "Applicated"

For functions where the configuration is first saved and then applied on nodes (Flow, Egress Guard), the API distinguishes between these states. The answer shows whether the change has already been applied (`applied`) or is only saved and awaiting application. Do not consider the change effective until it is applied and verified.

## Idempotence and provisioning

Providing operations (e.g. CDN automation) are idempotent: restarting does not create duplicates, but proceeds from the current state, such operations maintain a state log that tracks progress and possible rollback.

## trottling

## Status and errors

Methods return standard HTTP statuses. Complete parsing - [Error Codes](https://docs.axottle.com/en/reference/error-codes.md).

## Asynchronous operations

Long-term operations (CDN maintenance, agent update tasks, recovery) are asynchronous: the method creates an operation/task and returns its identifier, and the status is requested by a separate method. Do not consider the operation completed upon creation, wait for the final status.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.