For whom: Developer who integrates with Axottle; Administrator who automates routine.
Required rights: Active Administrator Session for Session Access Methods. Start with Review API, Authentication and Agreements.
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/v1It is located on the address of your panel, for example.https://panel.example.com/api/v1Paths beginning with/agent,/s,/healthor/installThey 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).
panel.example.com, {id}, axt_xxxxxxxx...).
Authentication and sessions
/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, Access and sessions.
Accounts and rights
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:
Changes apply from the following user request; sessions do not end.
Read more: Access rights, Accounts and login.
System and status
Read more: Updates to the 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.
Finding and Verifying Reality Goals
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, useid and revision of the resulting plan:
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.
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
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 requirehealth.view to read and health.manage to modify.
The user plan does not receive automatic permission when saving: its version must be included in the Flow policy.Read more: Flow Guard, Application, Transit Pools.
Telegram proxy
The park uses the Flow Studio capability and existingconnection_units.* rights. The connection link contains a secret, is issued separately and is not cached.
Save the draft does not start the installation. The link corresponds to the last successfully installed configuration: instruction.
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.
Read more: Nody, Agent binding.
Node domains
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
The CDN itself is performed inside the
POST /api/v1/connection-units/{id}/apply, which does not have a separate method.
Read more: CDN, DNS.
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
Read more: Health, Self-heal.
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.
Statuspage Update
Reading requires
statuspage.view, modifying methods - also statuspage.deploy. Check the running version and enrollment after surgery: update Statuspage.
Remnawave
Read more: Remnawave.
AbuseProtect
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.
Axosun - Assistant
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.
Security
Read more: Security, Audit and compliance .
Operational sections
Backups, notifications, geo-assets and providers, all methods below, with Session access, unless otherwise indicated.Backup copies of the panel
Read more: Backup copies of.
Notifications
For more information: Notifications.
Geoassets
Read more: Geo-assets.
Hosting providers
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.