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

# Guide to API Methods

> Axottle’s core API methods are: path, method, access, and destination.

This page is a sectioned directory of the basic techniques that the panel operator works with, covering the administrative API, public methods, and agent methods.

> [!NOTE]
>
> For whom: Developer who integrates with Axottle; Administrator who automates routine.
> Required rights: Active Administrator Session for Session Access Methods. Start with [Review API](https://docs.axottle.com/en/api-reference/overview.md), [Authentication](https://docs.axottle.com/en/api-reference/authentication.md) and [Agreements](https://docs.axottle.com/en/api-reference/conventions.md).

> [!NOTE]
>
> It's **curated** The OpenAPI machine-readable specification is planned, but not yet published. If the method is not in the tables below, it does not mean that it does not exist; it contains what the operator most often needs.

## How to read tables

* **Basic address.** All paths with prefix. `/api/v1` It is located on the address of your panel, for example. `https://panel.example.com/api/v1`Paths beginning with `/agent`, `/s`, `/health` or `/install`They live at the root (without it). `/api/v1`).
* **Path parameters** are recorded in brackets: `{id}`, `{token}`, `{node_id}`.
* **Access Column** is defined as:
  * **Public** - Authentication is not required.
  * **Session** - you need an administrator session token (`Authorization: Bearer <session-token>`).
  * **Agent Token** – The method calls the node agent with its token, not an administrator session; it is not manually called.
  * **Public (trottling)** Public method with restriction of frequency of requests`429` + `Retry-After`).

> [!WARNING]
>
> Access "Session" means a valid session, but not unconditional access: methods additionally check the **rights of the account**. A request for a section to which the user is not entitled is rejected with `403` and a message stating the required right. The full access account passes all checks. The section rights directory is [Access rights](https://docs.axottle.com/en/security/authorization.md).

All examples use placeholders (`panel.example.com`, `{id}`, `axt_xxxxxxxx...`).

## Authentication and sessions

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| POST | `/api/v1/auth/login` | Public | Entry by `{username, password}`; returns session token and expiry date of | |
| POST | `/api/v1/auth/logout` | Session | End current session (works and read-only) | |
| GET | `/api/v1/auth/me` | Session | Current user: id, name, display name, rights (`permissions`), | superuser feature |
| GET | `/api/v1/setup/status` | Public | Flags of the steps of the initial installation | |
| POST | `/api/v1/setup/mode` | Public | Panel Mode: with Remnawave or standalone | |
| POST | `/api/v1/setup/admin` | Public (prior to administrator creation) | Create a single administrator; password is not shorter than 8 characters | |
| POST | `/api/v1/setup/domain` | Public | Assign domain and SSL mode | |
| POST | `/api/v1/setup/domain/check` | Public | Check the DNS record of the | domain |
| POST | `/api/v1/setup/remnawave/bootstrap` | Public | Auto-connection jointly installed Remnawave (only for such installations) | |

`/api/v1/setup/*` methods are available only during the initial installation; the creation of an administrator is rejected after the first administrator appears.

Read more: [Authentication](https://docs.axottle.com/en/api-reference/authentication.md), [Access and sessions](https://docs.axottle.com/en/panel/access-and-sessions.md).

## Accounts and rights

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| GET | `/api/v1/auth/permissions` | Session | Directory of rights grouped by panel sections (dictionary for the interface) | |
| GET | `/api/v1/auth/accounts` | Session + `accounts.manage` | List of accounts: login methods, rights, support role, last login | |
| POST | `/api/v1/auth/accounts` | Session + `accounts.manage` | Create a user: profile, login method, rights (`permissions`), support role | |
| PATCH | `/api/v1/auth/accounts/{id}` | Session + `accounts.manage` | Change the displayed name, status, rights or role in support of | |
| DELETE | `/api/v1/auth/accounts/{id}` | Session + `accounts.manage` | Delete | account |
| POST | `/api/v1/auth/change-password` | Session | Change **with its** password; the remaining sessions end with | |

The rights are transferred by an array of keys: `{"permissions": ["nodes.view", "nodes.edit"]}`. Full access is denoted by one element `["*"]`, and it is substituted if the field is not transmitted.

Restrictions on changing rights:

| Situation | Response |
| - | - |
| Change the rights of your own account | `400` |
| Unknown right key or blank list | `400` |
| Attempt to restrict the rights of | `409` |
| Attempt to restrict the last user with full access | `409` |

Changes apply from the following user request; sessions do not end.

Read more: [Access rights](https://docs.axottle.com/en/security/authorization.md), [Accounts and login](https://docs.axottle.com/en/panel/access-and-sessions.md).

## System and status

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| GET | `/health` | Public | Vitality Check: status, time stamp, version of | |
| GET | `/ping` | Public | Simple response `200` (used by update script) | |
| GET | `/api/v1/system/status` | Public | Panel status, DB connection, `setup_done`, uptime | |
| GET | `/api/v1/panel/version` | Public | Current and available panel version of | |
| POST | `/api/v1/panel/check` | Session | Forced verification of | panel updates |
| GET | `/api/v1/panel/checks` | Session | Update history | |
| GET/PUT | `/api/v1/panel/update-config` | Session | Panel Update Source (secrets hidden) | |
| POST | `/api/v1/panel/upgrade` | Session | Launch the panel update (separate process) | |
| GET | `/api/v1/panel/upgrade/status` | Session | Update Recovered from | |

Read more: [Updates to the](https://docs.axottle.com/en/operations/updates.md) panel.

## Flow (Configs)

Flow is a user name for Connection Unit. The `/api/v1/connection-units` paths, ID fields, and rights of `connection_units.*` have not been renamed. All methods below require a session; the specified permission is also checked.

| Method | Way | Right | Appointment | |
| - | - | - | - | - |
| GET | `/api/v1/connection-units` | `connection_units.view` | List of Flow including draft status, applications and observations of | |
| POST | `/api/v1/connection-units` | `connection_units.create` | Create a regular Flow | |
| GET | `/api/v1/connection-units/node-occupancies` | `connection_units.view` | Use of physical nodes by different Flow | |
| GET | `/api/v1/connection-units/{id}` | `connection_units.view` | Read Flow | |
| PATCH | `/api/v1/connection-units/{id}` | `connection_units.edit` | Modify settings | |
| DELETE | `/api/v1/connection-units/{id}` | `connection_units.delete` | Delete Flow and clear managed resources | |
| GET | `/api/v1/connection-units/{id}/delete-preview` | `connection_units.view` | Impact of removal of | |
| GET | `/api/v1/connection-units/{id}/graph` | `connection_units.view` | Read | |
| PUT | `/api/v1/connection-units/{id}/graph` | `connection_units.edit` | Save draft graph | |
| POST | `/api/v1/connection-units/{id}/autosave` | `connection_units.edit` | Autosave Graph | |
| POST | `/api/v1/connection-units/{id}/discard-draft` | `connection_units.edit` | Reset the draft to the applied image | |
| GET | `/api/v1/connection-units/{id}/versions` | `connection_units.view` | History of | |
| GET | `/api/v1/connection-units/{id}/versions/{versionId}` | `connection_units.view` | Photo version of | |
| POST | `/api/v1/connection-units/{id}/compile` | `connection_units.edit` | Gather | Plan |
| GET | `/api/v1/connection-units/{id}/compile-plan` | `connection_units.view` | Last Plan | |
| POST | `/api/v1/connection-units/{id}/lint` | `connection_units.view` | Static configuration audit | |
| POST | `/api/v1/connection-units/{id}/preflight` | `connection_units.apply` | Linter and pre-inspection plan | |
| POST | `/api/v1/connection-units/{id}/apply` | `connection_units.apply` | Expand the plan viewed | |
| GET | `/api/v1/connection-units/{id}/failure-scenarios` | `connection_units.view` | Written by Failure Lab | |
| POST | `/api/v1/connection-units/{id}/simulate` | `connection_units.view` | Failure calculation without changing the | infrastructure |
| GET | `/api/v1/connection-units/verification` | `connection_units.view` | Status of | bench inspections |
| GET | `/api/v1/connection-units/verification/profile-template` | `connection_units.view` | Stand profile template | |

### Finding and Verifying Reality Goals

| Method | Way | Right | Appointment | |
| - | - | - | - | - |
| POST | `/api/v1/connection-units/reality-target-scans/estimate` | `connection_units.edit` | Rate the search task | |
| GET | `/api/v1/connection-units/reality-target-scans` | `connection_units.view` | List of assignments | |
| POST | `/api/v1/connection-units/reality-target-scans` | `connection_units.edit`, `nodes.operate` | Run a search from the node | |
| GET | `/api/v1/connection-units/reality-target-scans/{jobId}` | `connection_units.view` | | |
| POST | `/api/v1/connection-units/reality-target-scans/{jobId}/cancel` | `connection_units.edit`, `nodes.operate` | Request cancellation of | |
| GET | `/api/v1/connection-units/reality-target-candidates` | `connection_units.view` | Candidates and data freshness | |
| POST | `/api/v1/connection-units/reality-target-candidates/{candidateId}/verify` | `connection_units.edit`, `nodes.operate` | Separate suitability test | |
| GET | `/api/v1/connection-units/reality-target-candidates/{candidateId}/verification` | `connection_units.view` | Last Test of | Candidate |
| DELETE | `/api/v1/connection-units/reality-target-candidates/{candidateId}` | `connection_units.edit` | Archive candidate | |
| POST | `/api/v1/connection-units/reality-target-candidates/{candidateId}/restore` | `connection_units.edit` | Restoration of the | catalog entry |

Search doesn't change a working Flow. To apply a goal, you need up-to-date suitability and a regular, proven Flow plan.

### Application of the plan reviewed

After compilation, use `id` and `revision` of the resulting plan:

```json theme={null}
{
  "expected_compile_plan_id": "<plan-id>",
  "expected_compile_revision": "<plan-revision>",
  "enable_remnawave_serve_json_at_base_subscription": false,
  "confirm_unresolved_dns": false,
  "force_recreate_remnawave_resources": false,
  "force_apply": false
}
```

This is a panel request form, not a universal application permission. Confirmation settings are activated only after reviewing the relevant changes. If you have an outdated plan or change the pool, perform a new compilation and re-view; do not repeat the application of the old revision blindly.

`force_apply` is a separate, explicit acceptance of the risk of unconfirmed listener readiness, firewall, and REALITY target. It does not eliminate compilation errors, found port conflicts, or audit checks. The result saves bypassed checks: [mode boundaries](https://docs.axottle.com/en/connection-units/lifecycle.md#принудительное-применение).

The manual "Versions → Roll Back" button takes a snapshot of the version and saves it to the draft graph, after which application is required. A separate `/rollback` route for this button is not used.

### Transit pools and politicians

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| GET/POST | `/api/v1/node-groups` | Session + `nodes.view` / `nodes.edit` | List/Creation of | pool |
| GET/PUT/DELETE | `/api/v1/node-groups/{id}` | Session + `nodes.view` / `nodes.edit` | Reading / change graph and policy / delete | |
| PUT | `/api/v1/node-groups/{id}/members` | Session + `nodes.edit` | Modification of composition to take into account the limitations of | |
| GET | `/api/v1/node-groups/{id}/flow-impact` | Session + `nodes.view` | Affected by Flow | |
| POST | `/api/v1/node-groups/{id}/relink/preview` | Session + `nodes.edit` | Preliminary effect of | binding |
| POST | `/api/v1/node-groups/{id}/relink/review` | Session + `nodes.edit` | Inspection of | re-binding plan |
| POST | `/api/v1/node-groups/{id}/relink/apply` | Session + `nodes.edit`, `connection_units.apply` | Managed application to Flow | |
| GET | `/api/v1/node-groups/{id}/relink/apply/{operationID}` | Session + `nodes.view`, `connection_units.view` | Operation status | |
| POST | `/api/v1/node-groups/{id}/relink/apply/{operationID}/rollback` | Session + `nodes.edit`, `connection_units.apply` | Operation | |
| GET/POST | `/api/v1/transit-pool-policies` | Session + `nodes.view` / `nodes.edit` | List/Creation of reused policy | |
| GET/PUT/DELETE | `/api/v1/transit-pool-policies/{id}` | Session + `nodes.view` / `nodes.edit` | Reading / Modification / Deletion of | Policy |

The compatible `/api/v1/flow-balancers` policy address is also saved. Catalog saving doesn't turn the new image into running Flow.

### Health and Flow Guard

The methods in this group require `health.view` to read and `health.manage` to modify.

| Method | Way | Appointment | |
| - | - | - | - |
| GET | `/api/v1/health/connection-units/analytics` | Combined Analytics Flow | |
| GET | `/api/v1/health/connection-units/{id}/diagnostics` | Diagnostics running version of | |
| GET | `/api/v1/health/connection-units/{id}/destination-failures` | Observations of | appointment refusals |
| GET | `/api/v1/health/connection-units/{id}/timeline` | Incident and Operation History of | |
| GET | `/api/v1/health/connection-units/{id}/recovery/plans` | Available recovery plans | |
| GET/PUT | `/api/v1/health/connection-units/{id}/recovery/autonomy` | Read/Save Automation Policy | |
| GET/POST | `/api/v1/health/connection-units/{id}/recovery/custom-plans` | List/creation of | custom plan |
| POST | `/api/v1/health/connection-units/{id}/recovery/custom-plans/validate` | Plan Check without | Launch |
| GET/PUT/DELETE | `/api/v1/health/connection-units/{id}/recovery/custom-plans/{planId}` | Read/modify/archive | plan |
| POST | `/api/v1/health/connection-units/{id}/recovery/dry-run` | Preliminary recovery check | |
| GET/POST | `/api/v1/health/connection-units/{id}/recovery/runs` | History/Creation of the launch of the | |
| GET | `/api/v1/health/connection-units/{id}/recovery/runs/{runId}` | Launch result and its steps | |
| POST | `/api/v1/health/connection-units/{id}/recovery/runs/{runId}/approve` | Confirm | Plan |
| POST | `/api/v1/health/connection-units/{id}/recovery/runs/{runId}/execute` | Perform confirmed launch of | |
| POST | `/api/v1/health/connection-units/{id}/recovery/runs/{runId}/validate` | Check the result | |
| POST | `/api/v1/health/connection-units/{id}/recovery/runs/{runId}/cancel` | Cancel | launch in an acceptable state |

The user plan does not receive automatic permission when saving: its version must be included in the Flow policy.Read more: [Flow Guard](https://docs.axottle.com/en/connection-units/recovery.md), [Application](https://docs.axottle.com/en/connection-units/lifecycle.md), [Transit Pools](https://docs.axottle.com/en/connection-units/transit-pools.md).

## Telegram proxy

The park uses the Flow Studio capability and existing `connection_units.*` rights. The connection link contains a secret, is issued separately and is not cached.

| Method | Way | Purpose and rights |
| - | - | - |
| GET | `/api/v1/telegram-proxies` | List; `connection_units.view` |
| GET | `/api/v1/telegram-proxies/site-templates` | Site Templates; `connection_units.view` |
| POST | `/api/v1/telegram-proxies/domain-check` | Test `node_id` and `node_domain_id`; `connection_units.view` + `nodes.view` |
| POST | `/api/v1/telegram-proxies` | Create a draft; `connection_units.create` |
| PUT | `/api/v1/telegram-proxies/{id}` | Save Settings; `connection_units.edit` |
| POST | `/api/v1/telegram-proxies/{id}/connection` | Receive link; `connection_units.apply` |
| POST | `/api/v1/telegram-proxies/{id}/deploy` | Install/Apply; `connection_units.apply` + `nodes.operate` |
| POST | `/api/v1/telegram-proxies/{id}/check` | Check runtime; same rights |
| POST | `/api/v1/telegram-proxies/{id}/stop` | Stop; same rights |
| POST | `/api/v1/telegram-proxies/{id}/remove` | Clean and Remove; `connection_units.delete` + `nodes.operate` |

Save the draft does not start the installation. The link corresponds to the last successfully installed configuration: [instruction](https://docs.axottle.com/en/connection-units/telegram-proxies.md).

## Nodes and agents

Node and agent management methods are called with an administrator session. `/agent/v1/*` methods are an exception: they are called by the node agent with its token.

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| GET/POST | `/api/v1/nodes` | Session | List/create node (creation starts installation) | |
| GET/PATCH/DELETE | `/api/v1/nodes/{id}` | Session | Reading / partial update / deletion (`409` when associated with circuits) | |
| POST | `/api/v1/nodes/{id}/preflight` | Session | Availability and Authentication Check by SSH | |
| POST | `/api/v1/nodes/{id}/install` | Session | Launch installation | |
| GET | `/api/v1/nodes/{id}/operations` | Session | Node Operation Log | |
| GET/POST | `/api/v1/nodes/{id}/events` | Session | Operational Log of Nodes (POST - UI telemetry, secrets are cleaned) | |
| GET | `/api/v1/nodes/{id}/agent` | Session | Node agent (or empty) | |
| POST | `/api/v1/nodes/{id}/agent/enrollment-token` | Session | Release a one-time binding token (TTL 30 minutes) | |
| GET/DELETE | `/api/v1/nodes/{id}/agent/enrollment-tokens/{token_id}` | Session | List/revocation of | binding tokens |
| POST | `/api/v1/nodes/{id}/agent/ssh-check` | Session | One-time SSH suitability check | |
| POST | `/api/v1/nodes/{id}/agent/ssh-install` | Session | Installation of SSH agent (SSE stream) | |
| GET | `/api/v1/nodes/{id}/agent/metrics` | Session | Time Series Metrics (`?since=`) | |
| GET | `/api/v1/nodes/{id}/agent/services` | Session | Service Status Snapshot (`?refresh=1`) | |
| GET/POST | `/api/v1/nodes/{id}/agent/tasks` | Session | Task list/setting from the white list of | |
| POST | `/api/v1/nodes/{id}/agent/tasks/sync` | Session | Synchronous execution (separate, narrower whitelist) | |
| POST | `/api/v1/nodes/{id}/agent/update` | Session | Set Agent Self-Renewal Task (`409`, if already on version) | |
| GET | `/api/v1/nodes/{id}/agent/update-jobs` | Session | Agent Update Task Story | |
| GET | `/api/v1/agent/releases/latest` | Session | Metadata of the latest release of agent | |
| POST | `/api/v1/agent/releases/refresh` | Session | Forced to re-read | release |
| GET/PUT | `/api/v1/agent/update-config` | Session | Agent Update Source (token hidden) | |
| GET | `/install/axottle-agent.sh` | Public | Agent Installation Script | |
| GET | `/install/axottle-agent-linux-{arch}` | Public | Ready Agent Binary (amd64/arm64) | |
| GET | `/install/agent/{version}/{filename}` | Public | Verified by SHA-256 cache of the | binary |
| POST | `/agent/v1/enroll` | Public (one-time token) | Agent Binding | |
| POST | `/agent/v1/heartbeat` | Agent Token | Vitality and Metadata of Host | |
| POST | `/agent/v1/metrics` | Token Agent | Reception metrics | |
| POST | `/agent/v1/services` | Agent Token | Receiving Service Statuses | |
| GET | `/agent/v1/tasks/poll` | Token Agent | Take the task (`204`, if no tasks) | |
| POST | `/agent/v1/tasks/{id}/result` | Token Agent | Send the result of the problem | |
| GET | `/agent/v1/qos-overrides` | Agent Token | Active Speed Limits | |
| POST | `/agent/v1/abuse-signals` | Agent Token | Locally spotted | Abuse signal |
| POST | `/agent/v1/session-diversity` | Agent Token | Session Variety Snapshots | |

Read more: [Nody](https://docs.axottle.com/en/nodes/overview.md), [Agent binding](https://docs.axottle.com/en/nodes/enrollment.md).

### Node domains

| Method | Way | Purpose and rights |
| - | - | - |
| GET | `/api/v1/nodes/{id}/domains` | List; `nodes.view` |
| | `/api/v1/nodes/{id}/domains` | Add; `nodes.edit` |
| PUT | `/api/v1/nodes/{id}/domains/{domainID}` | Change or assign primary; `nodes.edit` |
| DELETE | `/api/v1/nodes/{id}/domains/{domainID}` | Remove unused non-primary binding; `nodes.edit` |
| POST | `/api/v1/nodes/{id}/domains/{domainID}/check` | Check DNS; `nodes.view` |
| POST | `/api/v1/nodes/{id}/domains/{domainID}/dns` | AutoDNS; `nodes.operate` |
| POST | `/api/v1/nodes/{id}/domains/{domainID}/certificate/issue` | Release certificate; `nodes.operate` |
| POST | `/api/v1/nodes/{id}/domains/{domainID}/certificate/inspect` | Check Certificate; `nodes.operate` |

The Flow input selects the binding via `node_domain_id`. The derivative domain name is allowed by the server; the other person's binding is rejected.

## CDN and DNS

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| GET | `/api/v1/cdn-providers` | Session | Providers + schema of credentials fields and | automation feature |
| GET/POST | `/api/v1/cdn-provider-accounts` | Session | List / connect account provider | |
| GET/PATCH/DELETE | `/api/v1/cdn-provider-accounts/{id}` | Session | Read/change/delete account (`409`, if used) | |
| POST | `/api/v1/cdn-provider-accounts/{id}/revalidate` | Session | Re-check credentials | |
| GET/POST | `/api/v1/admin/cdn/dns-connections` | Session | DNS connection for CDN | |
| GET/POST/PATCH | `/api/v1/admin/cdn/domain-pools` | Session | Delivery Domain Pools | |
| GET/POST/PATCH | `/api/v1/admin/cdn/automation-policies` | Session | Automation Policy CDN | |
| GET | `/api/v1/cdn/operations/{id}` | Session | Status, plan and step of operation CDN | |
| POST | `/api/v1/cdn/operations/{id}/rollback` | Session | Rollback Operation (for READY prohibited - `409`) | |
| GET | `/api/v1/cdn/resources` | Session | List of created resources CDN | |
| GET/PUT | `/api/v1/integrations/cloudflare` | Session | Listing/Creating Cloudflare Zone Reference (AutoDNS; Write Only Token) | |
| DELETE | `/api/v1/integrations/cloudflare/{id}` | Session | Remove the binding (existing DNS records remain) | |
| POST | `/api/v1/integrations/cloudflare/{id}/test` | Session | Check token, zone access and DNS rights | |

The CDN itself is performed inside the `POST /api/v1/connection-units/{id}/apply`, which does not have a separate method.

Read more: [CDN](https://docs.axottle.com/en/cdn/overview.md), [DNS](https://docs.axottle.com/en/cdn/dns.md).

### One-time Cloudflare setup

`POST /api/v1/setup/cloudflare/dns` requires a session and `settings.manage` Fields: `domain`, `server_ip`, write-only token `api_token`, optional `save_integration` (default `false`). The result contains `root_domain`, `created`, when saved - integration without a token; `save_error` can report a saving error after a successful DNS write. Do not repeat the change blindly: first check the result.

## Health and self-heal

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| GET | `/api/v1/health/summary` | Session | Dashboard cards + hidden suppression | |
| GET | `/api/v1/health/dashboard` | Session | Summary, tables and incidents with one response | |
| GET | `/api/v1/health/nodes` | Session | Node table (filters: status, country, provider) | |
| GET | `/api/v1/health/connection-units` | Session | Connection Scheme Table | |
| GET | `/api/v1/health/routes` | Session | Route Table | |
| GET | `/api/v1/health/incidents` | Session | Incident tape (`since`, `limit`, `include_suppressed`) | |
| POST | `/api/v1/health/recheck` | Session | Recheck all used Flow | |
| GET/PUT | `/api/v1/health/settings` | Session | Monitoring Policy (intervals, channels, AI trigger) | |
| GET | `/api/v1/health/connection-units/{id}` | Session | Cash summary according to the | scheme |
| POST | `/api/v1/health/connection-units/{id}/check` | Session | Fresh full check (one dial attempt) | |
| GET | `/api/v1/health/connection-units/{id}/probes` | Session | Sample history (≤ 500) | |
| GET | `/api/v1/health/connection-units/{id}/diagnostics` | Session | Diagnostic evidence package | |
| POST | `/api/v1/health/connection-units/{id}/diagnostics/logs` | Session | Node Log Collection (trimmed and edited) | |
| GET | `/api/v1/health/connection-units/{id}/dependency-tree` | Session | Dependency Tree Scheme | |
| GET/POST | `/api/v1/health/connection-units/{id}/entry-blocks/{blockId}/external-probe` | Session | External regional samples L5 | |
| GET/POST | `/api/v1/health/nodes/{id}` | Session | Node Summary / Launch | |
| GET | `/api/v1/health/nodes/{id}/probes` | Session | Node Test History | |
| GET/PUT/DELETE | `/api/v1/health/external-providers` | Session | L5 Register of External Providers and Their Methods | |
| POST | `/api/v1/nodes/status-refresh` | Session | Update Remnawave image + health check throughout | Park |
| POST | `/api/v1/nodes/{id}/status-refresh` | Session | Same for one | Node |
| GET/POST/DELETE | `/api/v1/nodes/{id}/suppression` | Session | View / create-replace / remove the "stub" of the | node |

Read more: [Health](https://docs.axottle.com/en/health/overview.md), [Self-heal](https://docs.axottle.com/en/health/self-heal.md).

### Bscheck history

`GET /api/v1/health/connection-units/{id}/bscheck-reports` returns saved external Flow reports (up to 100). This is a history reading, not a paid validation run. Interpretation of the result and its freshness: [Bscheck](https://docs.axottle.com/en/health/bscheck.md).

## Statuspage Update

| Method | Way | Appointment |
| - | - | - |
| GET | `/api/v1/statuspage/instances/{instanceID}/update` | Check the application version of the page |
| POST | `/api/v1/statuspage/instances/{instanceID}/update/command` | Get a command for a selected `version`; the update itself does not run |
| POST | `/api/v1/statuspage/instances/{instanceID}/update/ssh` | Update the existing server to SSH |

Reading requires `statuspage.view`, modifying methods - also `statuspage.deploy`. Check the running version and enrollment after surgery: [update Statuspage](https://docs.axottle.com/en/statuspage/updates.md).

## Remnawave

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| POST | `/api/v1/remnawave/test` | Session | Verify URL and token without saving | |
| GET/POST | `/api/v1/remnawave/connections` | Session | List / create a connection to the | panel |
| GET | `/api/v1/remnawave/connections/{id}` | Session | One | Connection |
| POST | `/api/v1/remnawave/connections/{id}/test` | Session | Check the saved connection (updates status) | |
| POST | `/api/v1/remnawave/connections/{id}/sync` | Session | Synchronize local shots (manually) | |
| DELETE | `/api/v1/remnawave/connections/{id}` | Session | Remove the connection and his pictures | |
| GET | `/api/v1/remnawave/connections/{id}/diagnostics` | Session | Live panel diagnostics | |
| GET | `/api/v1/remnawave/users` | Session | Local snapshot of | users |
| GET | `/api/v1/remnawave/nodes` | Session | Local Node Photo | |
| GET | `/api/v1/remnawave/hosts` | Session | Local Hostshot of | |
| GET | `/api/v1/remnawave/config-profiles` | Session | Local snapshot of | config profiles |
| GET | `/api/v1/remnawave/internal-squads` | Session | Live list of squad panel | |
| GET/POST | `/api/v1/remnawave/connections/{id}/backup-profiles` | Session | Remnawave | database backup profiles |
| GET/PATCH/DELETE | `/api/v1/remnawave/backup-profiles/{profileId}` | Session | Copy Profile Management | |
| POST | `/api/v1/remnawave/backup-profiles/{profileId}/test` | Session | Check access to the backup target of | |
| GET/POST | `/api/v1/remnawave/backup-profiles/{profileId}/backups` | Session | List/Run copies of | |
| GET | `/api/v1/remnawave/backups/{backupId}` | Session | Record run of a copy of | |
| POST | `/api/v1/remnawave/backups/{backupId}/verify` | Session | Integrity Test | |
| GET | `/api/v1/remnawave/backups/{backupId}/restore-plan` | Session | Recovery Preview | |
| POST | `/api/v1/remnawave/backups/{backupId}/restore` | Session | Restoration (requires `confirm: true`) | |
| DELETE | `/api/v1/remnawave/backups/{backupId}` | Session | Delete copy record of | |

Read more: [Remnawave](https://docs.axottle.com/en/remnawave/overview.md).

## AbuseProtect

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| GET | `/api/v1/abuse/summary` | Session | Dashboard Summary Abusive | |
| GET/POST | `/api/v1/abuse/incidents` | Session | List/Manual discovery of the | incident |
| GET | `/api/v1/abuse/incidents/{id}` | Session | Incident with signals, timeline, limitations | |
| POST | `/api/v1/abuse/incidents/{id}/event` | Session | Add note or change status | |
| POST | `/api/v1/abuse/incidents/{id}/close` | Session | Close as `resolved` or `false_positive` (reason needed) | |
| POST | `/api/v1/abuse/incidents/{id}/status` | Session | Transition status | |
| POST | `/api/v1/abuse/incidents/{id}/evidence` | Session | Collect and Attach Evidence of | |
| GET/POST | `/api/v1/abuse/qos-overrides` | Session | List/Apply temporary deceleration | |
| DELETE | `/api/v1/abuse/qos-overrides/{id}` | Session | Manually Decelerate | |
| GET | `/api/v1/abuse/service-identities` | Session | Secure Infrastructure Accounts | |
| GET | `/api/v1/abuse/signals` | Session | Raw Detector Signals | |
| POST | `/api/v1/abuse/detect` | Session | Launch one detection pass now | |
| GET/PUT | `/api/v1/abuse/policy` | Session | Reading / Preserving | Policy |
| GET/PUT | `/api/v1/abuse/telegram` | Session | Telegram Routing (token masked) | |
| POST | `/api/v1/abuse/telegram/test` | Session | Send test notification to | |
| GET | `/api/v1/abuse/apply-status` | Session | Badge "Applied/Absent" by node (`?node=`) | |
| GET | `/api/v1/abuse/user-profile` | Session | User Abuse Profile (`?user=`) | |

The agent additionally delivers telemetry via `POST /agent/v1/abuse-signals` and `POST /agent/v1/session-diversity` (see Nodes and Agents section).

Read more: [AbuseProtect](https://docs.axottle.com/en/abuse/overview.md).

## Axosun - Assistant

| Method | Way | Access | Purpose |
| - | - | - | - |
| - | Assistant Management - through the | Panel Session | Section **Axosun** in the panel: profiles, policies, action directory, sessions, history |

> [!NOTE]
>
> The direct paths of the assistant API here **are not intentionally published by Z**: they contain an internal name that we do not disclose in the public documentation. Manage the assistant through the **Axosun** section in the panel. Opportunities, rights and confirmation procedures are described separately.

Read more: [Axosun](https://docs.axottle.com/en/axosun/overview.md).

## Security

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| GET/POST | `/api/v1/security-profiles` | Session | List / create a security profile | |
| GET | `/api/v1/security-profiles/{id}` | Session | Get a profile of | |
| GET/POST | `/api/v1/nodes/{id}/security-services/compliance` | Session | Reading/Run Compliance Check (CrowdSec, Fail2Ban, UFW) | |
| GET | `/api/v1/security/detectors/status` | Session | Status of detectors on all nodes | |
| GET | `/api/v1/security/detectors/status/{nodeId}` | Session | Status of detectors of one node | |
| GET | `/api/v1/security/dangerous-ports/catalog` | Session | Fixed Hazardous Port Catalogue | |
| GET/PUT | `/api/v1/security/egress` | Session | Reading/saving egress policy ("saved"  ⁇  "applyed") | |
| GET | `/api/v1/security/egress/status` | Session | Desirable vs Nodes | |
| POST | `/api/v1/security/egress/reconcile` | Session | Reapply the desired state | |
| GET | `/api/v1/decoy/templates` | Session | Catalog of Cloaking Site Templates | |
| GET/POST | `/api/v1/decoy/templates/{id}/preview` | Session | Preview template in sandbox | |
| GET/POST | `/api/v1/decoy/deployments` | Session | List/create a | mask deployment |
| GET/PATCH/DELETE | `/api/v1/decoy/deployments/{id}` | Session | Deployment Control | |
| POST | `/api/v1/decoy/deployments/{id}/install` · `/verify` · `/remove` | Session | Agent Actions: `202` + `task_id` | |
| GET/POST/PATCH/DELETE | `/api/v1/nodes/{id}/selfsteal` | Session | Cloaking Site (selfsteal) on the node: status, inclusion, depot, verification | |
| GET | `/api/v1/audit-log` | Session | Audit Journal (`limit` ≤ 500, `offset`, filter `q`) | |

Read more: [Security](https://docs.axottle.com/en/security/overview.md), [Audit and compliance ](https://docs.axottle.com/en/security/audit-and-compliance.md).

## Operational sections

Backups, notifications, geo-assets and providers, all methods below, with Session access, unless otherwise indicated.

### Backup copies of the panel

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| POST/GET | `/api/v1/backups/profiles` | Session | Create/list of | backup profiles |
| GET/PATCH/DELETE | `/api/v1/backups/profiles/{id}` | Session | Profile Management | |
| POST | `/api/v1/backups/profiles/{id}/test` | Session | Check Storage Purpose (local/S3) | |
| POST/GET | `/api/v1/backups/runs` | Session | Launch Now / run list | |
| GET | `/api/v1/backups/runs/{id}` | Session | Run Details | |
| POST | `/api/v1/backups/runs/{id}/verify` | Session | Integrity Test (SHA-256) | |
| GET | `/api/v1/backups/runs/{id}/restore-preview` | Session | Recovery Preview | |
| POST | `/api/v1/backups/runs/{id}/restore` | Session | Recovery (requires `confirm: true`, destroying operation) | |

Read more: [Backup copies of](https://docs.axottle.com/en/operations/backups.md).

### Notifications

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| GET/PUT | `/api/v1/notifications/telegram` | Session | Routing + Category Catalogue (token masked) | |
| POST | `/api/v1/notifications/telegram/test` | Session | Send test message (real error returns) | |
| GET | `/api/v1/notifications/telegram/helper/session` | Session | SSE session bot assistant (get chat id / topic id) | |
| POST | `/api/v1/notifications/telegram/helper/stop` | Session | Stop | Assistant Session |

For more information: [Notifications](https://docs.axottle.com/en/panel/notifications.md).

### Geoassets

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| GET/POST | `/api/v1/geo-assets/files` | Session | List/download of | geo-files |
| DELETE | `/api/v1/geo-assets/files/{id}` | Session | Delete | file |
| GET/POST | `/api/v1/geo-assets/profiles` | Session | List / create a profile of | |
| GET/DELETE | `/api/v1/geo-assets/profiles/{id}` | Session | Read/Delete | Profile |
| GET/POST | `/api/v1/geo-assets/profiles/{id}/sets` | Session | GeoSet profile cards | |
| GET/PATCH/PUT/DELETE | `/api/v1/geo-assets/profiles/{id}/sets/{set_id}` | Session | Control GeoSet | |
| POST | `/api/v1/geo-assets/sets/{set_id}/validate` | Session | Check (re-hash/download) set | |
| POST | `/api/v1/geo-assets/profiles/{id}/validate` | Session | Check the entire | profile |
| POST | `/api/v1/geo-assets/profiles/{id}/assign-bulk` | Session | Mass appointment of | node profile |
| POST/DELETE | `/api/v1/nodes/{node_id}/geo-asset-assignment` | Session | Assign / remove profile from the node | |
| GET | `/api/v1/nodes/{node_id}/geo-asset-state` | Session | State of geo-files on the node (by hashes) | |
| POST | `/api/v1/nodes/{node_id}/geo-asset-sync` | Session | Synchronize geo-data on the node | |
| GET/POST | `/api/v1/nodes/{node_id}/geo-asset-rollback` | Session | Availability of image / rollback to the previous set of | |
| GET | `/install/geo/{id}` | Public | Geo-file return to the agent (security - SHA-256 verification on the node) | |

Read more: [Geo-assets](https://docs.axottle.com/en/operations/geo-assets.md).

### Hosting providers

| Method | Way | Access | Purpose | |
| - | - | - | - | - |
| GET/POST | `/api/v1/providers/bundles` | Session | List/Installation of ISP Adapters (Manifesto) | |
| GET/DELETE | `/api/v1/providers/bundles/{id}` | Session | Read/remove | adapter |
| GET/POST | `/api/v1/providers/accounts` | Session | List/creation of | provider account |
| DELETE | `/api/v1/providers/accounts/{id}` | Session | Delete | account |
| POST | `/api/v1/providers/accounts/{id}/test` | Session | Check credentials | |
| GET | `/api/v1/providers/accounts/{id}/regions` | Session | Live list of regions | |
| GET | `/api/v1/providers/accounts/{id}/plans` | Session | Live fare list | |

> [!NOTE]
>
> There's no screen for these pens in the panel right now, because the servers are still being built through the ISP API, and they're off the menu, and the endpoints themselves are working, and they require the key. `core.cloud_providers`.


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