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

# Review of the API

> REST API Axottle panel: base address, version, public and protected areas.

The Axottle dashboard is managed via the REST API. The same API uses a built-in web interface, so any action in the dashboard is accessible and software-based.

> [!NOTE]
>
> For whom: Developer who integrates with Axottle; Administrator who automates routine.
> Required rights: Active Administrator session (see [Authentication](https://docs.axottle.com/en/api-reference/authentication.md)).

## Basic address and version

All administrative methods are located under the prefix `/api/v1` on your panel address:

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

The version of the API is specified in the path (`v1`). Incompatible changes will be released under the new version of the path.

## API Areas

> [card] Public methods
>
> This includes health checks (`GET /health`), scripts and agent installation files (`/install/...`).

> [card] Administrative methods
>
> It's all under `/api/v1/*`, requiring an admin session token.

> [card] Agent methods
>
> Under `/agent/v1/*`. Used by agents of nodes and authenticated by an agent token, not by an administrator session. Not intended for manual call.

## Format

* The query and response body is JSON (`Content-Type: application/json`).
* Errors are returned with the corresponding HTTP status. Directory - [Error Codes](https://docs.axottle.com/en/reference/error-codes.md).
* The public gateway uses trottling: if exceeded, the `429` with the `Retry-After` header returns.

## Next.

> [card] [Authentication](https://docs.axottle.com/en/api-reference/authentication.md)
>
> How to get and use a session token.

> [card] [Agreements](https://docs.axottle.com/en/api-reference/conventions.md)
>
> Pagination, filters, idempotence, confirmations.

> [card] [Methods](https://docs.axottle.com/en/api-reference/endpoints.md)
>
> Handbook of methods by section.


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