mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-11-17 16:14:45 +03:00
9b91f0f42e
Fold the standalone 3x-ui-docs project (Next.js 16 + Fumadocs, deployed to docs.sanaei.dev) into docs/ so the panel and its documentation share a single source of truth, the way sing-box keeps its docs in-tree. The old repo becomes redundant and can be retired. - Import the full site under docs/ (app, components, content, lib, public, scripts, config). The self-contained pnpm project sits alongside the existing engineering notes with no filename collisions. - Re-point "Edit on GitHub" links from MHSanaei/3x-ui-docs to this repo's docs/content/docs path (docs/lib/shared.ts, docs/app/.../page.tsx). - Add docs-ci.yml and docs-deploy.yml under .github/workflows/, scoped to docs/** and run with working-directory: docs, since GitHub only runs workflows from the repo-root .github/. deploy-static.yml's GitHub Pages publish (CNAME docs.sanaei.dev) carries over unchanged. Follow-up (outside this commit): attach the docs.sanaei.dev custom domain to this repository's Pages (or set the Vercel project's root directory to docs), confirm the site is live from the monorepo, then delete MHSanaei/3x-ui-docs.
41 lines
1.3 KiB
Plaintext
41 lines
1.3 KiB
Plaintext
---
|
|
title: API Reference
|
|
description: The 3x-ui panel REST API — authentication, inbounds, clients, server stats, and more, generated from the OpenAPI spec.
|
|
icon: Webhook
|
|
---
|
|
|
|
The 3x-ui panel exposes a REST API for automation. These pages are generated from
|
|
the panel's OpenAPI specification, so they always match the documented schema.
|
|
|
|
## Authentication
|
|
|
|
Requests authenticate with either a **session cookie** (from `POST /login`) or a
|
|
**Bearer token**:
|
|
|
|
```text
|
|
Authorization: Bearer <token>
|
|
```
|
|
|
|
Create API tokens in the panel; they are full-admin credentials, so store them
|
|
securely. See [API Tokens](/docs/reference/api/api-tokens).
|
|
|
|
Build an authenticated request for any endpoint below:
|
|
|
|
<ApiRequestBuilder />
|
|
|
|
## Browse by area
|
|
|
|
<Cards>
|
|
<Card title="Authentication" href="/docs/reference/api/authentication" />
|
|
<Card title="Inbounds" href="/docs/reference/api/inbounds" />
|
|
<Card title="Clients" href="/docs/reference/api/clients" />
|
|
<Card title="Server" href="/docs/reference/api/server" />
|
|
<Card title="Settings" href="/docs/reference/api/settings" />
|
|
<Card title="Xray Settings" href="/docs/reference/api/xray-settings" />
|
|
</Cards>
|
|
|
|
<Callout type="info">
|
|
This reference is regenerated from `public/openapi.json` with `pnpm gen:api`.
|
|
Don't edit the generated tag pages by hand.
|
|
</Callout>
|