mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-07-02 10:34:23 +00:00
Sanaei
709b332d17
* test(sub): characterize current link output (externalProxy + single-link baselines)
Phase 0 of the Hosts feature. Locks current subscription-link output for the
externalProxy paths (vless/vmess/trojan/ss exact, reality/hysteria by Contains)
so the upcoming ShareEndpoint refactor can be proven behavior-preserving. These
must stay green and unedited through every later phase.
* refactor(sub): unify external-proxy link building behind ShareEndpoint (TDD, snapshot-locked)
Phase 1 of the Hosts feature. Collapse the duplicated externalProxy link
builders (param-form for vless/trojan/ss, object-form for vmess) onto a single
ShareEndpoint abstraction so Phase 4 can add Host-driven links with ~zero new
branching.
Design: an externalProxy-derived endpoint carries the original entry map and
applies it through the UNCHANGED applyExternalProxyTLS{Params,Obj} helpers, so
output is provably byte-identical. buildExternalProxyURLLinks /
buildVmessExternalProxyLinks become thin adapters; the genVless/Trojan/SS/Vmess
call sites are untouched. genHysteriaLink is deliberately left on its own path
(hex pinSHA256, not pcs). The no-externalProxy default tails are unchanged.
TDD: N1-N4 (externalProxyToEndpoint, inboundDefaultEndpoint, buildEndpointLinks,
buildEndpointVmessLinks) written failing-first against stubs, then implemented.
Mutation sanity (performed + reverted): dropping the ep-carry in
externalProxyToEndpoint makes the Phase-0 C1/C2 characterization snapshots go
red (TLS overrides vanish), proving the snapshots guard the emitted output.
Gate: go test ./internal/sub/... and go test ./... green with ZERO edits to the
Phase-0 snapshots; go build ./... green on linux and windows; go vet clean.
* feat(model): Host entity + automigrate + openapi codegen (TDD)
Phase 2 of the Hosts feature. Adds the Host GORM model: an override endpoint
attached to an inbound (address/port + TLS/transport/clash overrides + sub
scoping), superseding the legacy externalProxy array functionally while leaving
it intact.
- model.Host with snake_case column tags, json serializer for slices, text for
free-JSON (mux/sockopt/xhttp), validate tags (remark 1-40, port 0-65535,
security + mihomoIpVersion enums); TableName "hosts". NodeGuids column is added
now but unused (host->node scoping deferred to v2).
- Registered in BOTH initModels() (db.go) and migrationModels() (migrate_data.go);
the latter is required for cross-DB migration and is easy to miss. PG sequence
resync iterates the initModels slice, so it is covered automatically.
- pruneOrphanedHosts() deletes hosts whose inbound_id has no inbound, called
alongside pruneOrphanedClientInbounds().
- openapigen manifest: Host added to StructAllow with MuxParams/SockoptParams/
XhttpExtraParams -> KindAny; regenerated frontend/src/generated/* + openapi.json.
TDD: TestHostTableName, TestHostValidation, TestHostAutoMigrateCreatesColumns
(+ _Postgres), TestPruneOrphanedHosts written failing-first against a wrong-name,
untagged, unregistered stub, then implemented.
Gate: go test ./... green on SQLite AND a real Postgres DSN (local container);
go build/vet/gofmt clean; npm run gen succeeds with the new Host type/schema/
example/zod; npm run typecheck + npm run test (542) green.
* feat(api): Host CRUD service + controller + routes (TDD)
Phase 3 of the Hosts feature.
- service/host.go (HostService, empty struct + database.GetDB() like
ClientService): GetHosts, GetHostsByInbound, GetHost, AddHost (verifies the
inbound exists — no hard FK), UpdateHost (inbound + sort order immutable here),
DeleteHost, SetHostEnable, SetHostsEnable, DeleteHosts, ReorderHosts (single
driver-safe transaction), GetAllTags.
- controller/host.go mirrors NodeController: routes under /panel/api/hosts
(list/get/byInbound/tags + add/update/del/setEnable/reorder + bulk/setEnable,
bulk/del), binds via middleware.BindAndValidate so the model validate tags are
enforced, {success,msg,obj} envelopes.
- Wired the hosts group into api.go after nodes (inherits checkAPIAuth + CSRF).
- DelInbound now cascades: deleting an inbound deletes its hosts.
- Documented all 11 routes in api-docs endpoints.ts (referencing the generated
Host schema) and regenerated openapi.json; extended TestAPIRoutesDocumented's
controller->basePath switch for host.go. Backend en toast keys added.
TDD: service tests (Add/GetByInbound, RejectsUnknownInbound, Reorder, Set/Bulk
enable, DeleteHosts, DeleteInboundCascadesHosts, GetAllTags) written failing-
first against a nil-returning stub; controller test (AddListGetDelete envelope
round-trip + AuthInherited 401) added.
Gate: go test ./internal/web/... + go test ./... green; npm run gen + typecheck
+ lint + test (542) + build green.
* feat(sub): render subscription links from hosts; legacy fallback when none (TDD, mutation-checked)
Phase 4 of the Hosts feature. Inserts host resolution between inbound and link
across all three subscription formats.
Mechanism: hostEndpoints(inbound, format) loads the inbound's enabled hosts
(filtered by ExcludeFromSubTypes, ordered by sort_order then id) and projects
each onto the externalProxy entry shape the raw/json/clash renderers already
consume. So a host fans out one link/proxy reusing the exact existing rendering
(address/port/security/sni/fp/alpn/pins/ech) with zero new TLS code. Host header
and path overrides are applied additively in the raw builders (no-op for legacy
externalProxy, which never carries those keys — characterization snapshots stay
green). Clash ip-version (MihomoIpVersion) is set last on the proxy.
Integration points:
- getSubs (raw): per inbound, hostEndpoints AFTER projectThroughFallbackMaster;
len>0 -> linkFromHosts (renders only the hosts), else legacy GetLink.
- GetJson/GetClash: inject the host endpoints into the inbound's externalProxy
before the existing getConfig/getProxies loop.
- Precedence: hosts win over any legacy externalProxy (injection replaces it).
Backward compat: a zero-host inbound takes the legacy path -> byte-identical
output (all Phase-0 characterization snapshots unchanged).
TDD: 9 cycles (zero-hosts identical, N-links-ordered with host/path override,
disabled skipped, host-vs-externalProxy precedence, no-dedup, sort composes with
SubSortIndex, host-over-fallback, resolve-via-client-inbounds, ExcludeFromSubTypes
per format) written failing-first against unwired helpers, then wired green.
Mutation sanity (performed + reverted, documented here):
- zero-hosts fallback: flipping the len(hostEps)>0 guard to >=0 makes
TestSub_ZeroHosts_IdenticalOutput go red (host path yields "" for no hosts).
- no-dedup: adding a remark-dedup in hostEndpoints makes TestSub_NHosts_NoDedup
go red (two distinct hosts collapse to one link).
Gate: go test ./internal/sub/... + go test ./... green with ZERO edits to the
Phase-0 snapshots; go build green on linux and windows; go vet + gofmt clean.
* feat(migration): seed hosts from inbound externalProxy (TDD, idempotent, dual-driver)
Phase 5 of the Hosts feature. One-time migration so existing installs surface
their legacy externalProxy entries as first-class Host rows.
- seedHostsFromExternalProxy() is self-gated on a HistoryOfSeeders
"HostsFromExternalProxy" row (run-once) and wired into runSeeders. For each
inbound it parses StreamSettings, reads externalProxy[], and creates one Host
per entry: forceTls->Security (unknown->same), dest->Address, port->Port,
remark->Remark (generated when blank, capped at 40), sni/fingerprint/alpn/
pinnedPeerCertSha256/echConfigList copied; SortOrder=index; InboundId set.
- Additive: externalProxy is left intact in StreamSettings (rollback-safe; the
sub layer prefers hosts when present, §Phase 4).
- Postgres: GORM db.Create advances hosts_id_seq via the sequence, so no extra
resync is needed beyond the existing startup resync.
TDD: field-mapping, idempotency (second run no-op), no-externalProxy->no-hosts,
externalProxy-kept-intact written failing-first against a stub; plus a
Postgres counterpart that skips without XUI_DB_DSN.
Gate: go test ./internal/web/service/... ./internal/database/... green on SQLite;
the *_Postgres tests green against a real Postgres container; go build green on
linux and windows; go vet + gofmt clean. (Running the whole database package
under XUI_DB_TYPE=postgres is not supported — the SQLite-path tests share the one
DSN — so only the t.Skip-gated *_Postgres tests run with the env set.)
* feat(ui): Hosts page + schema + query hooks + link preview helper (TDD on schema/helpers)
Phase 6 of the Hosts feature — the admin UI.
- schemas/api/host.ts: HostFormSchema (validation: remark 1-40, tags ^[A-Z0-9_:]+$
≤10×≤36, port 0-65535, security/mihomoIpVersion enums, alpn/fingerprint reused
from the shared primitives) + a loose HostRecordSchema/HostListSchema for reads.
- lib/hosts/host-link.ts: hostToExternalProxyEntry — the frontend mirror of the
backend hostToExternalProxyMap (security->forceTls, sni override rules, port
inherit), for share-link previews.
- api/queries/useHostsQuery.ts + useHostMutations.ts (mirror the node hooks):
list/get + add/update/del/setEnable/reorder/bulk; queryKeys.hosts.* added;
mutations invalidate keys.hosts.root().
- pages/hosts/{HostsPage,HostList,HostFormModal}.tsx (+CSS) mirroring pages/nodes:
list with remark · address:port · inbound · security · tags · enable Switch ·
per-inbound move up/down (reorder) · bulk enable/disable/delete; form grouped
into Basic / Advanced / Clash / Subscription-scope sections.
- Route '/hosts' + sidebar item (Global icon); menu.hosts + pages.hosts.* added to
the en-US bundle (other locales fall back to English until translated).
TDD: HostFormSchema (10 cases) and hostToExternalProxyEntry (6 cases) written
failing-first, then implemented. UI verified by lint/typecheck/test/build.
Deferred (documented enhancement): the live in-form share-link preview (needs
inbound+client context) and a per-host host/path override in JSON/Clash output
(raw already overrides; JSON/Clash inherit the inbound's host/path).
Gate: cd frontend && npm run lint && npm run typecheck && npm run test (557) &&
npm run build all green; go build ./... + go test ./... still green.
* refactor(ui): remove the External Proxy form from the inbound stream settings
Hosts supersede the legacy externalProxy: the subscription renders from hosts
(hosts win when both exist) and the migration converts existing externalProxy
entries to hosts. externalProxy's only real consumers were the subscription
(now covered) and this form's preview — the backend per-client copy-link never
used it — so removing the editor has no functional regression.
- Drop ExternalProxyForm + toggleExternalProxy from InboundFormModal and delete
the orphaned form component + its export; remove its block test + snapshot.
- KEEP the externalProxy schema field and backend parsing/link-generation: an
existing inbound's externalProxy still round-trips through the form (not
silently destroyed on edit) and still renders if a host was removed.
Gate: cd frontend && npm run typecheck + lint + test (556) + build green.
* fix(ui): use Alert `title` instead of deprecated `message` (antd 6)
Ant Design 6 deprecated <Alert message=> in favor of <Alert title=>; the panel
was mid-migration (21 Alerts already on title). Renamed the 7 remaining stragglers
across 5 files (SubLinksModal, InboundFormModal, sockopt, EmailTab, TelegramTab),
silencing the runtime deprecation warning. description= is unchanged.
Pre-existing warning, surfaced while testing Hosts — not introduced by it.
Gate: npm run typecheck + lint + test (556) + build green.
* style(ui): align Hosts page with Clients/Inbounds cards + reorder columns
- page-shell.css never listed .hosts-page, so the Hosts page got no content
padding / transparent-layout / summary-card spacing. Add a .hosts-page shell
block (background, dark/ultra vars, content-area + summary-card padding). This
is the actual "card spacing" bug.
- HostList: match the Clients/Inbounds list card — hoverable + the toolbar moved
into the card title as a .card-toolbar (Add when nothing selected; selected
count + bulk enable/disable/delete on selection). Re-declare .card-toolbar in
HostList.css since the shared rule lives in a lazily-loaded page stylesheet.
- Reorder table columns as requested: Actions, Enable, then Remark, Endpoint,
Inbound, Security, Tags. Added scroll x for narrow screens.
- HostsPage: add a summary card (Total / Enabled / Disabled) like the other
pages. New i18n keys: pages.hosts.selectedCount + pages.hosts.summary.*.
Gate: npm run typecheck + lint + test (556) + build green.
* style(ui): use Tabs instead of Collapse in the Add/Edit Host form
The Basic / Advanced / Clash / Subscription-scope sections are now tabs. Each
pane sets forceRender so all fields stay mounted — required because the form
uses preserve=false, so an unmounted tab's values would otherwise be dropped on
submit (and a required field on a hidden tab still blocks submit).
Gate: npm run typecheck + lint + test (556) + build green.
* style(ui): split Host form into Security + Advanced tabs; drop unused JSON fields
- Remove the Mux/Sockopt/XHTTP raw-JSON fields from the Host form: they were not
wired into link generation and the inbound's structured editors are inbound-
specific (not reusable). The DB columns + read schema + generated type stay, so
they can get proper editors later. (HostFormSchema drops them; HostRecordSchema
keeps them.)
- Reorganize tabs to Basic / Security / Advanced / Clash / Subscription scope:
Security holds the TLS/cert fields (security, sni, sni-overrides, alpn,
fingerprint, pins, verify-by-name, ech); Advanced now holds the transport
overrides (host header, path).
- i18n: add pages.hosts.sections.security; drop the 3 unused field labels.
Gate: npm run typecheck + lint + test (556) + build green.
* style(ui): restore Mux/Sockopt/XHTTP fields in the Host Advanced tab
Put the three free-JSON override fields back, in the Advanced tab next to host
header / path (as JSON inputs — the inbound's structured editors aren't reusable
here). Re-added to HostFormSchema + defaults + the i18n labels.
Gate: npm run typecheck + lint + test (556) + build green.
* feat(hosts): add allowInsecure (rendered) + serverDescription/mihomoX25519/vlessRouteId fields
Closes most of the Remnawave-host gap analysis.
- model.Host: + allowInsecure, serverDescription (≤64), vlessRouteId (0-65535),
mihomoX25519. Auto-migrated (SQLite + Postgres verified); openapi regenerated.
- allowInsecure is fully RENDERED into subscription output (TDD):
- raw link: allowInsecure=1 (TLS/Reality, skipped for none) via the endpoint
builder;
- JSON/Clash: applyExternalProxyTLSToStream writes tlsSettings.settings.
allowInsecure, and clash applySecurity now emits skip-cert-verify for the tls
case (it previously only did so for Hysteria — a pre-existing gap, so inbound
allowInsecure now renders for vless/trojan/ss clash too).
- Frontend: the four fields added to the Host form (allowInsecure → Security,
serverDescription → Basic, vlessRouteId → Advanced, mihomoX25519 → Clash);
serverDescription shown under the remark in the list. Schema + i18n updated.
serverDescription / vlessRouteId / mihomoX25519 are stored + editable; their
deeper rendering (and per-host mux/sockopt/xhttp into JSON/Clash, plus a per-host
xray JSON template) are tracked as follow-ups.
Gate: go test ./... green (SQLite + Postgres for the host schema/migration);
go build linux+windows; go vet + gofmt clean; npm run gen + typecheck + lint +
test (556) + build green; generated files in sync.
* feat(sub): render host sockopt + xhttp-extra params into JSON/Clash output (TDD)
A host's sockoptParams and xhttpExtraParams (free-JSON) now take effect:
applyHostStreamOverrides injects sockopt into the per-host stream (re-added since
the base stream strips it) and merges xhttpExtraParams into xhttpSettings, called
in both getConfig (JSON) and getProxies (Clash) right after the per-host TLS
apply. No-op for legacy externalProxy entries (keys absent) — characterization
snapshots unchanged.
mux rendering is outbound-level (overrides outbound.Mux) and needs a genVless/
genVnext/genServer signature change — deferred, along with the per-host xray
JSON template.
Gate: go test ./internal/sub/... + go test ./... green (snapshots unchanged);
go build + vet + gofmt clean.
* feat(sub): render host muxParams as a per-host JSON outbound mux override (TDD)
genVnext/genVless/genServer take a muxOverride: a host's muxParams (when valid
JSON) overrides the global mux on its JSON outbound; empty falls back to the
panel mux (behavior unchanged for non-host configs). Completes the host
mux/sockopt/xhttp trio. Test call sites updated for the new signature.
Gate: go test ./internal/sub/... + go test ./... green (snapshots unchanged);
go build + gofmt clean.
* style(ui): show Host security fields conditionally per security (like externalProxy)
* feat(sub): apply host SNI + fingerprint override for reality (TDD)
A reality host now overrides SNI and fingerprint while inheriting publicKey/
shortId from the inbound (reality keys can't be host-supplied). Previously the
reality link kept the inbound's serverName because the TLS appliers are gated to
security=="tls".
- raw: applyEndpointRealityParams sets sni/fp on the params for reality;
- JSON/Clash: applyHostStreamOverrides sets realitySettings.serverName +
serverNames from the host SNI.
Gated to host endpoints via an isHost marker on the synthesized ep, so the legacy
externalProxy path stays byte-identical (characterization snapshots unchanged).
The marker is internal and never emitted.
Gate: go test ./internal/sub/... + go test ./... green; go build + vet + gofmt clean.
* fix(ui): start the Host inbound select unselected instead of showing 0
A new host left inboundId defaulting to 0, so the Select rendered "0". inboundId
is now optional in the form (undefined until chosen), so it shows its
placeholder ("Select an inbound"); the required rule still enforces a choice on
save. Port keeps 0 (means "inherit the inbound's port").
Gate: npm run typecheck + lint + build green.
* fix(ui): drop redundant :port suffix from the Host inbound select label
The inbound tag (e.g. in-59303-tcp) already carries the port, so the appended
":59303" was duplicated. Show just the remark/tag.
Gate: npm run typecheck + lint + build green.
* style(ui): apply the shared card hover shadows to the Hosts page
page-cards.css scoped its card styling + hover shadows to each page class but
not .hosts-page, so Hosts fell back to antd's default hoverable (a larger/blurry
shadow + pointer cursor). Add a .hosts-page block matching the other pages.
Gate: npm run build green.
* feat(hosts): move Tags to Basic tab, add Nodes field, accept VLESS route ranges
- Move the Tags field into the Host form's Basic tab and add a Nodes
multi-select (visual-only assignment, backed by the existing node_guids
column) so the Basic tab matches the reference layout.
- Replace the single-port vlessRouteId integer with a free-form vlessRoute
string that accepts comma-separated ports/ranges (e.g. 53,443,1000-2000);
format-validated on the frontend, stored verbatim on the backend.
- Regenerated frontend types/openapi from the changed model.
* feat(hosts): structured editors for Mux/Sockopt/XHTTP + new Final Mask
Replace the raw JSON textareas in the Host form's Advanced tab with the same
structured editors used elsewhere, under a nested tabbed layout (General / Mux /
Sockopt / XHTTP / Final Mask), mirroring the Sub-JSON settings tab:
- Mux: the Sub-JSON mux editor (enable + concurrency/xudpConcurrency/xudp443).
- Sockopt + XHTTP: reuse the outbound SockoptForm / XhttpForm, wrapped in an
isolated form that serializes the edited subtree back to the host's JSON
string (pruned so the override stays sparse).
- Final Mask: new host field (model + column + JSON-render wiring that merges
the masks into the host's JSON-subscription stream), edited via the shared
FinalMaskForm like the Sub-JSON Final Mask editor.
Each editor stays a controlled value/onChange component bound to its existing
host JSON string field; backend rendering of mux/sockopt/xhttp is unchanged.
* feat(hosts): drop XHTTP + Xray-JSON-template overrides; fix mobile form layout
Remove the host's XHTTP extra-params and Xray-JSON-template overrides entirely
(model fields + columns, JSON-subscription render paths incl. hostTemplateOutbound,
schema, form tab/field, i18n, openapi codegen, and their tests) — they did not
fit the host model. Mux, Sockopt and Final Mask stay as structured editors.
Mobile fixes for the Edit Host modal:
- responsive width (95vw on mobile, was a fixed 760px that overflowed the
viewport and clipped the tabs/labels) + a scrollable body so the footer stays
on screen;
- Mux fields use responsive Row/Col (stack on mobile) instead of a fixed-width
label grid.
* fix(hosts): hide the spurious horizontal scrollbar in the Edit Host modal
Setting overflowY:auto on the modal body forced overflow-x to auto too (CSS
rule), so antd Row's negative gutter margins triggered a horizontal scrollbar.
Pin overflowX:hidden.
* feat(hosts): inbound-style responsive field layout + icon empty state
- Host form (main form + Mux/Sockopt/Final Mask editors) now use the inbound
form's label layout: label beside the input on desktop (labelCol sm span 8 /
wrapperCol sm span 14, right-aligned), stacked label-above-input on mobile.
Rewrote HostMuxForm onto an internal antd Form so it follows the same layout
instead of a manual grid.
- Empty hosts table now shows the host icon + the shared 'Nothing here yet'
(noData) text, matching Nodes/Inbounds/Clients, replacing the bespoke
'No hosts yet…' string.
* fix(hosts): avoid nested <form> in the Edit Host modal
The Mux/Sockopt/Final Mask editors each render their own antd Form inside the
host's main Form, producing an invalid nested <form> DOM node (hydration
warning). Render those inner forms with component={false} so they keep the form
instance/context but emit no <form> element.
* fix(hosts): make the Mux enable toggle work
The Switch's checked state came from Form.useWatch('mux'), but the mux object
field had no registered Form.Item while disabled, so setFieldValue never
notified the watcher and the toggle stayed off. Bind the Switch to a real
name='enabled' field (antd drives its checked state directly) and keep the
sub-fields registered via hidden={!enabled}, serialized to the flat mux JSON.
* refactor(hosts): reuse the outbound MuxForm instead of a bespoke Mux editor
The Mux fields duplicated the outbound MuxForm. Reuse it through the same
wrapper as Sockopt: generalize OutboundSubtreeJsonForm with defaultSubtree
(pre-fill on enable) and a serialize hook, and have HostMuxForm render MuxForm
at the ['mux'] path. The host keeps its inherit-when-off semantics by storing ''
unless mux.enabled. Also drops the now-unused enableSwitch path from the
wrapper (only the removed XHTTP editor used it).
* style(hosts): use default-width Port input like the inbound form
The host Port used width:100% (full width); the inbound's numeric inputs use
antd's default width. Drop the override so Port matches. The Mux number inputs
already use the default width via the reused MuxForm.
* refactor(sockopt): readable customSockopt editor as a shared component
The customSockopt rows were a single cramped Space.Compact line and duplicated
verbatim in the inbound and outbound sockopt forms. Extract a shared
CustomSockoptList that renders each entry as a titled group of labeled fields
(System / Level / Opt / Type / Value), matching the rest of the form, and use it
in both (and thus the host Sockopt editor).
* fix(finalmask): drop the empty Custom Tables tag on a new sudoku mask
The sudoku TCP-mask default seeded customTables: [''] (one empty string), which
rendered as a blank removable tag. Seed [] instead.
* fix(sockopt): make the outbound (and host) Sockopt client-only
Per the XTLS sockopt docs, tproxy / acceptProxyProtocol / V6Only /
trustedXForwardedFor only apply to an inbound (listening socket); they are
meaningless on an outbound/dialer. Drop them from the outbound SockoptForm
(which the host reuses). The Sockopt default object still seeds those keys, so
the host also strips them on serialize, keeping its override honest to the
server/client split. The inbound SockoptForm is left unchanged.
* fix(sockopt): make the inbound Sockopt server-only
Complete the server/client split: drop the outbound/dialer-only fields from the
inbound SockoptForm — dialerProxy, domainStrategy, interface, addressPortStrategy,
happyEyeballs, tcpMptcp (client-only since Go 1.24 auto-enables MPTCP on listen).
mark stays (xray applies SO_MARK on inbound sockets too). Update the form-blocks
snapshot to the server-side field set (intentional spec change).
* feat(hosts): populate Sockopt dialerProxy with the panel's outbound tags
The host Sockopt editor reused the outbound SockoptForm with outboundTags=[],
so the dialerProxy dropdown was empty. Feed it the panel's outbound tags via
the existing useOutboundTags hook (shares the cached xray-config query;
blackhole excluded), so a host can chain through a subscription outbound by tag.
* fix(hosts): empty-state styling on direct load + exclude balancers from dialerProxy
- .card-empty was only defined in lazily-loaded Clients/Inbounds/Nodes
stylesheets, so a direct /hosts refresh rendered the empty table state
unstyled (faint + uncentered) until another page was visited. Re-declare it
in HostList.css so it's correct on first load.
- The Sockopt dialerProxy dropdown listed balancer tags (useOutboundTags merges
them in for mtproto egress). dialerProxy chains a single outbound, so balancers
aren't valid — switch to useOutboundTagGroups and use only the outbound group.
* fix(outbounds): icon + 'Nothing here yet' empty state; stop fading other pages
The Outbounds empty state was a faint '—', and OutboundsTab.css set the global
.card-empty to opacity:0.4 — which leaked onto whichever page's empty state was
shown after the Outbounds CSS had loaded (e.g. Hosts went faint after visiting
Outbounds). Render the icon + noData ('Nothing here yet') like the other lists,
and align .card-empty to the shared centered/secondary style (no opacity).
* fix(outbounds): custom empty state on the desktop table too
The desktop Outbounds Table had no locale.emptyText, so it showed antd's
default 'No data' box. Add the same ExportOutlined + noData empty state as the
card (mobile) view.
* style(sidebar): use ExportOutlined for the Outbounds nav item
The Outbounds sidebar item used UploadOutlined (an upload tray). Switch to
ExportOutlined, matching the outbound icon now used in the routing target and
the outbounds empty states.
* feat(hosts): icons on the form tabs (icon-only on mobile)
Wrap every Host form tab label (Basic/Security/Advanced/Clash/Subscription
scope and the nested General/Mux/Sockopt/Final Mask) with catTabLabel, so the
tabs show icon + text on desktop and just the icon (with a tooltip) on mobile,
matching the Settings/Xray tab bars.
* refactor(hosts): fold Exclude-from-formats into Advanced, drop the one-field tab
The Subscription scope tab held only excludeFromSubTypes after Tags moved to
Basic — a niche per-format scoping knob. Move it into the Advanced > General
sub-tab and remove the standalone tab (and its now-unused subScope label/icon).
* feat(sub): per-client remark template variables; drop the remark model & Show Usage Info
* fix(migration): cap seeded host remark at the model's 256-char limit, not 40
9605 lines
278 KiB
JSON
9605 lines
278 KiB
JSON
{
|
||
"openapi": "3.0.3",
|
||
"info": {
|
||
"title": "3X-UI Panel API",
|
||
"version": "3.x",
|
||
"description": "Programmatic interface to a 3X-UI panel. Authenticate either by logging in (cookie) or with an API token from Settings → Security → API Token (Bearer). All endpoints under /panel/api/* honour both modes — an API token is a full-admin credential, so treat it like the panel password."
|
||
},
|
||
"servers": [
|
||
{
|
||
"url": "/",
|
||
"description": "Current panel (basePath aware)"
|
||
}
|
||
],
|
||
"components": {
|
||
"securitySchemes": {
|
||
"bearerAuth": {
|
||
"type": "http",
|
||
"scheme": "bearer",
|
||
"description": "API token from Settings → Security → API Token. Send as `Authorization: Bearer <token>`."
|
||
},
|
||
"cookieAuth": {
|
||
"type": "apiKey",
|
||
"in": "cookie",
|
||
"name": "3x-ui",
|
||
"description": "Session cookie set by POST /login. Browser-only."
|
||
}
|
||
},
|
||
"schemas": {
|
||
"AllSetting": {
|
||
"description": "AllSetting contains all configuration settings for the 3x-ui panel including web server, Telegram bot, and subscription settings.",
|
||
"properties": {
|
||
"datepicker": {
|
||
"description": "Date picker format",
|
||
"type": "string"
|
||
},
|
||
"expireDiff": {
|
||
"description": "Expiration warning threshold in days",
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"externalTrafficInformEnable": {
|
||
"description": "Enable external traffic reporting",
|
||
"type": "boolean"
|
||
},
|
||
"externalTrafficInformURI": {
|
||
"description": "URI for external traffic reporting",
|
||
"type": "string"
|
||
},
|
||
"ldapAutoCreate": {
|
||
"type": "boolean"
|
||
},
|
||
"ldapAutoDelete": {
|
||
"type": "boolean"
|
||
},
|
||
"ldapBaseDN": {
|
||
"type": "string"
|
||
},
|
||
"ldapBindDN": {
|
||
"type": "string"
|
||
},
|
||
"ldapDefaultExpiryDays": {
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"ldapDefaultLimitIP": {
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"ldapDefaultTotalGB": {
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"ldapEnable": {
|
||
"description": "LDAP settings",
|
||
"type": "boolean"
|
||
},
|
||
"ldapFlagField": {
|
||
"description": "Generic flag configuration",
|
||
"type": "string"
|
||
},
|
||
"ldapHost": {
|
||
"type": "string"
|
||
},
|
||
"ldapInboundTags": {
|
||
"type": "string"
|
||
},
|
||
"ldapInvertFlag": {
|
||
"type": "boolean"
|
||
},
|
||
"ldapPassword": {
|
||
"type": "string"
|
||
},
|
||
"ldapPort": {
|
||
"maximum": 65535,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"ldapSyncCron": {
|
||
"type": "string"
|
||
},
|
||
"ldapTruthyValues": {
|
||
"type": "string"
|
||
},
|
||
"ldapUseTLS": {
|
||
"type": "boolean"
|
||
},
|
||
"ldapUserAttr": {
|
||
"description": "e.g., mail or uid",
|
||
"type": "string"
|
||
},
|
||
"ldapUserFilter": {
|
||
"type": "string"
|
||
},
|
||
"ldapVlessField": {
|
||
"type": "string"
|
||
},
|
||
"pageSize": {
|
||
"description": "UI settings\nNumber of items per page in lists (0 disables pagination)",
|
||
"maximum": 1000,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"panelOutbound": {
|
||
"description": "Xray outbound tag for the panel's own outbound HTTP (update checks/downloads, Telegram, geo updates, outbound-subscription fetches)",
|
||
"type": "string"
|
||
},
|
||
"remarkTemplate": {
|
||
"description": "Subscription remark template ({{VAR}} tokens) rendered per client",
|
||
"type": "string"
|
||
},
|
||
"restartXrayOnClientDisable": {
|
||
"description": "Restart Xray when clients are auto-disabled by expiry/traffic limit",
|
||
"type": "boolean"
|
||
},
|
||
"sessionMaxAge": {
|
||
"description": "Session maximum age in minutes (cap at one year)",
|
||
"maximum": 525600,
|
||
"minimum": 1,
|
||
"type": "integer"
|
||
},
|
||
"smtpCpu": {
|
||
"description": "CPU threshold for email notifications",
|
||
"maximum": 100,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"smtpEnable": {
|
||
"description": "Email (SMTP) notification settings\nEnable email notifications",
|
||
"type": "boolean"
|
||
},
|
||
"smtpEnabledEvents": {
|
||
"description": "Comma-separated event types to send via email",
|
||
"type": "string"
|
||
},
|
||
"smtpEncryptionType": {
|
||
"description": "SMTP encryption: none, starttls, tls",
|
||
"type": "string"
|
||
},
|
||
"smtpHost": {
|
||
"description": "SMTP server host",
|
||
"type": "string"
|
||
},
|
||
"smtpPassword": {
|
||
"description": "SMTP password",
|
||
"type": "string"
|
||
},
|
||
"smtpPort": {
|
||
"description": "SMTP server port",
|
||
"maximum": 65535,
|
||
"minimum": 1,
|
||
"type": "integer"
|
||
},
|
||
"smtpTo": {
|
||
"description": "Comma-separated recipient emails",
|
||
"type": "string"
|
||
},
|
||
"smtpUsername": {
|
||
"description": "SMTP username",
|
||
"type": "string"
|
||
},
|
||
"subAnnounce": {
|
||
"description": "Subscription announce",
|
||
"type": "string"
|
||
},
|
||
"subCertFile": {
|
||
"description": "SSL certificate file for subscription server",
|
||
"type": "string"
|
||
},
|
||
"subClashEnable": {
|
||
"description": "Enable Clash/Mihomo subscription endpoint",
|
||
"type": "boolean"
|
||
},
|
||
"subClashEnableRouting": {
|
||
"description": "Enable global routing rules for Clash/Mihomo",
|
||
"type": "boolean"
|
||
},
|
||
"subClashPath": {
|
||
"description": "Path for Clash/Mihomo subscription endpoint",
|
||
"type": "string"
|
||
},
|
||
"subClashRules": {
|
||
"description": "Clash/Mihomo global routing rules",
|
||
"type": "string"
|
||
},
|
||
"subClashURI": {
|
||
"description": "Clash/Mihomo subscription server URI",
|
||
"type": "string"
|
||
},
|
||
"subDomain": {
|
||
"description": "Domain for subscription server validation",
|
||
"type": "string"
|
||
},
|
||
"subEnable": {
|
||
"description": "Subscription server settings\nEnable subscription server",
|
||
"type": "boolean"
|
||
},
|
||
"subEnableRouting": {
|
||
"description": "Enable routing for subscription",
|
||
"type": "boolean"
|
||
},
|
||
"subEncrypt": {
|
||
"description": "Encrypt subscription responses",
|
||
"type": "boolean"
|
||
},
|
||
"subJsonEnable": {
|
||
"description": "Enable JSON subscription endpoint",
|
||
"type": "boolean"
|
||
},
|
||
"subJsonFinalMask": {
|
||
"description": "JSON subscription global finalmask (tcp/udp masks + quicParams)",
|
||
"type": "string"
|
||
},
|
||
"subJsonMux": {
|
||
"description": "JSON subscription mux configuration",
|
||
"type": "string"
|
||
},
|
||
"subJsonPath": {
|
||
"description": "Path for JSON subscription endpoint",
|
||
"type": "string"
|
||
},
|
||
"subJsonRules": {
|
||
"type": "string"
|
||
},
|
||
"subJsonURI": {
|
||
"description": "JSON subscription server URI",
|
||
"type": "string"
|
||
},
|
||
"subKeyFile": {
|
||
"description": "SSL private key file for subscription server",
|
||
"type": "string"
|
||
},
|
||
"subListen": {
|
||
"description": "Subscription server listen IP",
|
||
"type": "string"
|
||
},
|
||
"subPath": {
|
||
"description": "Base path for subscription URLs",
|
||
"type": "string"
|
||
},
|
||
"subPort": {
|
||
"description": "Subscription server port",
|
||
"maximum": 65535,
|
||
"minimum": 1,
|
||
"type": "integer"
|
||
},
|
||
"subProfileUrl": {
|
||
"description": "Subscription profile URL",
|
||
"type": "string"
|
||
},
|
||
"subRoutingRules": {
|
||
"description": "Subscription global routing rules (Only for Happ)",
|
||
"type": "string"
|
||
},
|
||
"subSupportUrl": {
|
||
"description": "Subscription support URL",
|
||
"type": "string"
|
||
},
|
||
"subThemeDir": {
|
||
"description": "Absolute path to a folder containing a custom subscription page template",
|
||
"type": "string"
|
||
},
|
||
"subTitle": {
|
||
"description": "Subscription title",
|
||
"type": "string"
|
||
},
|
||
"subURI": {
|
||
"description": "Subscription server URI",
|
||
"type": "string"
|
||
},
|
||
"subUpdates": {
|
||
"description": "Subscription update interval in minutes",
|
||
"maximum": 525600,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"tgBotAPIServer": {
|
||
"description": "Custom API server for Telegram bot",
|
||
"type": "string"
|
||
},
|
||
"tgBotBackup": {
|
||
"description": "Enable database backup via Telegram",
|
||
"type": "boolean"
|
||
},
|
||
"tgBotChatId": {
|
||
"description": "Telegram chat ID for notifications",
|
||
"type": "string"
|
||
},
|
||
"tgBotEnable": {
|
||
"description": "Telegram bot settings\nEnable Telegram bot notifications",
|
||
"type": "boolean"
|
||
},
|
||
"tgBotProxy": {
|
||
"description": "Proxy URL for Telegram bot",
|
||
"type": "string"
|
||
},
|
||
"tgBotToken": {
|
||
"description": "Telegram bot token",
|
||
"type": "string"
|
||
},
|
||
"tgCpu": {
|
||
"description": "CPU usage threshold for alerts (percent)",
|
||
"maximum": 100,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"tgEnabledEvents": {
|
||
"description": "Comma-separated event types to send via Telegram",
|
||
"type": "string"
|
||
},
|
||
"tgLang": {
|
||
"description": "Telegram bot language",
|
||
"type": "string"
|
||
},
|
||
"tgRunTime": {
|
||
"description": "Cron schedule for Telegram notifications",
|
||
"type": "string"
|
||
},
|
||
"timeLocation": {
|
||
"description": "Security settings\nTime zone location",
|
||
"type": "string"
|
||
},
|
||
"trafficDiff": {
|
||
"description": "Traffic warning threshold percentage",
|
||
"maximum": 100,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"trustedProxyCIDRs": {
|
||
"description": "Trusted reverse proxy IPs/CIDRs for forwarded headers",
|
||
"type": "string"
|
||
},
|
||
"twoFactorEnable": {
|
||
"description": "Enable two-factor authentication",
|
||
"type": "boolean"
|
||
},
|
||
"twoFactorToken": {
|
||
"description": "Two-factor authentication token",
|
||
"type": "string"
|
||
},
|
||
"warpUpdateInterval": {
|
||
"description": "WARP",
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"webBasePath": {
|
||
"description": "Base path for web panel URLs",
|
||
"type": "string"
|
||
},
|
||
"webCertFile": {
|
||
"description": "Path to SSL certificate file for web server",
|
||
"type": "string"
|
||
},
|
||
"webDomain": {
|
||
"description": "Web server domain for domain validation",
|
||
"type": "string"
|
||
},
|
||
"webKeyFile": {
|
||
"description": "Path to SSL private key file for web server",
|
||
"type": "string"
|
||
},
|
||
"webListen": {
|
||
"description": "Web server settings\nWeb server listen IP address",
|
||
"type": "string"
|
||
},
|
||
"webPort": {
|
||
"description": "Web server port number",
|
||
"maximum": 65535,
|
||
"minimum": 1,
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"required": [
|
||
"datepicker",
|
||
"expireDiff",
|
||
"externalTrafficInformEnable",
|
||
"externalTrafficInformURI",
|
||
"ldapAutoCreate",
|
||
"ldapAutoDelete",
|
||
"ldapBaseDN",
|
||
"ldapBindDN",
|
||
"ldapDefaultExpiryDays",
|
||
"ldapDefaultLimitIP",
|
||
"ldapDefaultTotalGB",
|
||
"ldapEnable",
|
||
"ldapFlagField",
|
||
"ldapHost",
|
||
"ldapInboundTags",
|
||
"ldapInvertFlag",
|
||
"ldapPassword",
|
||
"ldapPort",
|
||
"ldapSyncCron",
|
||
"ldapTruthyValues",
|
||
"ldapUseTLS",
|
||
"ldapUserAttr",
|
||
"ldapUserFilter",
|
||
"ldapVlessField",
|
||
"pageSize",
|
||
"panelOutbound",
|
||
"remarkTemplate",
|
||
"restartXrayOnClientDisable",
|
||
"sessionMaxAge",
|
||
"smtpCpu",
|
||
"smtpEnable",
|
||
"smtpEnabledEvents",
|
||
"smtpEncryptionType",
|
||
"smtpHost",
|
||
"smtpPassword",
|
||
"smtpPort",
|
||
"smtpTo",
|
||
"smtpUsername",
|
||
"subAnnounce",
|
||
"subCertFile",
|
||
"subClashEnable",
|
||
"subClashEnableRouting",
|
||
"subClashPath",
|
||
"subClashRules",
|
||
"subClashURI",
|
||
"subDomain",
|
||
"subEnable",
|
||
"subEnableRouting",
|
||
"subEncrypt",
|
||
"subJsonEnable",
|
||
"subJsonFinalMask",
|
||
"subJsonMux",
|
||
"subJsonPath",
|
||
"subJsonRules",
|
||
"subJsonURI",
|
||
"subKeyFile",
|
||
"subListen",
|
||
"subPath",
|
||
"subPort",
|
||
"subProfileUrl",
|
||
"subRoutingRules",
|
||
"subSupportUrl",
|
||
"subThemeDir",
|
||
"subTitle",
|
||
"subURI",
|
||
"subUpdates",
|
||
"tgBotAPIServer",
|
||
"tgBotBackup",
|
||
"tgBotChatId",
|
||
"tgBotEnable",
|
||
"tgBotProxy",
|
||
"tgBotToken",
|
||
"tgCpu",
|
||
"tgEnabledEvents",
|
||
"tgLang",
|
||
"tgRunTime",
|
||
"timeLocation",
|
||
"trafficDiff",
|
||
"trustedProxyCIDRs",
|
||
"twoFactorEnable",
|
||
"twoFactorToken",
|
||
"warpUpdateInterval",
|
||
"webBasePath",
|
||
"webCertFile",
|
||
"webDomain",
|
||
"webKeyFile",
|
||
"webListen",
|
||
"webPort"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"AllSettingView": {
|
||
"description": "AllSettingView is the browser-safe settings read model. Secret values\nare redacted from the embedded write model and represented by presence\nflags so the UI can show configured/not configured state.",
|
||
"properties": {
|
||
"datepicker": {
|
||
"description": "Date picker format",
|
||
"type": "string"
|
||
},
|
||
"expireDiff": {
|
||
"description": "Expiration warning threshold in days",
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"externalTrafficInformEnable": {
|
||
"description": "Enable external traffic reporting",
|
||
"type": "boolean"
|
||
},
|
||
"externalTrafficInformURI": {
|
||
"description": "URI for external traffic reporting",
|
||
"type": "string"
|
||
},
|
||
"hasApiToken": {
|
||
"type": "boolean"
|
||
},
|
||
"hasLdapPassword": {
|
||
"type": "boolean"
|
||
},
|
||
"hasNordSecret": {
|
||
"type": "boolean"
|
||
},
|
||
"hasSmtpPassword": {
|
||
"type": "boolean"
|
||
},
|
||
"hasTgBotToken": {
|
||
"type": "boolean"
|
||
},
|
||
"hasTwoFactorToken": {
|
||
"type": "boolean"
|
||
},
|
||
"hasWarpSecret": {
|
||
"type": "boolean"
|
||
},
|
||
"ldapAutoCreate": {
|
||
"type": "boolean"
|
||
},
|
||
"ldapAutoDelete": {
|
||
"type": "boolean"
|
||
},
|
||
"ldapBaseDN": {
|
||
"type": "string"
|
||
},
|
||
"ldapBindDN": {
|
||
"type": "string"
|
||
},
|
||
"ldapDefaultExpiryDays": {
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"ldapDefaultLimitIP": {
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"ldapDefaultTotalGB": {
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"ldapEnable": {
|
||
"description": "LDAP settings",
|
||
"type": "boolean"
|
||
},
|
||
"ldapFlagField": {
|
||
"description": "Generic flag configuration",
|
||
"type": "string"
|
||
},
|
||
"ldapHost": {
|
||
"type": "string"
|
||
},
|
||
"ldapInboundTags": {
|
||
"type": "string"
|
||
},
|
||
"ldapInvertFlag": {
|
||
"type": "boolean"
|
||
},
|
||
"ldapPassword": {
|
||
"type": "string"
|
||
},
|
||
"ldapPort": {
|
||
"maximum": 65535,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"ldapSyncCron": {
|
||
"type": "string"
|
||
},
|
||
"ldapTruthyValues": {
|
||
"type": "string"
|
||
},
|
||
"ldapUseTLS": {
|
||
"type": "boolean"
|
||
},
|
||
"ldapUserAttr": {
|
||
"description": "e.g., mail or uid",
|
||
"type": "string"
|
||
},
|
||
"ldapUserFilter": {
|
||
"type": "string"
|
||
},
|
||
"ldapVlessField": {
|
||
"type": "string"
|
||
},
|
||
"pageSize": {
|
||
"description": "UI settings\nNumber of items per page in lists (0 disables pagination)",
|
||
"maximum": 1000,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"panelOutbound": {
|
||
"description": "Xray outbound tag for the panel's own outbound HTTP (update checks/downloads, Telegram, geo updates, outbound-subscription fetches)",
|
||
"type": "string"
|
||
},
|
||
"remarkTemplate": {
|
||
"description": "Subscription remark template ({{VAR}} tokens) rendered per client",
|
||
"type": "string"
|
||
},
|
||
"restartXrayOnClientDisable": {
|
||
"description": "Restart Xray when clients are auto-disabled by expiry/traffic limit",
|
||
"type": "boolean"
|
||
},
|
||
"sessionMaxAge": {
|
||
"description": "Session maximum age in minutes (cap at one year)",
|
||
"maximum": 525600,
|
||
"minimum": 1,
|
||
"type": "integer"
|
||
},
|
||
"smtpCpu": {
|
||
"description": "CPU threshold for email notifications",
|
||
"maximum": 100,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"smtpEnable": {
|
||
"description": "Email (SMTP) notification settings\nEnable email notifications",
|
||
"type": "boolean"
|
||
},
|
||
"smtpEnabledEvents": {
|
||
"description": "Comma-separated event types to send via email",
|
||
"type": "string"
|
||
},
|
||
"smtpEncryptionType": {
|
||
"description": "SMTP encryption: none, starttls, tls",
|
||
"type": "string"
|
||
},
|
||
"smtpHost": {
|
||
"description": "SMTP server host",
|
||
"type": "string"
|
||
},
|
||
"smtpPassword": {
|
||
"description": "SMTP password",
|
||
"type": "string"
|
||
},
|
||
"smtpPort": {
|
||
"description": "SMTP server port",
|
||
"maximum": 65535,
|
||
"minimum": 1,
|
||
"type": "integer"
|
||
},
|
||
"smtpTo": {
|
||
"description": "Comma-separated recipient emails",
|
||
"type": "string"
|
||
},
|
||
"smtpUsername": {
|
||
"description": "SMTP username",
|
||
"type": "string"
|
||
},
|
||
"subAnnounce": {
|
||
"description": "Subscription announce",
|
||
"type": "string"
|
||
},
|
||
"subCertFile": {
|
||
"description": "SSL certificate file for subscription server",
|
||
"type": "string"
|
||
},
|
||
"subClashEnable": {
|
||
"description": "Enable Clash/Mihomo subscription endpoint",
|
||
"type": "boolean"
|
||
},
|
||
"subClashEnableRouting": {
|
||
"description": "Enable global routing rules for Clash/Mihomo",
|
||
"type": "boolean"
|
||
},
|
||
"subClashPath": {
|
||
"description": "Path for Clash/Mihomo subscription endpoint",
|
||
"type": "string"
|
||
},
|
||
"subClashRules": {
|
||
"description": "Clash/Mihomo global routing rules",
|
||
"type": "string"
|
||
},
|
||
"subClashURI": {
|
||
"description": "Clash/Mihomo subscription server URI",
|
||
"type": "string"
|
||
},
|
||
"subDomain": {
|
||
"description": "Domain for subscription server validation",
|
||
"type": "string"
|
||
},
|
||
"subEnable": {
|
||
"description": "Subscription server settings\nEnable subscription server",
|
||
"type": "boolean"
|
||
},
|
||
"subEnableRouting": {
|
||
"description": "Enable routing for subscription",
|
||
"type": "boolean"
|
||
},
|
||
"subEncrypt": {
|
||
"description": "Encrypt subscription responses",
|
||
"type": "boolean"
|
||
},
|
||
"subJsonEnable": {
|
||
"description": "Enable JSON subscription endpoint",
|
||
"type": "boolean"
|
||
},
|
||
"subJsonFinalMask": {
|
||
"description": "JSON subscription global finalmask (tcp/udp masks + quicParams)",
|
||
"type": "string"
|
||
},
|
||
"subJsonMux": {
|
||
"description": "JSON subscription mux configuration",
|
||
"type": "string"
|
||
},
|
||
"subJsonPath": {
|
||
"description": "Path for JSON subscription endpoint",
|
||
"type": "string"
|
||
},
|
||
"subJsonRules": {
|
||
"type": "string"
|
||
},
|
||
"subJsonURI": {
|
||
"description": "JSON subscription server URI",
|
||
"type": "string"
|
||
},
|
||
"subKeyFile": {
|
||
"description": "SSL private key file for subscription server",
|
||
"type": "string"
|
||
},
|
||
"subListen": {
|
||
"description": "Subscription server listen IP",
|
||
"type": "string"
|
||
},
|
||
"subPath": {
|
||
"description": "Base path for subscription URLs",
|
||
"type": "string"
|
||
},
|
||
"subPort": {
|
||
"description": "Subscription server port",
|
||
"maximum": 65535,
|
||
"minimum": 1,
|
||
"type": "integer"
|
||
},
|
||
"subProfileUrl": {
|
||
"description": "Subscription profile URL",
|
||
"type": "string"
|
||
},
|
||
"subRoutingRules": {
|
||
"description": "Subscription global routing rules (Only for Happ)",
|
||
"type": "string"
|
||
},
|
||
"subSupportUrl": {
|
||
"description": "Subscription support URL",
|
||
"type": "string"
|
||
},
|
||
"subThemeDir": {
|
||
"description": "Absolute path to a folder containing a custom subscription page template",
|
||
"type": "string"
|
||
},
|
||
"subTitle": {
|
||
"description": "Subscription title",
|
||
"type": "string"
|
||
},
|
||
"subURI": {
|
||
"description": "Subscription server URI",
|
||
"type": "string"
|
||
},
|
||
"subUpdates": {
|
||
"description": "Subscription update interval in minutes",
|
||
"maximum": 525600,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"tgBotAPIServer": {
|
||
"description": "Custom API server for Telegram bot",
|
||
"type": "string"
|
||
},
|
||
"tgBotBackup": {
|
||
"description": "Enable database backup via Telegram",
|
||
"type": "boolean"
|
||
},
|
||
"tgBotChatId": {
|
||
"description": "Telegram chat ID for notifications",
|
||
"type": "string"
|
||
},
|
||
"tgBotEnable": {
|
||
"description": "Telegram bot settings\nEnable Telegram bot notifications",
|
||
"type": "boolean"
|
||
},
|
||
"tgBotProxy": {
|
||
"description": "Proxy URL for Telegram bot",
|
||
"type": "string"
|
||
},
|
||
"tgBotToken": {
|
||
"description": "Telegram bot token",
|
||
"type": "string"
|
||
},
|
||
"tgCpu": {
|
||
"description": "CPU usage threshold for alerts (percent)",
|
||
"maximum": 100,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"tgEnabledEvents": {
|
||
"description": "Comma-separated event types to send via Telegram",
|
||
"type": "string"
|
||
},
|
||
"tgLang": {
|
||
"description": "Telegram bot language",
|
||
"type": "string"
|
||
},
|
||
"tgRunTime": {
|
||
"description": "Cron schedule for Telegram notifications",
|
||
"type": "string"
|
||
},
|
||
"timeLocation": {
|
||
"description": "Security settings\nTime zone location",
|
||
"type": "string"
|
||
},
|
||
"trafficDiff": {
|
||
"description": "Traffic warning threshold percentage",
|
||
"maximum": 100,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"trustedProxyCIDRs": {
|
||
"description": "Trusted reverse proxy IPs/CIDRs for forwarded headers",
|
||
"type": "string"
|
||
},
|
||
"twoFactorEnable": {
|
||
"description": "Enable two-factor authentication",
|
||
"type": "boolean"
|
||
},
|
||
"twoFactorToken": {
|
||
"description": "Two-factor authentication token",
|
||
"type": "string"
|
||
},
|
||
"warpUpdateInterval": {
|
||
"description": "WARP",
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"webBasePath": {
|
||
"description": "Base path for web panel URLs",
|
||
"type": "string"
|
||
},
|
||
"webCertFile": {
|
||
"description": "Path to SSL certificate file for web server",
|
||
"type": "string"
|
||
},
|
||
"webDomain": {
|
||
"description": "Web server domain for domain validation",
|
||
"type": "string"
|
||
},
|
||
"webKeyFile": {
|
||
"description": "Path to SSL private key file for web server",
|
||
"type": "string"
|
||
},
|
||
"webListen": {
|
||
"description": "Web server settings\nWeb server listen IP address",
|
||
"type": "string"
|
||
},
|
||
"webPort": {
|
||
"description": "Web server port number",
|
||
"maximum": 65535,
|
||
"minimum": 1,
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"required": [
|
||
"datepicker",
|
||
"expireDiff",
|
||
"externalTrafficInformEnable",
|
||
"externalTrafficInformURI",
|
||
"hasApiToken",
|
||
"hasLdapPassword",
|
||
"hasNordSecret",
|
||
"hasSmtpPassword",
|
||
"hasTgBotToken",
|
||
"hasTwoFactorToken",
|
||
"hasWarpSecret",
|
||
"ldapAutoCreate",
|
||
"ldapAutoDelete",
|
||
"ldapBaseDN",
|
||
"ldapBindDN",
|
||
"ldapDefaultExpiryDays",
|
||
"ldapDefaultLimitIP",
|
||
"ldapDefaultTotalGB",
|
||
"ldapEnable",
|
||
"ldapFlagField",
|
||
"ldapHost",
|
||
"ldapInboundTags",
|
||
"ldapInvertFlag",
|
||
"ldapPassword",
|
||
"ldapPort",
|
||
"ldapSyncCron",
|
||
"ldapTruthyValues",
|
||
"ldapUseTLS",
|
||
"ldapUserAttr",
|
||
"ldapUserFilter",
|
||
"ldapVlessField",
|
||
"pageSize",
|
||
"panelOutbound",
|
||
"remarkTemplate",
|
||
"restartXrayOnClientDisable",
|
||
"sessionMaxAge",
|
||
"smtpCpu",
|
||
"smtpEnable",
|
||
"smtpEnabledEvents",
|
||
"smtpEncryptionType",
|
||
"smtpHost",
|
||
"smtpPassword",
|
||
"smtpPort",
|
||
"smtpTo",
|
||
"smtpUsername",
|
||
"subAnnounce",
|
||
"subCertFile",
|
||
"subClashEnable",
|
||
"subClashEnableRouting",
|
||
"subClashPath",
|
||
"subClashRules",
|
||
"subClashURI",
|
||
"subDomain",
|
||
"subEnable",
|
||
"subEnableRouting",
|
||
"subEncrypt",
|
||
"subJsonEnable",
|
||
"subJsonFinalMask",
|
||
"subJsonMux",
|
||
"subJsonPath",
|
||
"subJsonRules",
|
||
"subJsonURI",
|
||
"subKeyFile",
|
||
"subListen",
|
||
"subPath",
|
||
"subPort",
|
||
"subProfileUrl",
|
||
"subRoutingRules",
|
||
"subSupportUrl",
|
||
"subThemeDir",
|
||
"subTitle",
|
||
"subURI",
|
||
"subUpdates",
|
||
"tgBotAPIServer",
|
||
"tgBotBackup",
|
||
"tgBotChatId",
|
||
"tgBotEnable",
|
||
"tgBotProxy",
|
||
"tgBotToken",
|
||
"tgCpu",
|
||
"tgEnabledEvents",
|
||
"tgLang",
|
||
"tgRunTime",
|
||
"timeLocation",
|
||
"trafficDiff",
|
||
"trustedProxyCIDRs",
|
||
"twoFactorEnable",
|
||
"twoFactorToken",
|
||
"warpUpdateInterval",
|
||
"webBasePath",
|
||
"webCertFile",
|
||
"webDomain",
|
||
"webKeyFile",
|
||
"webListen",
|
||
"webPort"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"ApiToken": {
|
||
"properties": {
|
||
"createdAt": {
|
||
"type": "integer"
|
||
},
|
||
"enabled": {
|
||
"type": "boolean"
|
||
},
|
||
"id": {
|
||
"type": "integer"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"token": {
|
||
"description": "SHA-256 hash; the plaintext is shown only once at creation",
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"createdAt",
|
||
"enabled",
|
||
"id",
|
||
"name",
|
||
"token"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"ApiTokenView": {
|
||
"properties": {
|
||
"createdAt": {
|
||
"example": 1736000000,
|
||
"type": "integer"
|
||
},
|
||
"enabled": {
|
||
"example": true,
|
||
"type": "boolean"
|
||
},
|
||
"id": {
|
||
"example": 2,
|
||
"type": "integer"
|
||
},
|
||
"name": {
|
||
"example": "central-panel-a",
|
||
"type": "string"
|
||
},
|
||
"token": {
|
||
"example": "new-token-string",
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"createdAt",
|
||
"enabled",
|
||
"id",
|
||
"name"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"Client": {
|
||
"description": "Client represents a client configuration for Xray inbounds with traffic limits and settings.",
|
||
"properties": {
|
||
"auth": {
|
||
"description": "Auth password (Hysteria)",
|
||
"type": "string"
|
||
},
|
||
"comment": {
|
||
"description": "Client comment",
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"description": "Creation timestamp",
|
||
"type": "integer"
|
||
},
|
||
"email": {
|
||
"description": "Client email identifier",
|
||
"type": "string"
|
||
},
|
||
"enable": {
|
||
"description": "Whether the client is enabled",
|
||
"type": "boolean"
|
||
},
|
||
"expiryTime": {
|
||
"description": "Expiration timestamp",
|
||
"type": "integer"
|
||
},
|
||
"flow": {
|
||
"description": "Flow control (XTLS)",
|
||
"type": "string"
|
||
},
|
||
"group": {
|
||
"description": "Logical grouping label",
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"description": "Unique client identifier",
|
||
"type": "string"
|
||
},
|
||
"limitIp": {
|
||
"description": "IP limit for this client",
|
||
"type": "integer"
|
||
},
|
||
"password": {
|
||
"description": "Client password",
|
||
"type": "string"
|
||
},
|
||
"reset": {
|
||
"description": "Reset period in days",
|
||
"type": "integer"
|
||
},
|
||
"reverse": {
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/components/schemas/ClientReverse"
|
||
}
|
||
],
|
||
"description": "VLESS simple reverse proxy settings",
|
||
"nullable": true
|
||
},
|
||
"security": {
|
||
"description": "Security method (e.g., \"auto\", \"aes-128-gcm\")",
|
||
"type": "string"
|
||
},
|
||
"subId": {
|
||
"description": "Subscription identifier",
|
||
"type": "string"
|
||
},
|
||
"tgId": {
|
||
"description": "Telegram user ID for notifications",
|
||
"type": "integer"
|
||
},
|
||
"totalGB": {
|
||
"description": "Total traffic limit in GB",
|
||
"type": "integer"
|
||
},
|
||
"updated_at": {
|
||
"description": "Last update timestamp",
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"required": [
|
||
"comment",
|
||
"email",
|
||
"enable",
|
||
"expiryTime",
|
||
"limitIp",
|
||
"reset",
|
||
"security",
|
||
"subId",
|
||
"tgId",
|
||
"totalGB"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"ClientInbound": {
|
||
"properties": {
|
||
"clientId": {
|
||
"type": "integer"
|
||
},
|
||
"createdAt": {
|
||
"type": "integer"
|
||
},
|
||
"flowOverride": {
|
||
"type": "string"
|
||
},
|
||
"inboundId": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"required": [
|
||
"clientId",
|
||
"createdAt",
|
||
"flowOverride",
|
||
"inboundId"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"ClientRecord": {
|
||
"properties": {
|
||
"auth": {
|
||
"type": "string"
|
||
},
|
||
"comment": {
|
||
"type": "string"
|
||
},
|
||
"createdAt": {
|
||
"type": "integer"
|
||
},
|
||
"email": {
|
||
"type": "string"
|
||
},
|
||
"enable": {
|
||
"type": "boolean"
|
||
},
|
||
"expiryTime": {
|
||
"type": "integer"
|
||
},
|
||
"flow": {
|
||
"type": "string"
|
||
},
|
||
"group": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "integer"
|
||
},
|
||
"limitIp": {
|
||
"type": "integer"
|
||
},
|
||
"password": {
|
||
"type": "string"
|
||
},
|
||
"reset": {
|
||
"type": "integer"
|
||
},
|
||
"reverse": {},
|
||
"security": {
|
||
"type": "string"
|
||
},
|
||
"subId": {
|
||
"type": "string"
|
||
},
|
||
"tgId": {
|
||
"type": "integer"
|
||
},
|
||
"totalGB": {
|
||
"type": "integer"
|
||
},
|
||
"updatedAt": {
|
||
"type": "integer"
|
||
},
|
||
"uuid": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"auth",
|
||
"comment",
|
||
"createdAt",
|
||
"email",
|
||
"enable",
|
||
"expiryTime",
|
||
"flow",
|
||
"group",
|
||
"id",
|
||
"limitIp",
|
||
"password",
|
||
"reset",
|
||
"reverse",
|
||
"security",
|
||
"subId",
|
||
"tgId",
|
||
"totalGB",
|
||
"updatedAt",
|
||
"uuid"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"ClientReverse": {
|
||
"properties": {
|
||
"tag": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"tag"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"ClientTraffic": {
|
||
"description": "ClientTraffic represents traffic statistics and limits for a specific client.\nIt tracks upload/download usage, expiry times, and online status for inbound clients.",
|
||
"properties": {
|
||
"down": {
|
||
"example": 2097152,
|
||
"type": "integer"
|
||
},
|
||
"email": {
|
||
"example": "user1",
|
||
"type": "string"
|
||
},
|
||
"enable": {
|
||
"example": true,
|
||
"type": "boolean"
|
||
},
|
||
"expiryTime": {
|
||
"example": 1735689600000,
|
||
"type": "integer"
|
||
},
|
||
"id": {
|
||
"example": 14825,
|
||
"type": "integer"
|
||
},
|
||
"inboundId": {
|
||
"example": 1,
|
||
"type": "integer"
|
||
},
|
||
"lastOnline": {
|
||
"example": 1735680000000,
|
||
"type": "integer"
|
||
},
|
||
"reset": {
|
||
"example": 0,
|
||
"type": "integer"
|
||
},
|
||
"subId": {
|
||
"example": "i7tvdpeffi0hvvf1",
|
||
"type": "string"
|
||
},
|
||
"total": {
|
||
"example": 10737418240,
|
||
"type": "integer"
|
||
},
|
||
"up": {
|
||
"example": 1048576,
|
||
"type": "integer"
|
||
},
|
||
"uuid": {
|
||
"example": "e18c9a96-71bf-48d4-933f-8b9a46d4290c",
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"down",
|
||
"email",
|
||
"enable",
|
||
"expiryTime",
|
||
"id",
|
||
"inboundId",
|
||
"lastOnline",
|
||
"reset",
|
||
"subId",
|
||
"total",
|
||
"up",
|
||
"uuid"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"FallbackParentInfo": {
|
||
"description": "FallbackParentInfo carries everything the frontend needs to rewrite a\nchild inbound's client link: where to connect (the master's address\nand port) and which path matched on the master's fallbacks array.\nThe frontend already has the master inbound in its dbInbounds list,\nso we only ship identifiers + the match path here.",
|
||
"properties": {
|
||
"masterId": {
|
||
"type": "integer"
|
||
},
|
||
"path": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"masterId"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"HistoryOfSeeders": {
|
||
"description": "HistoryOfSeeders tracks which database seeders have been executed to prevent re-running.",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer"
|
||
},
|
||
"seederName": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"id",
|
||
"seederName"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"Host": {
|
||
"description": "Host is an override endpoint attached to an inbound: at subscription time each\nenabled host renders one share link/proxy with its own address/port/TLS/etc.,\nsuperseding the legacy externalProxy array. Free-JSON fields are stored as\ntext and parsed in the sub layer; slice fields use the json serializer.",
|
||
"properties": {
|
||
"address": {
|
||
"example": "cdn.example.com",
|
||
"type": "string"
|
||
},
|
||
"allowInsecure": {
|
||
"type": "boolean"
|
||
},
|
||
"alpn": {
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"type": "array"
|
||
},
|
||
"createdAt": {
|
||
"type": "integer"
|
||
},
|
||
"echConfigList": {
|
||
"type": "string"
|
||
},
|
||
"excludeFromSubTypes": {
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"type": "array"
|
||
},
|
||
"finalMask": {
|
||
"description": "FinalMask is a JSON object of xray finalmask masks (tcp/udp/quicParams),\nmerged into this host's JSON-subscription stream. Empty = no override.",
|
||
"type": "string"
|
||
},
|
||
"fingerprint": {
|
||
"type": "string"
|
||
},
|
||
"hostHeader": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"example": 1,
|
||
"type": "integer"
|
||
},
|
||
"inboundId": {
|
||
"example": 1,
|
||
"type": "integer"
|
||
},
|
||
"isDisabled": {
|
||
"type": "boolean"
|
||
},
|
||
"isHidden": {
|
||
"type": "boolean"
|
||
},
|
||
"keepSniBlank": {
|
||
"type": "boolean"
|
||
},
|
||
"mihomoIpVersion": {
|
||
"enum": [
|
||
"dual",
|
||
"ipv4",
|
||
"ipv6",
|
||
"ipv4-prefer",
|
||
"ipv6-prefer"
|
||
],
|
||
"type": "string"
|
||
},
|
||
"mihomoX25519": {
|
||
"type": "boolean"
|
||
},
|
||
"muxParams": {},
|
||
"nodeGuids": {
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"type": "array"
|
||
},
|
||
"overrideSniFromAddress": {
|
||
"type": "boolean"
|
||
},
|
||
"path": {
|
||
"type": "string"
|
||
},
|
||
"pinnedPeerCertSha256": {
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"type": "array"
|
||
},
|
||
"port": {
|
||
"example": 8443,
|
||
"maximum": 65535,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"remark": {
|
||
"example": "cdn-front",
|
||
"maxLength": 256,
|
||
"type": "string"
|
||
},
|
||
"security": {
|
||
"enum": [
|
||
"same",
|
||
"tls",
|
||
"none",
|
||
"reality"
|
||
],
|
||
"example": "same",
|
||
"type": "string"
|
||
},
|
||
"serverDescription": {
|
||
"maxLength": 64,
|
||
"type": "string"
|
||
},
|
||
"shuffleHost": {
|
||
"type": "boolean"
|
||
},
|
||
"sni": {
|
||
"type": "string"
|
||
},
|
||
"sockoptParams": {},
|
||
"sortOrder": {
|
||
"type": "integer"
|
||
},
|
||
"tags": {
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"type": "array"
|
||
},
|
||
"updatedAt": {
|
||
"type": "integer"
|
||
},
|
||
"verifyPeerCertByName": {
|
||
"type": "boolean"
|
||
},
|
||
"vlessRoute": {
|
||
"description": "VlessRoute is a free-form port/range routing spec (e.g. \"53,443,1000-2000\");\nstored verbatim, format-validated on the frontend.",
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"address",
|
||
"allowInsecure",
|
||
"alpn",
|
||
"createdAt",
|
||
"echConfigList",
|
||
"excludeFromSubTypes",
|
||
"finalMask",
|
||
"fingerprint",
|
||
"hostHeader",
|
||
"id",
|
||
"inboundId",
|
||
"isDisabled",
|
||
"isHidden",
|
||
"keepSniBlank",
|
||
"mihomoIpVersion",
|
||
"mihomoX25519",
|
||
"muxParams",
|
||
"overrideSniFromAddress",
|
||
"path",
|
||
"pinnedPeerCertSha256",
|
||
"port",
|
||
"remark",
|
||
"security",
|
||
"serverDescription",
|
||
"shuffleHost",
|
||
"sni",
|
||
"sockoptParams",
|
||
"sortOrder",
|
||
"tags",
|
||
"updatedAt",
|
||
"verifyPeerCertByName",
|
||
"vlessRoute"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"Inbound": {
|
||
"description": "Inbound represents an Xray inbound configuration with traffic statistics and settings.",
|
||
"properties": {
|
||
"clientStats": {
|
||
"description": "Client traffic statistics",
|
||
"items": {
|
||
"$ref": "#/components/schemas/ClientTraffic"
|
||
},
|
||
"type": "array"
|
||
},
|
||
"down": {
|
||
"description": "Download traffic in bytes",
|
||
"type": "integer"
|
||
},
|
||
"enable": {
|
||
"description": "Whether the inbound is enabled",
|
||
"example": true,
|
||
"type": "boolean"
|
||
},
|
||
"expiryTime": {
|
||
"description": "Expiration timestamp",
|
||
"type": "integer"
|
||
},
|
||
"fallbackParent": {
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/components/schemas/FallbackParentInfo"
|
||
}
|
||
],
|
||
"description": "FallbackParent is populated by the API layer when this inbound is\nattached as a fallback child of a VLESS/Trojan TCP-TLS master.\nThe frontend uses it to rewrite client-share links so they advertise\nthe master's externally reachable endpoint instead of the child's\nloopback listen. Not persisted.",
|
||
"nullable": true
|
||
},
|
||
"id": {
|
||
"description": "Unique identifier",
|
||
"example": 1,
|
||
"type": "integer"
|
||
},
|
||
"lastTrafficResetTime": {
|
||
"description": "Last traffic reset timestamp",
|
||
"type": "integer"
|
||
},
|
||
"listen": {
|
||
"description": "Xray configuration fields",
|
||
"type": "string"
|
||
},
|
||
"nodeId": {
|
||
"nullable": true,
|
||
"type": "integer"
|
||
},
|
||
"originNodeGuid": {
|
||
"description": "OriginNodeGuid is the panelGuid of the node that physically hosts this\ninbound, propagated up across hops (#4983). Empty for an inbound that\nlives on this panel's own xray; set to the originating node's GUID when\nthe inbound was synced from a node (kept as-is across further hops). Lets\nthe master attribute a deeply nested inbound to the real node instead of\nthe intermediate one it was fetched through.",
|
||
"type": "string"
|
||
},
|
||
"port": {
|
||
"example": 443,
|
||
"maximum": 65535,
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
},
|
||
"protocol": {
|
||
"enum": [
|
||
"vmess",
|
||
"vless",
|
||
"trojan",
|
||
"shadowsocks",
|
||
"wireguard",
|
||
"hysteria",
|
||
"http",
|
||
"mixed",
|
||
"tunnel",
|
||
"tun",
|
||
"mtproto"
|
||
],
|
||
"example": "vless",
|
||
"type": "string"
|
||
},
|
||
"remark": {
|
||
"description": "Human-readable remark",
|
||
"example": "VLESS-443",
|
||
"type": "string"
|
||
},
|
||
"settings": {},
|
||
"shareAddr": {
|
||
"type": "string"
|
||
},
|
||
"shareAddrStrategy": {
|
||
"enum": [
|
||
"node",
|
||
"listen",
|
||
"custom"
|
||
],
|
||
"type": "string"
|
||
},
|
||
"sniffing": {},
|
||
"streamSettings": {},
|
||
"subSortIndex": {
|
||
"description": "1-based sort order of this inbound's links in subscription output only (lower first; ties by id)",
|
||
"example": 1,
|
||
"minimum": 1,
|
||
"type": "integer"
|
||
},
|
||
"tag": {
|
||
"example": "in-443-tcp",
|
||
"type": "string"
|
||
},
|
||
"total": {
|
||
"description": "Total traffic limit in bytes",
|
||
"type": "integer"
|
||
},
|
||
"trafficReset": {
|
||
"description": "Traffic reset schedule",
|
||
"enum": [
|
||
"never",
|
||
"hourly",
|
||
"daily",
|
||
"weekly",
|
||
"monthly"
|
||
],
|
||
"type": "string"
|
||
},
|
||
"up": {
|
||
"description": "Upload traffic in bytes",
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"required": [
|
||
"clientStats",
|
||
"down",
|
||
"enable",
|
||
"expiryTime",
|
||
"id",
|
||
"lastTrafficResetTime",
|
||
"listen",
|
||
"port",
|
||
"protocol",
|
||
"remark",
|
||
"settings",
|
||
"shareAddr",
|
||
"shareAddrStrategy",
|
||
"sniffing",
|
||
"streamSettings",
|
||
"subSortIndex",
|
||
"tag",
|
||
"total",
|
||
"trafficReset",
|
||
"up"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"InboundClientIps": {
|
||
"description": "InboundClientIps stores IP addresses associated with inbound clients for access control.",
|
||
"properties": {
|
||
"clientEmail": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "integer"
|
||
},
|
||
"ips": {}
|
||
},
|
||
"required": [
|
||
"clientEmail",
|
||
"id",
|
||
"ips"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"InboundFallback": {
|
||
"properties": {
|
||
"alpn": {
|
||
"type": "string"
|
||
},
|
||
"childId": {
|
||
"type": "integer"
|
||
},
|
||
"dest": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "integer"
|
||
},
|
||
"masterId": {
|
||
"type": "integer"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"path": {
|
||
"type": "string"
|
||
},
|
||
"sortOrder": {
|
||
"type": "integer"
|
||
},
|
||
"xver": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"required": [
|
||
"alpn",
|
||
"childId",
|
||
"dest",
|
||
"id",
|
||
"masterId",
|
||
"name",
|
||
"path",
|
||
"sortOrder",
|
||
"xver"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"InboundOption": {
|
||
"properties": {
|
||
"id": {
|
||
"example": 1,
|
||
"type": "integer"
|
||
},
|
||
"nodeId": {
|
||
"description": "Hosting node; nil for this panel's own inbounds. Lets the clients\npage map a node filter onto inbound IDs (#4997).",
|
||
"nullable": true,
|
||
"type": "integer"
|
||
},
|
||
"port": {
|
||
"example": 443,
|
||
"type": "integer"
|
||
},
|
||
"protocol": {
|
||
"example": "vless",
|
||
"type": "string"
|
||
},
|
||
"remark": {
|
||
"example": "VLESS-443",
|
||
"type": "string"
|
||
},
|
||
"ssMethod": {
|
||
"type": "string"
|
||
},
|
||
"tag": {
|
||
"example": "in-443-tcp",
|
||
"type": "string"
|
||
},
|
||
"tlsFlowCapable": {
|
||
"example": true,
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"required": [
|
||
"id",
|
||
"port",
|
||
"protocol",
|
||
"remark",
|
||
"ssMethod",
|
||
"tag",
|
||
"tlsFlowCapable"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"Msg": {
|
||
"description": "Msg represents a standard API response message with success status, message text, and optional data object.",
|
||
"properties": {
|
||
"msg": {
|
||
"description": "Response message text",
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"description": "Optional data object"
|
||
},
|
||
"success": {
|
||
"description": "Indicates if the operation was successful",
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"required": [
|
||
"msg",
|
||
"obj",
|
||
"success"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"Node": {
|
||
"description": "Node represents a remote 3x-ui panel registered with the central panel.\nThe central panel polls each node's existing /panel/api/server/status\nendpoint over HTTP using the per-node ApiToken to populate the runtime\nstatus fields below.",
|
||
"properties": {
|
||
"address": {
|
||
"example": "node1.example.com",
|
||
"type": "string"
|
||
},
|
||
"allowPrivateAddress": {
|
||
"type": "boolean"
|
||
},
|
||
"apiToken": {
|
||
"example": "abcdef0123456789",
|
||
"type": "string"
|
||
},
|
||
"basePath": {
|
||
"example": "/",
|
||
"type": "string"
|
||
},
|
||
"clientCount": {
|
||
"example": 27,
|
||
"type": "integer"
|
||
},
|
||
"configDirty": {
|
||
"type": "boolean"
|
||
},
|
||
"configDirtyAt": {
|
||
"type": "integer"
|
||
},
|
||
"cpuPct": {
|
||
"example": 23.5,
|
||
"type": "number"
|
||
},
|
||
"createdAt": {
|
||
"example": 1700000000,
|
||
"type": "integer"
|
||
},
|
||
"depletedCount": {
|
||
"example": 1,
|
||
"type": "integer"
|
||
},
|
||
"enable": {
|
||
"example": true,
|
||
"type": "boolean"
|
||
},
|
||
"guid": {
|
||
"description": "Guid is the remote panel's stable self-identifier (its panelGuid),\nlearned from each heartbeat. It is the globally stable node identity used\nto attribute online clients/inbounds to the physical node across a chain\nof nodes (#4983); panel-local autoincrement ids don't survive a hop.\nObserved-state only — never user-edited.",
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"example": 1,
|
||
"type": "integer"
|
||
},
|
||
"inboundCount": {
|
||
"example": 5,
|
||
"type": "integer"
|
||
},
|
||
"inboundSyncMode": {
|
||
"enum": [
|
||
"all",
|
||
"selected"
|
||
],
|
||
"type": "string"
|
||
},
|
||
"inboundTags": {
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"type": "array"
|
||
},
|
||
"lastError": {
|
||
"type": "string"
|
||
},
|
||
"lastHeartbeat": {
|
||
"description": "unix seconds, 0 = never",
|
||
"example": 1700000000,
|
||
"type": "integer"
|
||
},
|
||
"latencyMs": {
|
||
"example": 42,
|
||
"type": "integer"
|
||
},
|
||
"memPct": {
|
||
"example": 45.1,
|
||
"type": "number"
|
||
},
|
||
"name": {
|
||
"example": "de-fra-1",
|
||
"type": "string"
|
||
},
|
||
"netDown": {
|
||
"example": 2097152,
|
||
"type": "integer"
|
||
},
|
||
"netUp": {
|
||
"example": 1048576,
|
||
"type": "integer"
|
||
},
|
||
"onlineCount": {
|
||
"example": 3,
|
||
"type": "integer"
|
||
},
|
||
"outboundTag": {
|
||
"type": "string"
|
||
},
|
||
"panelVersion": {
|
||
"example": "v3.x.x",
|
||
"type": "string"
|
||
},
|
||
"parentGuid": {
|
||
"description": "ParentGuid + Transitive are set only when a node is surfaced as part of a\nnode tree (#4983): direct nodes carry the master panel's own GUID, a\ntransitive sub-node carries its parent node's GUID. Transitive nodes are\nread-only projections (Id == 0, not persisted) — never edited or deployed.",
|
||
"type": "string"
|
||
},
|
||
"pinnedCertSha256": {
|
||
"type": "string"
|
||
},
|
||
"port": {
|
||
"example": 2053,
|
||
"maximum": 65535,
|
||
"minimum": 1,
|
||
"type": "integer"
|
||
},
|
||
"remark": {
|
||
"type": "string"
|
||
},
|
||
"scheme": {
|
||
"enum": [
|
||
"http",
|
||
"https"
|
||
],
|
||
"example": "https",
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"description": "Heartbeat-updated fields. UpdatedAt advances on every probe even when\nthe row is otherwise unchanged so the UI's \"last seen\" tooltip is\ntruthful without us having to read LastHeartbeat separately.\nonline|offline|unknown",
|
||
"example": "online",
|
||
"type": "string"
|
||
},
|
||
"tlsVerifyMode": {
|
||
"enum": [
|
||
"verify",
|
||
"skip",
|
||
"pin",
|
||
"mtls"
|
||
],
|
||
"type": "string"
|
||
},
|
||
"transitive": {
|
||
"type": "boolean"
|
||
},
|
||
"updatedAt": {
|
||
"example": 1700000000,
|
||
"type": "integer"
|
||
},
|
||
"uptimeSecs": {
|
||
"example": 86400,
|
||
"type": "integer"
|
||
},
|
||
"xrayError": {
|
||
"type": "string"
|
||
},
|
||
"xrayState": {
|
||
"description": "XrayState and XrayError are captured from the remote node's /panel/api/server/status\nduring heartbeats. They let the central panel distinguish \"panel API reachable\"\n(status=online) from \"Xray core itself has failed on the node\" for monitoring.",
|
||
"type": "string"
|
||
},
|
||
"xrayVersion": {
|
||
"example": "25.10.31",
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"address",
|
||
"allowPrivateAddress",
|
||
"apiToken",
|
||
"basePath",
|
||
"clientCount",
|
||
"configDirty",
|
||
"configDirtyAt",
|
||
"cpuPct",
|
||
"createdAt",
|
||
"depletedCount",
|
||
"enable",
|
||
"guid",
|
||
"id",
|
||
"inboundCount",
|
||
"inboundSyncMode",
|
||
"inboundTags",
|
||
"lastError",
|
||
"lastHeartbeat",
|
||
"latencyMs",
|
||
"memPct",
|
||
"name",
|
||
"netDown",
|
||
"netUp",
|
||
"onlineCount",
|
||
"outboundTag",
|
||
"panelVersion",
|
||
"pinnedCertSha256",
|
||
"port",
|
||
"remark",
|
||
"scheme",
|
||
"status",
|
||
"tlsVerifyMode",
|
||
"updatedAt",
|
||
"uptimeSecs",
|
||
"xrayError",
|
||
"xrayState",
|
||
"xrayVersion"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"OutboundTraffics": {
|
||
"description": "OutboundTraffics tracks traffic statistics for Xray outbound connections.",
|
||
"properties": {
|
||
"down": {
|
||
"type": "integer"
|
||
},
|
||
"id": {
|
||
"type": "integer"
|
||
},
|
||
"tag": {
|
||
"type": "string"
|
||
},
|
||
"total": {
|
||
"type": "integer"
|
||
},
|
||
"up": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"required": [
|
||
"down",
|
||
"id",
|
||
"tag",
|
||
"total",
|
||
"up"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"ProbeResultUI": {
|
||
"properties": {
|
||
"cpuPct": {
|
||
"example": 12.5,
|
||
"type": "number"
|
||
},
|
||
"error": {
|
||
"type": "string"
|
||
},
|
||
"latencyMs": {
|
||
"example": 42,
|
||
"type": "integer"
|
||
},
|
||
"memPct": {
|
||
"example": 45.2,
|
||
"type": "number"
|
||
},
|
||
"panelVersion": {
|
||
"example": "v3.x.x",
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"example": "online",
|
||
"type": "string"
|
||
},
|
||
"uptimeSecs": {
|
||
"example": 86400,
|
||
"type": "integer"
|
||
},
|
||
"xrayError": {
|
||
"type": "string"
|
||
},
|
||
"xrayState": {
|
||
"description": "XrayState/XrayError are populated on successful probes even when the node's\nXray core is not healthy. The UI uses them for a distinct \"panel ok, xray failed\" indicator.",
|
||
"type": "string"
|
||
},
|
||
"xrayVersion": {
|
||
"example": "25.10.31",
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"cpuPct",
|
||
"error",
|
||
"latencyMs",
|
||
"memPct",
|
||
"panelVersion",
|
||
"status",
|
||
"uptimeSecs",
|
||
"xrayError",
|
||
"xrayState",
|
||
"xrayVersion"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"Setting": {
|
||
"description": "Setting stores key-value configuration settings for the 3x-ui panel.",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer"
|
||
},
|
||
"key": {
|
||
"type": "string"
|
||
},
|
||
"value": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"id",
|
||
"key",
|
||
"value"
|
||
],
|
||
"type": "object"
|
||
},
|
||
"User": {
|
||
"description": "User represents a user account in the 3x-ui panel.",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer"
|
||
},
|
||
"password": {
|
||
"type": "string"
|
||
},
|
||
"username": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"id",
|
||
"password",
|
||
"username"
|
||
],
|
||
"type": "object"
|
||
}
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"bearerAuth": []
|
||
},
|
||
{
|
||
"cookieAuth": []
|
||
}
|
||
],
|
||
"tags": [
|
||
{
|
||
"name": "Authentication",
|
||
"description": "Two authentication modes are supported. UI sessions use a cookie set by the login endpoint. Programmatic clients (bots, scripts, remote panels) authenticate with a Bearer token taken from Settings → Security → API Token. Both work for every endpoint under /panel/api/*."
|
||
},
|
||
{
|
||
"name": "Inbounds",
|
||
"description": "Manage inbound configurations and their clients. All endpoints live under /panel/api/inbounds and require a logged-in session or Bearer token. Link-generating endpoints honour forwarded headers only when the request comes from a configured trusted proxy."
|
||
},
|
||
{
|
||
"name": "Server",
|
||
"description": "System status, log retrieval, certificate generators, Xray binary management, and backup/restore. All under /panel/api/server."
|
||
},
|
||
{
|
||
"name": "Clients",
|
||
"description": "Manage clients as first-class entities that can be attached to one or more inbounds. A single client row drives the settings.clients entry in every inbound it belongs to. Endpoints live under /panel/api/clients."
|
||
},
|
||
{
|
||
"name": "Nodes",
|
||
"description": "Manage remote 3x-ui panels acting as nodes for a central panel. All endpoints under /panel/api/nodes."
|
||
},
|
||
{
|
||
"name": "Hosts",
|
||
"description": "Per-inbound override endpoints. Each enabled host renders one extra subscription link/proxy with its own address/port/TLS, superseding the legacy externalProxy array. All endpoints under /panel/api/hosts."
|
||
},
|
||
{
|
||
"name": "Backup",
|
||
"description": "Operations that interact with the configured Telegram bot."
|
||
},
|
||
{
|
||
"name": "Settings",
|
||
"description": "Panel configuration and user credentials. All endpoints live under /panel/api/setting and require a logged-in session or Bearer token."
|
||
},
|
||
{
|
||
"name": "API Tokens",
|
||
"description": "Manage Bearer tokens used for programmatic auth (bots, central panels acting on this node, CI). Each token has a unique name and an enabled flag — disable to revoke without deleting, delete to revoke permanently. Tokens are stored as SHA-256 hashes and the plaintext is returned only once, in the create response — it cannot be retrieved afterwards, so copy it then. Send one as <code>Authorization: Bearer <token></code> on any /panel/api/* request — the token is a full-admin credential."
|
||
},
|
||
{
|
||
"name": "Xray Settings",
|
||
"description": "Xray configuration template, outbound management, Warp/Nord integration, and config testing. All endpoints under /panel/api/xray."
|
||
},
|
||
{
|
||
"name": "Subscription Server",
|
||
"description": "A separate HTTP/HTTPS server that serves proxy subscription links (standard, JSON, and Clash) to clients. The server listens on its own port (default 10882) and is configured in Settings → Subscription. Paths are configurable; defaults are shown below. All subscription endpoints set response headers for client apps to read traffic/expiry info."
|
||
},
|
||
{
|
||
"name": "WebSocket",
|
||
"description": "Real-time status updates via WebSocket. Connect once at <code>ws://<panel>/ws</code> to receive a stream of JSON messages without polling. Requires an authenticated session cookie (Bearer token auth is not supported). Each message has a <code>type</code> field that identifies the payload shape."
|
||
}
|
||
],
|
||
"paths": {
|
||
"/login": {
|
||
"post": {
|
||
"tags": [
|
||
"Authentication"
|
||
],
|
||
"summary": "Authenticate with username + password and receive a session cookie. Required before any cookie-based API call.",
|
||
"operationId": "post_login",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"username": {
|
||
"type": "string",
|
||
"description": "Panel admin username."
|
||
},
|
||
"password": {
|
||
"type": "string",
|
||
"description": "Panel admin password."
|
||
},
|
||
"twoFactorCode": {
|
||
"type": "string",
|
||
"description": "OTP code when 2FA is enabled. Omit otherwise."
|
||
}
|
||
},
|
||
"required": [
|
||
"username",
|
||
"password",
|
||
"twoFactorCode"
|
||
]
|
||
},
|
||
"example": {
|
||
"username": "admin",
|
||
"password": "admin",
|
||
"twoFactorCode": "123456"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"msg": "Logged in successfully"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Error response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": false,
|
||
"msg": "Wrong username or password"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/logout": {
|
||
"post": {
|
||
"tags": [
|
||
"Authentication"
|
||
],
|
||
"summary": "Clear the session cookie. Requires the CSRF header for browser sessions.",
|
||
"operationId": "post_logout",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/csrf-token": {
|
||
"get": {
|
||
"tags": [
|
||
"Authentication"
|
||
],
|
||
"summary": "Mint a CSRF token for the current session. The SPA replays it in the X-CSRF-Token header on unsafe requests. Bearer-token callers can skip this — the middleware short-circuits CSRF for authenticated API requests.",
|
||
"operationId": "get_csrf_token",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": "csrf-token-string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/getTwoFactorEnable": {
|
||
"post": {
|
||
"tags": [
|
||
"Authentication"
|
||
],
|
||
"summary": "Returns whether 2FA is enabled on the panel — used by the login page to decide whether to show the OTP field.",
|
||
"operationId": "post_getTwoFactorEnable",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": false
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/list": {
|
||
"get": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "List every inbound owned by the authenticated user, including each inbound’s clientStats traffic counters. settings, streamSettings, and sniffing are returned as nested JSON objects (no escaped strings); legacy callers that send them back as JSON-encoded strings are still accepted on write.",
|
||
"operationId": "get_panel_api_inbounds_list",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/Inbound"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"clientStats": [
|
||
{
|
||
"down": 2097152,
|
||
"email": "user1",
|
||
"enable": true,
|
||
"expiryTime": 1735689600000,
|
||
"id": 14825,
|
||
"inboundId": 1,
|
||
"lastOnline": 1735680000000,
|
||
"reset": 0,
|
||
"subId": "i7tvdpeffi0hvvf1",
|
||
"total": 10737418240,
|
||
"up": 1048576,
|
||
"uuid": "e18c9a96-71bf-48d4-933f-8b9a46d4290c"
|
||
}
|
||
],
|
||
"down": 0,
|
||
"enable": true,
|
||
"expiryTime": 0,
|
||
"fallbackParent": null,
|
||
"id": 1,
|
||
"lastTrafficResetTime": 0,
|
||
"listen": "",
|
||
"nodeId": null,
|
||
"originNodeGuid": "",
|
||
"port": 443,
|
||
"protocol": "vless",
|
||
"remark": "VLESS-443",
|
||
"settings": null,
|
||
"shareAddr": "",
|
||
"shareAddrStrategy": "node",
|
||
"sniffing": null,
|
||
"streamSettings": null,
|
||
"subSortIndex": 1,
|
||
"tag": "in-443-tcp",
|
||
"total": 0,
|
||
"trafficReset": "never",
|
||
"up": 0
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/list/slim": {
|
||
"get": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Same shape as /list but with settings.clients[] stripped down to {email, enable, comment} and ClientStats not enriched with UUID/SubId. Use this for list pages; fetch /get/:id when you need the full per-client payload (uuid, password, flow, ...).",
|
||
"operationId": "get_panel_api_inbounds_list_slim",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"id": 1,
|
||
"remark": "VLESS-443",
|
||
"settings": {
|
||
"clients": [
|
||
{
|
||
"email": "alice",
|
||
"enable": true
|
||
}
|
||
],
|
||
"decryption": "none"
|
||
},
|
||
"clientStats": []
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/options": {
|
||
"get": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Lightweight picker projection of the authenticated user’s inbounds. Returns id, remark, tag, protocol, port, a server-computed tlsFlowCapable flag (true for VLESS on TCP with tls or reality, or on XHTTP with VLESS encryption / vlessenc enabled), and ssMethod (the Shadowsocks cipher, empty for non-Shadowsocks inbounds — used by the client UI to generate a valid Shadowsocks 2022 PSK). Use this for dropdowns and attach pickers — it skips settings, streamSettings, and clientStats so the payload stays small even on panels with thousands of clients.",
|
||
"operationId": "get_panel_api_inbounds_options",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/InboundOption"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"id": 1,
|
||
"nodeId": null,
|
||
"port": 443,
|
||
"protocol": "vless",
|
||
"remark": "VLESS-443",
|
||
"ssMethod": "",
|
||
"tag": "in-443-tcp",
|
||
"tlsFlowCapable": true
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/get/{id}": {
|
||
"get": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Fetch a single inbound by numeric ID.",
|
||
"operationId": "get_panel_api_inbounds_get_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Inbound ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/add": {
|
||
"post": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Create a new inbound. Send the full inbound payload (protocol, port, settings, streamSettings, sniffing, remark, expiryTime, total, enable). settings, streamSettings, and sniffing may be sent as nested JSON objects (preferred) or as JSON-encoded strings (legacy).",
|
||
"operationId": "post_panel_api_inbounds_add",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"enable": true,
|
||
"remark": "VLESS-443",
|
||
"listen": "",
|
||
"port": 443,
|
||
"protocol": "vless",
|
||
"expiryTime": 0,
|
||
"total": 0,
|
||
"settings": {
|
||
"clients": [
|
||
{
|
||
"id": "...",
|
||
"email": "user1"
|
||
}
|
||
],
|
||
"decryption": "none",
|
||
"fallbacks": []
|
||
},
|
||
"streamSettings": {
|
||
"network": "tcp",
|
||
"security": "reality",
|
||
"realitySettings": {
|
||
"show": false,
|
||
"dest": "..."
|
||
}
|
||
},
|
||
"sniffing": {
|
||
"enabled": true,
|
||
"destOverride": [
|
||
"http",
|
||
"tls"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Error response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": false,
|
||
"msg": "Port 443 is already in use"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/del/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Delete an inbound by ID. Also removes its associated client stats rows.",
|
||
"operationId": "post_panel_api_inbounds_del_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Inbound ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/bulkDel": {
|
||
"post": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Delete many inbounds in one call. Processes the list sequentially; failures are reported per id and the rest still proceed. Restarts xray at most once.",
|
||
"operationId": "post_panel_api_inbounds_bulkDel",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"ids": [
|
||
1,
|
||
2,
|
||
3
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"deleted": 2,
|
||
"skipped": [
|
||
{
|
||
"id": 3,
|
||
"reason": "..."
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/update/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Replace an inbound’s configuration. Body shape mirrors /add. Heavy on inbounds with thousands of clients — prefer /setEnable for enable-only flips.",
|
||
"operationId": "post_panel_api_inbounds_update_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Inbound ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/setEnable/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Toggle only the enable flag without serialising the whole settings JSON. Recommended for UI switches on large inbounds.",
|
||
"operationId": "post_panel_api_inbounds_setEnable_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Inbound ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"enable": false
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/{id}/resetTraffic": {
|
||
"post": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Zero out upload + download counters for a single inbound. Does not touch per-client counters.",
|
||
"operationId": "post_panel_api_inbounds_id_resetTraffic",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Inbound ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/{id}/delAllClients": {
|
||
"post": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Remove every client attached to a single inbound while keeping the inbound itself. Collects emails from settings.clients[] and feeds them into the optimized bulk-delete path (runtime user removal + traffic-row cleanup + SyncInbound). Destructive and cannot be undone.",
|
||
"operationId": "post_panel_api_inbounds_id_delAllClients",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Inbound ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"deleted": 12
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/resetAllTraffics": {
|
||
"post": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Reset upload + download counters on every inbound. Destructive — accounting history is lost.",
|
||
"operationId": "post_panel_api_inbounds_resetAllTraffics",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/import": {
|
||
"post": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Bulk-import an inbound from a JSON blob (e.g. one exported via the UI). The body uses form encoding with a single \"data\" field.",
|
||
"operationId": "post_panel_api_inbounds_import",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/pushClientTraffics": {
|
||
"post": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Receive a master panel's aggregated per-client usage, keyed by the master's GUID. Stored in a side table used only for the UI display overlay and local quota enforcement — never folded into the local counters that masters poll, so delta accounting stays intact. Called panel-to-panel by the node traffic sync job.",
|
||
"operationId": "post_panel_api_inbounds_pushClientTraffics",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"masterGuid": "9f6c2d-…",
|
||
"traffics": [
|
||
{
|
||
"email": "alice",
|
||
"up": 1048576,
|
||
"down": 2097152
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/inbounds/{id}/fallbacks": {
|
||
"get": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "List the fallback rules attached to a master VLESS/Trojan TCP-TLS inbound. Each rule links one child inbound (the dest) to optional SNI/ALPN/path/dest/xver match criteria. When dest is empty the child inbound's listen+port is used.",
|
||
"operationId": "get_panel_api_inbounds_id_fallbacks",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Master inbound ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"id": 1,
|
||
"masterId": 10,
|
||
"childId": 11,
|
||
"name": "",
|
||
"alpn": "",
|
||
"path": "/vlws",
|
||
"dest": "",
|
||
"xver": 2,
|
||
"sortOrder": 0
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"post": {
|
||
"tags": [
|
||
"Inbounds"
|
||
],
|
||
"summary": "Replace the entire fallback list for a master inbound. Body is JSON. Triggers an Xray restart.",
|
||
"operationId": "post_panel_api_inbounds_id_fallbacks",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Master inbound ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"fallbacks": [
|
||
{
|
||
"childId": 11,
|
||
"path": "/vlws",
|
||
"xver": 2
|
||
},
|
||
{
|
||
"childId": 12,
|
||
"alpn": "h2",
|
||
"dest": "8443"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"msg": "Inbound updated"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/status": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Real-time machine snapshot: CPU, memory, swap, disk, network IO, load averages, open connections, Xray state. Cached and refreshed every 2 seconds in the background.",
|
||
"operationId": "get_panel_api_server_status",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"cpu": 12.5,
|
||
"mem": {
|
||
"current": 2147483648,
|
||
"total": 8589934592
|
||
},
|
||
"swap": {
|
||
"current": 0,
|
||
"total": 4294967296
|
||
},
|
||
"disk": {
|
||
"current": 53687091200,
|
||
"total": 268435456000
|
||
},
|
||
"netIO": {
|
||
"up": 1073741824,
|
||
"down": 2147483648
|
||
},
|
||
"xray": {
|
||
"state": "running",
|
||
"version": "v25.10.31"
|
||
},
|
||
"tcpCount": 42,
|
||
"load": {
|
||
"load1": 0.5,
|
||
"load5": 0.3,
|
||
"load15": 0.2
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/cpuHistory/{bucket}": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Legacy: aggregated CPU history. Use /history/cpu/:bucket instead — same data with a uniform {t, v} shape.",
|
||
"operationId": "get_panel_api_server_cpuHistory_bucket",
|
||
"parameters": [
|
||
{
|
||
"name": "bucket",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/history/{metric}/{bucket}": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Aggregated time-series for one metric. Returns an array of {t, v} samples covering the last ~6 hours.",
|
||
"operationId": "get_panel_api_server_history_metric_bucket",
|
||
"parameters": [
|
||
{
|
||
"name": "metric",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "cpu | mem | netUp | netDown | online | load1 | load5 | load15.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "bucket",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"t": 1700000000,
|
||
"v": 12.5
|
||
},
|
||
{
|
||
"t": 1700000002,
|
||
"v": 13.1
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/xrayMetricsState": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Xray runtime metrics state — whether the xray config has a `metrics` block, which expvar keys are flowing, and the current snapshot values for each. Returns an empty state when metrics are not configured.",
|
||
"operationId": "get_panel_api_server_xrayMetricsState",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/xrayMetricsHistory/{metric}/{bucket}": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Time-series history for one Xray runtime metric over the last ~6 hours. Same {t, v} shape as /history/:metric/:bucket.",
|
||
"operationId": "get_panel_api_server_xrayMetricsHistory_metric_bucket",
|
||
"parameters": [
|
||
{
|
||
"name": "metric",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "xrAlloc | xrSys | xrHeapObjects | xrNumGC | xrPauseNs.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "bucket",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/xrayObservatory": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Latest snapshot from the Xray observatory — per-outbound latency, health status, and last-probe time. Only populated when the Xray config has an observatory configured.",
|
||
"operationId": "get_panel_api_server_xrayObservatory",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/xrayObservatoryHistory/{tag}/{bucket}": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Time-series of observatory probe results for one outbound tag. Same {t, v} shape as the other history endpoints.",
|
||
"operationId": "get_panel_api_server_xrayObservatoryHistory_tag_bucket",
|
||
"parameters": [
|
||
{
|
||
"name": "tag",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Outbound tag from the observatory config.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "bucket",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/getXrayVersion": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "List Xray binary versions available for install on this host.",
|
||
"operationId": "get_panel_api_server_getXrayVersion",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
"v25.10.31",
|
||
"v25.9.15",
|
||
"v25.8.1"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/getPanelUpdateInfo": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Check whether a newer 3x-ui release is available on GitHub.",
|
||
"operationId": "get_panel_api_server_getPanelUpdateInfo",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/getConfigJson": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Return the assembled Xray config that’s currently running on this host.",
|
||
"operationId": "get_panel_api_server_getConfigJson",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/getDb": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Stream the SQLite database file as an attachment. Use as a manual backup.",
|
||
"operationId": "get_panel_api_server_getDb",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/getMigration": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Stream a cross-engine migration file as an attachment: a .dump (SQL text) on SQLite, or a .db SQLite database built from the live data on PostgreSQL.",
|
||
"operationId": "get_panel_api_server_getMigration",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/getNewUUID": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Generate a fresh UUID v4. Convenience helper for client IDs.",
|
||
"operationId": "get_panel_api_server_getNewUUID",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": "550e8400-e29b-41d4-a716-446655440000"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/getWebCertFiles": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Return this panel's own web TLS certificate and key file paths. The central panel calls it on a node (via the node API token) so \"Set Cert from Panel\" fills a node-assigned inbound with paths that exist on the node.",
|
||
"operationId": "get_panel_api_server_getWebCertFiles",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"webCertFile": "/root/cert/example.com/fullchain.pem",
|
||
"webKeyFile": "/root/cert/example.com/privkey.pem"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/descendants": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Read-only summaries (guid, parentGuid, name, address, status, versions) of the nodes this panel manages. A parent panel calls it on a node (via the node API token) to surface transitive sub-nodes in a chained topology. Counts are computed by the parent, not returned here.",
|
||
"operationId": "get_panel_api_server_descendants",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"guid": "c3d4-...",
|
||
"parentGuid": "a1b2-...",
|
||
"name": "Node3",
|
||
"address": "10.0.0.3",
|
||
"status": "online"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/getNewX25519Cert": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Generate a new X25519 keypair for Reality.",
|
||
"operationId": "get_panel_api_server_getNewX25519Cert",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"privateKey": "uN9qLfV3zH8w...",
|
||
"publicKey": "5v8xPqR2sM7k..."
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/getNewmldsa65": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Generate a new ML-DSA-65 keypair (post-quantum signature). Returns {privateKey, publicKey, seed}.",
|
||
"operationId": "get_panel_api_server_getNewmldsa65",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"privateKey": "mdsa65priv...",
|
||
"publicKey": "mdsa65pub...",
|
||
"seed": "random-seed..."
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/getNewmlkem768": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Generate a new ML-KEM-768 keypair (post-quantum KEM). Returns {clientKey, serverKey}.",
|
||
"operationId": "get_panel_api_server_getNewmlkem768",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"clientKey": "mlkem768-client...",
|
||
"serverKey": "mlkem768-server..."
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/getNewVlessEnc": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Generate VLESS encryption auth options. Returns an auths array each with id, label, encryption, and decryption fields.",
|
||
"operationId": "get_panel_api_server_getNewVlessEnc",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"auths": [
|
||
{
|
||
"id": 0,
|
||
"label": "Auth #0",
|
||
"encryption": "aes-256-gcm",
|
||
"decryption": ""
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/stopXrayService": {
|
||
"post": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Stop the Xray binary. All proxies go offline immediately.",
|
||
"operationId": "post_panel_api_server_stopXrayService",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Error response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": false,
|
||
"msg": "Xray is not running"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/restartXrayService": {
|
||
"post": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Reload Xray with the current config. Typically required after structural inbound or routing changes.",
|
||
"operationId": "post_panel_api_server_restartXrayService",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Error response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": false,
|
||
"msg": "Xray config is invalid: ..."
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/installXray/{version}": {
|
||
"post": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Download and install the specified Xray version. Pass \"latest\" for the newest release.",
|
||
"operationId": "post_panel_api_server_installXray_version",
|
||
"parameters": [
|
||
{
|
||
"name": "version",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Xray tag (e.g. v25.10.31) or \"latest\".",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/updatePanel": {
|
||
"post": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Self-update the panel to the latest version. The server restarts on success.",
|
||
"operationId": "post_panel_api_server_updatePanel",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/updateGeofile": {
|
||
"post": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Refresh the default GeoIP / GeoSite data files. Body can include a fileName, or use the /:fileName variant.",
|
||
"operationId": "post_panel_api_server_updateGeofile",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/updateGeofile/{fileName}": {
|
||
"post": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Refresh a single Geo file by filename (e.g. geoip.dat, geosite.dat).",
|
||
"operationId": "post_panel_api_server_updateGeofile_fileName",
|
||
"parameters": [
|
||
{
|
||
"name": "fileName",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Filename of the data file to refresh.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/logs/{count}": {
|
||
"post": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Return the last N lines of the panel’s own log.",
|
||
"operationId": "post_panel_api_server_logs_count",
|
||
"parameters": [
|
||
{
|
||
"name": "count",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Number of trailing log lines.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"level": "info",
|
||
"syslog": false
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": "2025/01/01 12:00:00 [INFO] Server started\n2025/01/01 12:00:01 [INFO] Xray is running"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/xraylogs/{count}": {
|
||
"post": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Return the last N lines of the Xray process log.",
|
||
"operationId": "post_panel_api_server_xraylogs_count",
|
||
"parameters": [
|
||
{
|
||
"name": "count",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Number of trailing log lines.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": "2025/01/01 12:00:00 rejected vless proxy example.com reason: no valid user\n2025/01/01 12:00:01 direct freedom ok"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/importDB": {
|
||
"post": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Restore the panel DB from an uploaded SQLite file (multipart form, field name \"db\"). The panel restarts after restore. Destructive.",
|
||
"operationId": "post_panel_api_server_importDB",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/getNewEchCert": {
|
||
"post": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Generate a new ECH (Encrypted Client Hello) keypair and config list for the given SNI.",
|
||
"operationId": "post_panel_api_server_getNewEchCert",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/server/clientIps": {
|
||
"get": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Fetch the fully aggregated inbound_client_ips database table. Used by nodes to sync recently active IPs across the cluster.",
|
||
"operationId": "get_panel_api_server_clientIps",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/InboundClientIps"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"clientEmail": "",
|
||
"id": 0,
|
||
"ips": null
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"post": {
|
||
"tags": [
|
||
"Server"
|
||
],
|
||
"summary": "Submit a list of recently active IP timestamps. The panel merges them with the existing database to maintain a unified global IP-limit view.",
|
||
"operationId": "post_panel_api_server_clientIps",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/list": {
|
||
"get": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "List every client with its attached inbound IDs and traffic record. The reverse field, if set, is returned as a nested JSON object (legacy JSON-encoded-string form is still accepted on write).",
|
||
"operationId": "get_panel_api_clients_list",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"id": 1,
|
||
"email": "alice@example.com",
|
||
"subId": "abcd1234",
|
||
"uuid": "...",
|
||
"totalGB": 53687091200,
|
||
"expiryTime": 1735689600000,
|
||
"enable": true,
|
||
"reverse": null,
|
||
"inboundIds": [
|
||
3,
|
||
5
|
||
],
|
||
"traffic": {
|
||
"up": 1024,
|
||
"down": 4096,
|
||
"enable": true
|
||
}
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/list/paged": {
|
||
"get": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Filter, sort, and paginate clients on the server. Each item is a slim row (no uuid/password/auth/flow/security/reverse/tgId) so the clients page can ship 25-ish rows in a few KB instead of the full table. The response also includes a summary computed across the full DB row set so dashboard counters stay stable as the user paginates or filters. Page size capped at 200; fetch /get/:email to obtain the full per-client payload for an edit/info modal.",
|
||
"operationId": "get_panel_api_clients_list_paged",
|
||
"parameters": [
|
||
{
|
||
"name": "page",
|
||
"in": "query",
|
||
"required": true,
|
||
"description": "1-indexed page number. Defaults to 1.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"name": "pageSize",
|
||
"in": "query",
|
||
"required": true,
|
||
"description": "Rows per page. Defaults to 25, capped at 200.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"name": "search",
|
||
"in": "query",
|
||
"required": true,
|
||
"description": "Case-insensitive substring match on email / subId / comment.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "filter",
|
||
"in": "query",
|
||
"required": true,
|
||
"description": "Status bucket: online | active | deactive | depleted | expiring.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "protocol",
|
||
"in": "query",
|
||
"required": true,
|
||
"description": "Match clients attached to at least one inbound of this protocol (vless, vmess, trojan, shadowsocks, ...).",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"in": "query",
|
||
"required": true,
|
||
"description": "Sort key: enable | email | inboundIds | traffic | remaining | expiryTime.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "order",
|
||
"in": "query",
|
||
"required": true,
|
||
"description": "ascend or descend.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"items": [
|
||
{
|
||
"email": "alice@example.com",
|
||
"subId": "abcd1234",
|
||
"enable": true,
|
||
"totalGB": 53687091200,
|
||
"expiryTime": 1735689600000,
|
||
"limitIp": 0,
|
||
"reset": 0,
|
||
"inboundIds": [
|
||
3,
|
||
5
|
||
],
|
||
"traffic": {
|
||
"up": 1024,
|
||
"down": 4096,
|
||
"enable": true
|
||
},
|
||
"createdAt": 1735000000000,
|
||
"updatedAt": 1735100000000
|
||
}
|
||
],
|
||
"total": 2000,
|
||
"filtered": 47,
|
||
"page": 1,
|
||
"pageSize": 25,
|
||
"summary": {
|
||
"total": 2000,
|
||
"active": 1850,
|
||
"online": [
|
||
"alice@example.com"
|
||
],
|
||
"depleted": [],
|
||
"expiring": [],
|
||
"deactive": []
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/get/{email}": {
|
||
"get": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Fetch one client by email, including the inbound IDs and external config IDs it is attached to.",
|
||
"operationId": "get_panel_api_clients_get_email",
|
||
"parameters": [
|
||
{
|
||
"name": "email",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client email (unique identifier).",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/add": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Create a new client and attach it to one or more inbounds in a single call. Body is JSON. Per-protocol secrets (UUID for VLESS/VMess, password for Trojan/Shadowsocks, auth for Hysteria) are generated server-side when omitted, so callers can send only the universal fields.",
|
||
"operationId": "post_panel_api_clients_add",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"client": {
|
||
"email": "alice@example.com",
|
||
"totalGB": 53687091200,
|
||
"expiryTime": 1735689600000,
|
||
"tgId": 0,
|
||
"limitIp": 0,
|
||
"enable": true
|
||
},
|
||
"inboundIds": [
|
||
3,
|
||
5
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"msg": "Client added"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/update/{email}": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Update an existing client by email. Changes propagate to every attached inbound. Body is the JSON client payload — supply the full set of fields you want to keep (the server replaces the row, it does not patch).",
|
||
"operationId": "post_panel_api_clients_update_email",
|
||
"parameters": [
|
||
{
|
||
"name": "email",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Current client email (unique identifier).",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"email": "alice@example.com",
|
||
"totalGB": 107374182400,
|
||
"expiryTime": 1767225600000,
|
||
"tgId": 123456789,
|
||
"enable": true
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"msg": "Client updated"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/del/{email}": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Delete a client by email. Removes it from every attached inbound and drops its traffic record unless keepTraffic=1 is passed.",
|
||
"operationId": "post_panel_api_clients_del_email",
|
||
"parameters": [
|
||
{
|
||
"name": "email",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client email (unique identifier).",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "keepTraffic",
|
||
"in": "query",
|
||
"required": true,
|
||
"description": "Pass 1 to retain the xray_client_traffic row after deletion.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"msg": "Client deleted"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/{email}/attach": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Attach an existing client to one or more additional inbounds. Body is JSON.",
|
||
"operationId": "post_panel_api_clients_email_attach",
|
||
"parameters": [
|
||
{
|
||
"name": "email",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client email (unique identifier).",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"inboundIds": [
|
||
7,
|
||
9
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/{email}/detach": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Detach a client from one or more inbounds without deleting the client.",
|
||
"operationId": "post_panel_api_clients_email_detach",
|
||
"parameters": [
|
||
{
|
||
"name": "email",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client email (unique identifier).",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"inboundIds": [
|
||
5
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/{email}/externalLinks": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Replace a client's external links (per-client share links and remote subscription URLs surfaced in their subscription). Sends the full set; the server replaces all rows.",
|
||
"operationId": "post_panel_api_clients_email_externalLinks",
|
||
"parameters": [
|
||
{
|
||
"name": "email",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client email (unique identifier).",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"externalLinks": [
|
||
{
|
||
"kind": "link",
|
||
"value": "vless://uuid@host:443?...#srv",
|
||
"remark": "DE"
|
||
},
|
||
{
|
||
"kind": "subscription",
|
||
"value": "https://provider.example/sub/abc",
|
||
"remark": "Provider"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/resetAllTraffics": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Reset the up/down counters for every client globally. Quotas and expiry are not affected. Triggers an Xray restart if any counter actually moved.",
|
||
"operationId": "post_panel_api_clients_resetAllTraffics",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/delDepleted": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Delete every client whose traffic quota is exhausted (used >= total, when reset is disabled) or whose expiry has passed. Returns the deleted count and triggers an Xray restart when any client was on a running inbound.",
|
||
"operationId": "post_panel_api_clients_delDepleted",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"deleted": 0
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/bulkAdjust": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Shift expiry and/or traffic quota for many clients in one call. addDays/addBytes may be negative. Clients with unlimited expiry (expiryTime=0) or unlimited traffic (totalGB=0) are skipped for the corresponding field — bulk extend never converts unlimited to limited. Returns the adjusted count and per-email skip reasons.",
|
||
"operationId": "post_panel_api_clients_bulkAdjust",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"emails": [
|
||
"alice",
|
||
"bob"
|
||
],
|
||
"addDays": 30,
|
||
"addBytes": 53687091200
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"adjusted": 2,
|
||
"skipped": [
|
||
{
|
||
"email": "carol",
|
||
"reason": "unlimited expiry"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/bulkDel": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Delete many clients in one call. The server processes the list sequentially so each delete sees the committed state of the previous one — avoids the race the per-email fan-out had on the panel side. Pass keepTraffic=true to retain the xray_client_traffic rows after deletion.",
|
||
"operationId": "post_panel_api_clients_bulkDel",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"emails": [
|
||
"alice",
|
||
"bob"
|
||
],
|
||
"keepTraffic": false
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"deleted": 2,
|
||
"skipped": [
|
||
{
|
||
"email": "carol",
|
||
"reason": "client not found"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/bulkCreate": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Create many clients in one call. Body is a JSON array of {client, inboundIds} payloads — the same shape /add accepts. Items are processed sequentially; per-email skip reasons are returned for items that fail (e.g., duplicate email). Triggers a single Xray restart at the end if any inbound was running.",
|
||
"operationId": "post_panel_api_clients_bulkCreate",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": [
|
||
{
|
||
"client": {
|
||
"email": "alice@example.com",
|
||
"totalGB": 53687091200,
|
||
"expiryTime": 0,
|
||
"enable": true
|
||
},
|
||
"inboundIds": [
|
||
7
|
||
]
|
||
},
|
||
{
|
||
"client": {
|
||
"email": "bob@example.com",
|
||
"totalGB": 53687091200,
|
||
"expiryTime": 0,
|
||
"enable": true
|
||
},
|
||
"inboundIds": [
|
||
7,
|
||
9
|
||
]
|
||
}
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"created": 2,
|
||
"skipped": [
|
||
{
|
||
"email": "alice@example.com",
|
||
"reason": "email already in use"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/groups/bulkAdd": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Add many clients to a group in one call. Updates clients.group_name and patches the matching client entry inside every owning inbound's settings JSON in a single transaction. If the group name does not yet exist (in client_groups or as a derived label), it is auto-created as a persistent group. To clear the group label, use /groups/bulkRemove instead.",
|
||
"operationId": "post_panel_api_clients_groups_bulkAdd",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"emails": [
|
||
"alice",
|
||
"bob"
|
||
],
|
||
"group": "customer-a"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"affected": 2
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/groups/bulkRemove": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Clear the group label on many clients in one call. Inverse of /groups/bulkAdd. Clients themselves are kept — only the group label is cleared from clients.group_name and from each owning inbound's settings JSON. Groups become empty if all their members are removed.",
|
||
"operationId": "post_panel_api_clients_groups_bulkRemove",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"emails": [
|
||
"alice",
|
||
"bob"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"affected": 2
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/bulkAttach": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Attach many existing clients to many inbounds in one call. Each client keeps its identity (email/UUID/password/subId) and a shared traffic row; all clients are added to a target inbound in a single AddInboundClient call. Clients already present on a target are reported under skipped. Returns per-email attached/skipped/errors lists and triggers a single Xray restart if any target inbound was running.",
|
||
"operationId": "post_panel_api_clients_bulkAttach",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"emails": [
|
||
"alice",
|
||
"bob"
|
||
],
|
||
"inboundIds": [
|
||
7,
|
||
9
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"attached": [
|
||
"alice",
|
||
"bob"
|
||
],
|
||
"skipped": [
|
||
"bob"
|
||
],
|
||
"errors": []
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/bulkDetach": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Mirror of bulkAttach: detach many existing clients from many inbounds in one call. For each email, intersects the client's current inbounds with the requested set and detaches from those only; (email, inbound) pairs where the client is not currently attached are silently no-ops. Emails not attached to any of the requested inbounds are reported under skipped. Client records are kept even if they become orphaned — use bulkDel for full removal. Returns per-email detached/skipped/errors lists and triggers a single Xray restart if any target inbound was running.",
|
||
"operationId": "post_panel_api_clients_bulkDetach",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"emails": [
|
||
"alice",
|
||
"bob"
|
||
],
|
||
"inboundIds": [
|
||
7,
|
||
9
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"detached": [
|
||
"alice",
|
||
"bob"
|
||
],
|
||
"skipped": [],
|
||
"errors": []
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/bulkResetTraffic": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Zero up/down counters for many clients in one call. Loops the single-reset path so each client is re-enabled across its attached inbounds and pushed to Xray/remote nodes. Returns the count of successfully reset clients.",
|
||
"operationId": "post_panel_api_clients_bulkResetTraffic",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"emails": [
|
||
"alice",
|
||
"bob"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"affected": 2
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/groups": {
|
||
"get": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "List all client groups with their member counts. Merges persisted groups (rows in client_groups, including empty placeholders) with the distinct group_name values currently set on clients. Sorted alphabetically (case-insensitive).",
|
||
"operationId": "get_panel_api_clients_groups",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"name": "customer-a",
|
||
"clientCount": 5
|
||
},
|
||
{
|
||
"name": "internal",
|
||
"clientCount": 0
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/groups/{name}/emails": {
|
||
"get": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Return just the email list of clients that currently belong to the given group. Useful for fanning a single bulk action over an entire group without round-tripping the full client list.",
|
||
"operationId": "get_panel_api_clients_groups_name_emails",
|
||
"parameters": [
|
||
{
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Group name (URL-encoded).",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
"alice",
|
||
"bob",
|
||
"carol"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/groups/create": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Create a new empty (placeholder) group. The group becomes selectable in client forms and the filter drawer even before any client is added to it. Errors if a group with the same name already exists.",
|
||
"operationId": "post_panel_api_clients_groups_create",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"name": "customer-a"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"name": "customer-a"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/groups/rename": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Rename a group. The new name is applied to the client_groups row AND propagated to every matching client (both clients.group_name and the client entry inside every owning inbound's settings JSON) in a single transaction. Returns the number of clients whose label was updated.",
|
||
"operationId": "post_panel_api_clients_groups_rename",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"oldName": "customer-a",
|
||
"newName": "tier-1"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"affected": 5
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/groups/delete": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Remove a group. Deletes the client_groups row and clears the group label from every matching client (both clients.group_name and the inbound settings JSON). The clients themselves are NOT deleted — use /bulkDel after filtering by group for that. Returns the count of clients whose label was cleared.",
|
||
"operationId": "post_panel_api_clients_groups_delete",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"name": "customer-a"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"affected": 5
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/resetTraffic/{email}": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Zero out a single client’s up/down counters. Re-enables the client across every attached inbound and pushes the change to Xray (or the remote node) so depleted users can connect again immediately.",
|
||
"operationId": "post_panel_api_clients_resetTraffic_email",
|
||
"parameters": [
|
||
{
|
||
"name": "email",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client email.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/updateTraffic/{email}": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Manually adjust a client’s upload + download counters. Useful for migrations from external accounting systems.",
|
||
"operationId": "post_panel_api_clients_updateTraffic_email",
|
||
"parameters": [
|
||
{
|
||
"name": "email",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client email.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"upload": 1073741824,
|
||
"download": 5368709120
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/ips/{email}": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "List source IPs that have connected with the given client’s credentials. Returns an array of \"ip (timestamp)\" strings.",
|
||
"operationId": "post_panel_api_clients_ips_email",
|
||
"parameters": [
|
||
{
|
||
"name": "email",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client email.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/clearIps/{email}": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Reset the recorded IP list for a client.",
|
||
"operationId": "post_panel_api_clients_clearIps_email",
|
||
"parameters": [
|
||
{
|
||
"name": "email",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client email.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/onlines": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "List the emails of currently connected clients (last seen within the heartbeat window), deduped across every node.",
|
||
"operationId": "post_panel_api_clients_onlines",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
"user1",
|
||
"user2"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/onlinesByGuid": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Online client emails grouped by the panelGuid of the node that physically hosts each client. The local panel uses its own GUID; each node (at any depth in a chain) uses its GUID. Lets the inbounds page attribute online status to the real node instead of the intermediate one it syncs through.",
|
||
"operationId": "post_panel_api_clients_onlinesByGuid",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"a1b2-...": [
|
||
"user1"
|
||
],
|
||
"c3d4-...": [
|
||
"user1",
|
||
"user2"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/clientIpsByGuid": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Per-client source IPs grouped by the panelGuid of the node that observed them. Lets the central panel attribute and enforce per-client IP limits using the real visitor IPs each node sees, instead of the address of the intermediate panel it syncs through.",
|
||
"operationId": "post_panel_api_clients_clientIpsByGuid",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"a1b2-...": {
|
||
"user1": [
|
||
{
|
||
"ip": "1.2.3.4",
|
||
"timestamp": 1700000000
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/activeInbounds": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Inbound tags that carried traffic within the heartbeat window, grouped by the hosting node's panelGuid. Pairs with onlinesByGuid so the inbounds page only marks a multi-inbound client online on the inbounds it actually used. Nodes that do not report per-inbound activity are absent.",
|
||
"operationId": "post_panel_api_clients_activeInbounds",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"a1b2-...": [
|
||
"in-443-tcp",
|
||
"in-8443-tcp"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/lastOnline": {
|
||
"post": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Map of client email → last-seen unix timestamp.",
|
||
"operationId": "post_panel_api_clients_lastOnline",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"user1": 1700000000,
|
||
"user2": 1699999000
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/traffic/{email}": {
|
||
"get": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Traffic counters for a client identified by email.",
|
||
"operationId": "get_panel_api_clients_traffic_email",
|
||
"parameters": [
|
||
{
|
||
"name": "email",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client email (unique across the panel).",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"$ref": "#/components/schemas/ClientTraffic"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"down": 2097152,
|
||
"email": "user1",
|
||
"enable": true,
|
||
"expiryTime": 1735689600000,
|
||
"id": 14825,
|
||
"inboundId": 1,
|
||
"lastOnline": 1735680000000,
|
||
"reset": 0,
|
||
"subId": "i7tvdpeffi0hvvf1",
|
||
"total": 10737418240,
|
||
"up": 1048576,
|
||
"uuid": "e18c9a96-71bf-48d4-933f-8b9a46d4290c"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/subLinks/{subId}": {
|
||
"get": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Return every protocol URL (vless://, vmess://, trojan://, ss://, hysteria://, hy2://) for clients matching the subscription ID. Same result set as /sub/<subId>, but as a JSON array — no base64. When an inbound has streamSettings.externalProxy set, one URL is emitted per external proxy. Empty array when the subId has no enabled clients.",
|
||
"operationId": "get_panel_api_clients_subLinks_subId",
|
||
"parameters": [
|
||
{
|
||
"name": "subId",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Subscription ID, taken from the client's subId field.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
"vless://uuid@host:443?security=reality&...#user1",
|
||
"vmess://eyJ2IjoyLC..."
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/clients/links/{email}": {
|
||
"get": {
|
||
"tags": [
|
||
"Clients"
|
||
],
|
||
"summary": "Return every URL for one client across all attached inbounds — the same strings the Copy URL button copies in the panel UI. Supported protocols: vmess, vless, trojan, shadowsocks, hysteria. If streamSettings.externalProxy is set, returns one URL per external proxy. Protocols without a URL form (socks, http, mixed, wireguard, dokodemo, tunnel) contribute nothing.",
|
||
"operationId": "get_panel_api_clients_links_email",
|
||
"parameters": [
|
||
{
|
||
"name": "email",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client email (unique identifier).",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
"vless://uuid@host:443?...#user1"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/list": {
|
||
"get": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "List every configured node with its connection details, health, and last heartbeat patch.",
|
||
"operationId": "get_panel_api_nodes_list",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/Node"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"address": "node1.example.com",
|
||
"allowPrivateAddress": false,
|
||
"apiToken": "abcdef0123456789",
|
||
"basePath": "/",
|
||
"clientCount": 27,
|
||
"configDirty": false,
|
||
"configDirtyAt": 0,
|
||
"cpuPct": 23.5,
|
||
"createdAt": 1700000000,
|
||
"depletedCount": 1,
|
||
"enable": true,
|
||
"guid": "",
|
||
"id": 1,
|
||
"inboundCount": 5,
|
||
"inboundSyncMode": "all",
|
||
"inboundTags": [
|
||
""
|
||
],
|
||
"lastError": "",
|
||
"lastHeartbeat": 1700000000,
|
||
"latencyMs": 42,
|
||
"memPct": 45.1,
|
||
"name": "de-fra-1",
|
||
"netDown": 2097152,
|
||
"netUp": 1048576,
|
||
"onlineCount": 3,
|
||
"outboundTag": "",
|
||
"panelVersion": "v3.x.x",
|
||
"parentGuid": "",
|
||
"pinnedCertSha256": "",
|
||
"port": 2053,
|
||
"remark": "",
|
||
"scheme": "https",
|
||
"status": "online",
|
||
"tlsVerifyMode": "verify",
|
||
"transitive": false,
|
||
"updatedAt": 1700000000,
|
||
"uptimeSecs": 86400,
|
||
"xrayError": "",
|
||
"xrayState": "",
|
||
"xrayVersion": "25.10.31"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/mtls/ca": {
|
||
"post": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "This panel's node-auth CA certificate (public, PEM) to paste into a node's mTLS trust setting. Lazily mints the CA and the master client cert on first call. Pair with setting tlsVerifyMode=mtls on the node.",
|
||
"operationId": "post_panel_api_nodes_mtls_ca",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"caCert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/mtls/trustCA": {
|
||
"post": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Set the CA certificate this panel trusts for incoming node-API client certificates (this panel acting as a node). Paste the managing panel's CA (from nodes/mtls/ca). An empty caCert disables it. A non-empty value must be a PEM certificate. Applied on the next panel restart.",
|
||
"operationId": "post_panel_api_nodes_mtls_trustCA",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"caCert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/get/{id}": {
|
||
"get": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Fetch a single node by ID.",
|
||
"operationId": "get_panel_api_nodes_get_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Node ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/webCert/{id}": {
|
||
"get": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Fetch a node's own web TLS certificate/key file paths (proxied to the node). Used by the inbound form's \"Set Cert from Panel\" so a node-assigned inbound gets paths that exist on the node, not the central panel.",
|
||
"operationId": "get_panel_api_nodes_webCert_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Node ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"webCertFile": "/root/cert/example.com/fullchain.pem",
|
||
"webKeyFile": "/root/cert/example.com/privkey.pem"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/add": {
|
||
"post": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Register a new remote node. Provide its URL, apiToken, and optional remark / allowPrivateAddress flag.",
|
||
"operationId": "post_panel_api_nodes_add",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"name": "de-fra-1",
|
||
"remark": "",
|
||
"scheme": "https",
|
||
"address": "node1.example.com",
|
||
"port": 2053,
|
||
"basePath": "/",
|
||
"apiToken": "abcdef...",
|
||
"enable": true,
|
||
"allowPrivateAddress": false
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/update/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Replace a node’s connection details. Same body shape as /add.",
|
||
"operationId": "post_panel_api_nodes_update_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Node ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"name": "de-fra-1",
|
||
"remark": "",
|
||
"scheme": "https",
|
||
"address": "node1.example.com",
|
||
"port": 2053,
|
||
"basePath": "/",
|
||
"apiToken": "abcdef...",
|
||
"enable": true,
|
||
"allowPrivateAddress": false
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/del/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Delete a node. Inbounds bound to it are not auto-migrated.",
|
||
"operationId": "post_panel_api_nodes_del_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Node ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/setEnable/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Pause or resume traffic sync with this node.",
|
||
"operationId": "post_panel_api_nodes_setEnable_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Node ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"enable": true
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/test": {
|
||
"post": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Probe a node without saving it. Uses the body as connection details and returns the same heartbeat snapshot a registered node would have.",
|
||
"operationId": "post_panel_api_nodes_test",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"scheme": "https",
|
||
"address": "node1.example.com",
|
||
"port": 2053,
|
||
"basePath": "/",
|
||
"apiToken": "abcdef..."
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"$ref": "#/components/schemas/ProbeResultUI"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"cpuPct": 12.5,
|
||
"error": "",
|
||
"latencyMs": 42,
|
||
"memPct": 45.2,
|
||
"panelVersion": "v3.x.x",
|
||
"status": "online",
|
||
"uptimeSecs": 86400,
|
||
"xrayError": "",
|
||
"xrayState": "",
|
||
"xrayVersion": "25.10.31"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/certFingerprint": {
|
||
"post": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Connect to the node over HTTPS without verifying its certificate and return the leaf certificate's SHA-256 (base64). Used by the Add/Edit Node dialog to fetch and pin a self-signed certificate. Uses the same body as /test.",
|
||
"operationId": "post_panel_api_nodes_certFingerprint",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"scheme": "https",
|
||
"address": "node1.example.com",
|
||
"port": 2053,
|
||
"basePath": "/"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": "k3b1...base64-sha256...="
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/inbounds": {
|
||
"post": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Use unsaved node connection details to list the remote inbounds available for selective import.",
|
||
"operationId": "post_panel_api_nodes_inbounds",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"name": "de-fra-1",
|
||
"scheme": "https",
|
||
"address": "node1.example.com",
|
||
"port": 2053,
|
||
"basePath": "/",
|
||
"apiToken": "abcdef..."
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"tag": "inbound-443",
|
||
"remark": "VLESS",
|
||
"protocol": "vless",
|
||
"port": 443
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/probe/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Probe an existing node, updating its cached health state.",
|
||
"operationId": "post_panel_api_nodes_probe_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Node ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/updatePanel": {
|
||
"post": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Trigger the official panel self-updater on each given node (downloads the latest release and restarts). Only enabled, online nodes are updated; offline/disabled ones are reported as skipped. Returns a per-node result list.",
|
||
"operationId": "post_panel_api_nodes_updatePanel",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"ids": [
|
||
1,
|
||
2,
|
||
3
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"id": 1,
|
||
"name": "de-1",
|
||
"ok": true
|
||
},
|
||
{
|
||
"id": 2,
|
||
"name": "fr-1",
|
||
"ok": false,
|
||
"error": "node is offline"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/nodes/history/{id}/{metric}/{bucket}": {
|
||
"get": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Aggregated metric history for a node — same shape as /server/history, scoped to one node.",
|
||
"operationId": "get_panel_api_nodes_history_id_metric_bucket",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Node ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"name": "metric",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "cpu | mem.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "bucket",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Bucket size in seconds. Allowed: 2, 30, 60, 120, 180, 300.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/hosts/list": {
|
||
"get": {
|
||
"tags": [
|
||
"Hosts"
|
||
],
|
||
"summary": "List every host across all inbounds, grouped by inbound then ordered by sort order.",
|
||
"operationId": "get_panel_api_hosts_list",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/Host"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"address": "cdn.example.com",
|
||
"allowInsecure": false,
|
||
"alpn": [
|
||
""
|
||
],
|
||
"createdAt": 0,
|
||
"echConfigList": "",
|
||
"excludeFromSubTypes": [
|
||
""
|
||
],
|
||
"finalMask": "",
|
||
"fingerprint": "",
|
||
"hostHeader": "",
|
||
"id": 1,
|
||
"inboundId": 1,
|
||
"isDisabled": false,
|
||
"isHidden": false,
|
||
"keepSniBlank": false,
|
||
"mihomoIpVersion": "dual",
|
||
"mihomoX25519": false,
|
||
"muxParams": null,
|
||
"nodeGuids": [
|
||
""
|
||
],
|
||
"overrideSniFromAddress": false,
|
||
"path": "",
|
||
"pinnedPeerCertSha256": [
|
||
""
|
||
],
|
||
"port": 8443,
|
||
"remark": "cdn-front",
|
||
"security": "same",
|
||
"serverDescription": "",
|
||
"shuffleHost": false,
|
||
"sni": "",
|
||
"sockoptParams": null,
|
||
"sortOrder": 0,
|
||
"tags": [
|
||
""
|
||
],
|
||
"updatedAt": 0,
|
||
"verifyPeerCertByName": false,
|
||
"vlessRoute": ""
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/hosts/get/{id}": {
|
||
"get": {
|
||
"tags": [
|
||
"Hosts"
|
||
],
|
||
"summary": "Fetch a single host by ID.",
|
||
"operationId": "get_panel_api_hosts_get_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Host ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"$ref": "#/components/schemas/Host"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"address": "cdn.example.com",
|
||
"allowInsecure": false,
|
||
"alpn": [
|
||
""
|
||
],
|
||
"createdAt": 0,
|
||
"echConfigList": "",
|
||
"excludeFromSubTypes": [
|
||
""
|
||
],
|
||
"finalMask": "",
|
||
"fingerprint": "",
|
||
"hostHeader": "",
|
||
"id": 1,
|
||
"inboundId": 1,
|
||
"isDisabled": false,
|
||
"isHidden": false,
|
||
"keepSniBlank": false,
|
||
"mihomoIpVersion": "dual",
|
||
"mihomoX25519": false,
|
||
"muxParams": null,
|
||
"nodeGuids": [
|
||
""
|
||
],
|
||
"overrideSniFromAddress": false,
|
||
"path": "",
|
||
"pinnedPeerCertSha256": [
|
||
""
|
||
],
|
||
"port": 8443,
|
||
"remark": "cdn-front",
|
||
"security": "same",
|
||
"serverDescription": "",
|
||
"shuffleHost": false,
|
||
"sni": "",
|
||
"sockoptParams": null,
|
||
"sortOrder": 0,
|
||
"tags": [
|
||
""
|
||
],
|
||
"updatedAt": 0,
|
||
"verifyPeerCertByName": false,
|
||
"vlessRoute": ""
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/hosts/byInbound/{inboundId}": {
|
||
"get": {
|
||
"tags": [
|
||
"Hosts"
|
||
],
|
||
"summary": "Fetch one inbound's hosts, ordered by sort order then id.",
|
||
"operationId": "get_panel_api_hosts_byInbound_inboundId",
|
||
"parameters": [
|
||
{
|
||
"name": "inboundId",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Inbound ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/Host"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"address": "cdn.example.com",
|
||
"allowInsecure": false,
|
||
"alpn": [
|
||
""
|
||
],
|
||
"createdAt": 0,
|
||
"echConfigList": "",
|
||
"excludeFromSubTypes": [
|
||
""
|
||
],
|
||
"finalMask": "",
|
||
"fingerprint": "",
|
||
"hostHeader": "",
|
||
"id": 1,
|
||
"inboundId": 1,
|
||
"isDisabled": false,
|
||
"isHidden": false,
|
||
"keepSniBlank": false,
|
||
"mihomoIpVersion": "dual",
|
||
"mihomoX25519": false,
|
||
"muxParams": null,
|
||
"nodeGuids": [
|
||
""
|
||
],
|
||
"overrideSniFromAddress": false,
|
||
"path": "",
|
||
"pinnedPeerCertSha256": [
|
||
""
|
||
],
|
||
"port": 8443,
|
||
"remark": "cdn-front",
|
||
"security": "same",
|
||
"serverDescription": "",
|
||
"shuffleHost": false,
|
||
"sni": "",
|
||
"sockoptParams": null,
|
||
"sortOrder": 0,
|
||
"tags": [
|
||
""
|
||
],
|
||
"updatedAt": 0,
|
||
"verifyPeerCertByName": false,
|
||
"vlessRoute": ""
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/hosts/tags": {
|
||
"get": {
|
||
"tags": [
|
||
"Hosts"
|
||
],
|
||
"summary": "Distinct, sorted set of tags used across all hosts.",
|
||
"operationId": "get_panel_api_hosts_tags",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
"CDN",
|
||
"EU",
|
||
"FAST"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/hosts/add": {
|
||
"post": {
|
||
"tags": [
|
||
"Hosts"
|
||
],
|
||
"summary": "Create a host on an inbound. inboundId and remark are required; security defaults to \"same\" (inherit the inbound).",
|
||
"operationId": "post_panel_api_hosts_add",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"inboundId": 1,
|
||
"remark": "cdn-front",
|
||
"address": "cdn.example.com",
|
||
"port": 8443,
|
||
"security": "same",
|
||
"sni": "",
|
||
"tags": [
|
||
"CDN"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"$ref": "#/components/schemas/Host"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"address": "cdn.example.com",
|
||
"allowInsecure": false,
|
||
"alpn": [
|
||
""
|
||
],
|
||
"createdAt": 0,
|
||
"echConfigList": "",
|
||
"excludeFromSubTypes": [
|
||
""
|
||
],
|
||
"finalMask": "",
|
||
"fingerprint": "",
|
||
"hostHeader": "",
|
||
"id": 1,
|
||
"inboundId": 1,
|
||
"isDisabled": false,
|
||
"isHidden": false,
|
||
"keepSniBlank": false,
|
||
"mihomoIpVersion": "dual",
|
||
"mihomoX25519": false,
|
||
"muxParams": null,
|
||
"nodeGuids": [
|
||
""
|
||
],
|
||
"overrideSniFromAddress": false,
|
||
"path": "",
|
||
"pinnedPeerCertSha256": [
|
||
""
|
||
],
|
||
"port": 8443,
|
||
"remark": "cdn-front",
|
||
"security": "same",
|
||
"serverDescription": "",
|
||
"shuffleHost": false,
|
||
"sni": "",
|
||
"sockoptParams": null,
|
||
"sortOrder": 0,
|
||
"tags": [
|
||
""
|
||
],
|
||
"updatedAt": 0,
|
||
"verifyPeerCertByName": false,
|
||
"vlessRoute": ""
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/hosts/update/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"Hosts"
|
||
],
|
||
"summary": "Replace a host’s content. The inbound and sort order are immutable here (use /reorder for ordering).",
|
||
"operationId": "post_panel_api_hosts_update_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Host ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"inboundId": 1,
|
||
"remark": "cdn-front",
|
||
"address": "cdn.example.com",
|
||
"port": 8443,
|
||
"security": "same",
|
||
"sni": "",
|
||
"tags": [
|
||
"CDN"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"$ref": "#/components/schemas/Host"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"address": "cdn.example.com",
|
||
"allowInsecure": false,
|
||
"alpn": [
|
||
""
|
||
],
|
||
"createdAt": 0,
|
||
"echConfigList": "",
|
||
"excludeFromSubTypes": [
|
||
""
|
||
],
|
||
"finalMask": "",
|
||
"fingerprint": "",
|
||
"hostHeader": "",
|
||
"id": 1,
|
||
"inboundId": 1,
|
||
"isDisabled": false,
|
||
"isHidden": false,
|
||
"keepSniBlank": false,
|
||
"mihomoIpVersion": "dual",
|
||
"mihomoX25519": false,
|
||
"muxParams": null,
|
||
"nodeGuids": [
|
||
""
|
||
],
|
||
"overrideSniFromAddress": false,
|
||
"path": "",
|
||
"pinnedPeerCertSha256": [
|
||
""
|
||
],
|
||
"port": 8443,
|
||
"remark": "cdn-front",
|
||
"security": "same",
|
||
"serverDescription": "",
|
||
"shuffleHost": false,
|
||
"sni": "",
|
||
"sockoptParams": null,
|
||
"sortOrder": 0,
|
||
"tags": [
|
||
""
|
||
],
|
||
"updatedAt": 0,
|
||
"verifyPeerCertByName": false,
|
||
"vlessRoute": ""
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/hosts/del/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"Hosts"
|
||
],
|
||
"summary": "Delete a host.",
|
||
"operationId": "post_panel_api_hosts_del_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Host ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/hosts/setEnable/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"Hosts"
|
||
],
|
||
"summary": "Enable or disable a single host (disabled hosts are skipped in subscriptions).",
|
||
"operationId": "post_panel_api_hosts_setEnable_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Host ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"enable": true
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/hosts/reorder": {
|
||
"post": {
|
||
"tags": [
|
||
"Hosts"
|
||
],
|
||
"summary": "Set host sort order by the position of each id in the array.",
|
||
"operationId": "post_panel_api_hosts_reorder",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"ids": [
|
||
3,
|
||
1,
|
||
2
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/hosts/bulk/setEnable": {
|
||
"post": {
|
||
"tags": [
|
||
"Hosts"
|
||
],
|
||
"summary": "Enable or disable many hosts in one call.",
|
||
"operationId": "post_panel_api_hosts_bulk_setEnable",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"ids": [
|
||
1,
|
||
2,
|
||
3
|
||
],
|
||
"enable": false
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/hosts/bulk/del": {
|
||
"post": {
|
||
"tags": [
|
||
"Hosts"
|
||
],
|
||
"summary": "Delete many hosts in one call.",
|
||
"operationId": "post_panel_api_hosts_bulk_del",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
},
|
||
"example": {
|
||
"ids": [
|
||
1,
|
||
2,
|
||
3
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/backuptotgbot": {
|
||
"post": {
|
||
"tags": [
|
||
"Backup"
|
||
],
|
||
"summary": "Send a fresh DB backup to every Telegram chat configured as an admin recipient. No body, no params.",
|
||
"operationId": "post_panel_api_backuptotgbot",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/setting/all": {
|
||
"post": {
|
||
"tags": [
|
||
"Settings"
|
||
],
|
||
"summary": "Return every panel setting: web server, Telegram bot, subscription, security, LDAP. The full JSON blob that the Settings page edits.",
|
||
"operationId": "post_panel_api_setting_all",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/setting/defaultSettings": {
|
||
"post": {
|
||
"tags": [
|
||
"Settings"
|
||
],
|
||
"summary": "Return the computed default settings based on the request host. Useful to preview what a fresh install would use.",
|
||
"operationId": "post_panel_api_setting_defaultSettings",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/setting/update": {
|
||
"post": {
|
||
"tags": [
|
||
"Settings"
|
||
],
|
||
"summary": "Persist every setting at once. The body mirrors the shape returned by /all. Invalid values (bad ports, missing cert pairs, etc.) are rejected before write.",
|
||
"operationId": "post_panel_api_setting_update",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/setting/updateUser": {
|
||
"post": {
|
||
"tags": [
|
||
"Settings"
|
||
],
|
||
"summary": "Change the panel admin username and password. Requires the current credentials for verification. The session is refreshed with the new values on success.",
|
||
"operationId": "post_panel_api_setting_updateUser",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"oldUsername": {
|
||
"type": "string",
|
||
"description": "Current admin username."
|
||
},
|
||
"oldPassword": {
|
||
"type": "string",
|
||
"description": "Current admin password."
|
||
},
|
||
"newUsername": {
|
||
"type": "string",
|
||
"description": "Desired new username."
|
||
},
|
||
"newPassword": {
|
||
"type": "string",
|
||
"description": "Desired new password."
|
||
}
|
||
},
|
||
"required": [
|
||
"oldUsername",
|
||
"oldPassword",
|
||
"newUsername",
|
||
"newPassword"
|
||
]
|
||
},
|
||
"example": {
|
||
"oldUsername": "admin",
|
||
"oldPassword": "admin",
|
||
"newUsername": "newadmin",
|
||
"newPassword": "newpass"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/setting/restartPanel": {
|
||
"post": {
|
||
"tags": [
|
||
"Settings"
|
||
],
|
||
"summary": "Restart the entire 3x-ui process after a 3-second grace period. The connection drops immediately; the panel comes back online ~5-10 seconds later.",
|
||
"operationId": "post_panel_api_setting_restartPanel",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/setting/testSmtp": {
|
||
"post": {
|
||
"tags": [
|
||
"Settings"
|
||
],
|
||
"summary": "Test SMTP connection with stage-by-stage reporting (connect, auth, send). Returns structured result with stage and message.",
|
||
"operationId": "post_panel_api_setting_testSmtp",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"stage": "send",
|
||
"msg": "Test email sent successfully"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/setting/testTgBot": {
|
||
"post": {
|
||
"tags": [
|
||
"Settings"
|
||
],
|
||
"summary": "Test Telegram bot connection by sending a test message to the configured chat.",
|
||
"operationId": "post_panel_api_setting_testTgBot",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"msg": "Test message sent to Telegram"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/setting/getDefaultJsonConfig": {
|
||
"get": {
|
||
"tags": [
|
||
"Settings"
|
||
],
|
||
"summary": "Return the built-in default Xray JSON config template that ships with this panel version.",
|
||
"operationId": "get_panel_api_setting_getDefaultJsonConfig",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/setting/apiTokens": {
|
||
"get": {
|
||
"tags": [
|
||
"API Tokens"
|
||
],
|
||
"summary": "List every API token, enabled or not. The token value is never returned — only metadata.",
|
||
"operationId": "get_panel_api_setting_apiTokens",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": [
|
||
{
|
||
"id": 1,
|
||
"name": "default",
|
||
"enabled": true,
|
||
"createdAt": 1736000000
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/setting/apiTokens/create": {
|
||
"post": {
|
||
"tags": [
|
||
"API Tokens"
|
||
],
|
||
"summary": "Mint a new API token. Name must be unique and 1-64 characters; the token string is server-generated and returned only in this response — it is stored hashed and cannot be retrieved later.",
|
||
"operationId": "post_panel_api_setting_apiTokens_create",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "string",
|
||
"description": "Human-readable label, e.g. \"central-panel-a\"."
|
||
}
|
||
},
|
||
"required": [
|
||
"name"
|
||
]
|
||
},
|
||
"example": {
|
||
"name": "central-panel-a"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {
|
||
"$ref": "#/components/schemas/ApiTokenView"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"createdAt": 1736000000,
|
||
"enabled": true,
|
||
"id": 2,
|
||
"name": "central-panel-a",
|
||
"token": "new-token-string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Error response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": false,
|
||
"msg": "a token with that name already exists"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/setting/apiTokens/delete/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"API Tokens"
|
||
],
|
||
"summary": "Permanently delete a token. Any caller using it stops authenticating immediately.",
|
||
"operationId": "post_panel_api_setting_apiTokens_delete_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Token row ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/setting/apiTokens/setEnabled/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"API Tokens"
|
||
],
|
||
"summary": "Toggle a token enabled/disabled without deleting it. Disabled tokens are rejected by checkAPIAuth on the next request.",
|
||
"operationId": "post_panel_api_setting_apiTokens_setEnabled_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Token row ID.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"enabled": {
|
||
"type": "boolean",
|
||
"description": "New enabled state."
|
||
}
|
||
},
|
||
"required": [
|
||
"enabled"
|
||
]
|
||
},
|
||
"example": {
|
||
"enabled": false
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Return the Xray config template (JSON string), available inbound tags, client reverse tags, and the configured outbound test URL in one response.",
|
||
"operationId": "post_panel_api_xray",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"success": true,
|
||
"obj": {
|
||
"xraySetting": "{...raw xray config...}",
|
||
"inboundTags": "[\"in-443-tcp\"]",
|
||
"clientReverseTags": "[]",
|
||
"outboundTestUrl": "https://www.google.com/generate_204"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/getDefaultJsonConfig": {
|
||
"get": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Return the built-in default Xray config shipped with the panel (identical to /panel/api/setting/getDefaultJsonConfig).",
|
||
"operationId": "get_panel_api_xray_getDefaultJsonConfig",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/getOutboundsTraffic": {
|
||
"get": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Return traffic statistics for every outbound. Each outbound shows up/down/total counters.",
|
||
"operationId": "get_panel_api_xray_getOutboundsTraffic",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/getXrayResult": {
|
||
"get": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Return the most recent Xray process stdout/stderr output. Useful to check for startup errors or runtime warnings.",
|
||
"operationId": "get_panel_api_xray_getXrayResult",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/update": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Save the Xray JSON config template and optionally the outbound test URL. Both are sent as form fields.",
|
||
"operationId": "post_panel_api_xray_update",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/warp/{action}": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Manage Cloudflare Warp integration. The action parameter selects the operation.",
|
||
"operationId": "post_panel_api_xray_warp_action",
|
||
"parameters": [
|
||
{
|
||
"name": "action",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "data — return Warp stats (quota, remaining). del — delete Warp data. config — return current Warp config. reg — register a new Warp endpoint (sends privateKey, publicKey). license — set a Warp+ license key (sends license).",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/nord/{action}": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Manage NordVPN integration. The action parameter selects the operation.",
|
||
"operationId": "post_panel_api_xray_nord_action",
|
||
"parameters": [
|
||
{
|
||
"name": "action",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "countries — list available countries. servers — list servers in a country (sends countryId). reg — get NordVPN credentials (sends token). setKey — store NordVPN API key (sends key). data — return current NordVPN connection data. del — delete NordVPN data.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/resetOutboundsTraffic": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Reset traffic counters for a specific outbound by tag.",
|
||
"operationId": "post_panel_api_xray_resetOutboundsTraffic",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/testOutbound": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Test an outbound configuration. Sends the outbound JSON (required), optionally all outbounds (to resolve sockopt.dialerProxy dependencies), and a mode flag.",
|
||
"operationId": "post_panel_api_xray_testOutbound",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/testOutbounds": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Test a batch of outbounds (max 50) through one shared temp xray instance. Returns an array of results in input order, each with the outbound tag, delay, HTTP status and a connect/TLS/TTFB timing breakdown.",
|
||
"operationId": "post_panel_api_xray_testOutbounds",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/balancerStatus": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Live state of routing balancers in the running core (RoutingService.GetBalancerInfo): current override and the targets the strategy prefers. Returns a map keyed by balancer tag.",
|
||
"operationId": "post_panel_api_xray_balancerStatus",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/balancerOverride": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Force a balancer in the running core to always pick one outbound (RoutingService.OverrideBalancerTarget). Applied live without a restart; cleared automatically when Xray restarts.",
|
||
"operationId": "post_panel_api_xray_balancerOverride",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/routeTest": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Ask the running core which outbound its router would pick for a synthetic connection (RoutingService.TestRoute). No traffic is sent.",
|
||
"operationId": "post_panel_api_xray_routeTest",
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/outbound-subs": {
|
||
"get": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "List all outbound subscriptions (remote URLs that supply additional outbounds), newest first.",
|
||
"operationId": "get_panel_api_xray_outbound_subs",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Create an outbound subscription. The URL is fetched, parsed into outbounds with stable tags, and merged additively into the running Xray config.",
|
||
"operationId": "post_panel_api_xray_outbound_subs",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/outbound-subs/{id}": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Update an existing outbound subscription by id. Accepts the same form fields as create.",
|
||
"operationId": "post_panel_api_xray_outbound_subs_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Subscription id.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Delete an outbound subscription by id.",
|
||
"operationId": "delete_panel_api_xray_outbound_subs_id",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Subscription id.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/outbound-subs/{id}/del": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Delete an outbound subscription by id (POST alias of DELETE for axios-friendly clients).",
|
||
"operationId": "post_panel_api_xray_outbound_subs_id_del",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Subscription id.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/outbound-subs/{id}/refresh": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Force an immediate re-fetch of the subscription and return the parsed outbounds. Signals Xray to reload.",
|
||
"operationId": "post_panel_api_xray_outbound_subs_id_refresh",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Subscription id.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/outbound-subs/{id}/move": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Reorder a subscription one step up or down in priority (controls its position in the merged outbounds).",
|
||
"operationId": "post_panel_api_xray_outbound_subs_id_move",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Subscription id.",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/panel/api/xray/outbound-subs/parse": {
|
||
"post": {
|
||
"tags": [
|
||
"Xray Settings"
|
||
],
|
||
"summary": "Preview a subscription URL: fetch and parse it into outbounds without persisting anything.",
|
||
"operationId": "post_panel_api_xray_outbound_subs_parse",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/{subPath}{subid}": {
|
||
"get": {
|
||
"tags": [
|
||
"Subscription Server"
|
||
],
|
||
"summary": "Return base64-encoded subscription links for all enabled clients matching the subscription ID. When the request has an Accept: text/html header or ?html=1, renders a styled info page instead. Default path: /sub/:subid.",
|
||
"operationId": "get_subPath_subid",
|
||
"parameters": [
|
||
{
|
||
"name": "subid",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client subscription ID.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "subPath",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/{jsonPath}{subid}": {
|
||
"get": {
|
||
"tags": [
|
||
"Subscription Server"
|
||
],
|
||
"summary": "Return subscription as a JSON array of proxy configs (one per enabled client). Only when JSON subscription is enabled in settings. Default path: /json/:subid.",
|
||
"operationId": "get_jsonPath_subid",
|
||
"parameters": [
|
||
{
|
||
"name": "subid",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client subscription ID.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "jsonPath",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/{clashPath}{subid}": {
|
||
"get": {
|
||
"tags": [
|
||
"Subscription Server"
|
||
],
|
||
"summary": "Return subscription as a Clash/Mihomo-compatible YAML config, including configured global Clash routing rules. Only when Clash subscription is enabled in settings. Default path: /clash/:subid.",
|
||
"operationId": "get_clashPath_subid",
|
||
"parameters": [
|
||
{
|
||
"name": "subid",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "Client subscription ID.",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "clashPath",
|
||
"in": "path",
|
||
"required": true,
|
||
"description": "",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/ws": {
|
||
"get": {
|
||
"tags": [
|
||
"WebSocket"
|
||
],
|
||
"summary": "Upgrade an HTTP connection to a WebSocket. Requires an authenticated session cookie (Bearer token auth is not supported here). Returns 101 Switching Protocols on success. The server then pushes JSON messages described below.",
|
||
"operationId": "get_ws",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"→ type: status": {
|
||
"ws": {
|
||
"tags": [
|
||
"WebSocket"
|
||
],
|
||
"summary": "Server health snapshot pushed every 2 seconds. Contains CPU, memory, swap, disk, network IO, load, and Xray state — same shape as <code>GET /panel/api/server/status</code>.",
|
||
"operationId": "ws_type_status",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "status",
|
||
"data": {
|
||
"cpu": 12.5,
|
||
"mem": {
|
||
"current": 2147483648,
|
||
"total": 8589934592
|
||
},
|
||
"xray": {
|
||
"state": "running"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"→ type: xrayState": {
|
||
"ws": {
|
||
"tags": [
|
||
"WebSocket"
|
||
],
|
||
"summary": "Xray process state change. Fired when Xray starts, stops, or encounters an error.",
|
||
"operationId": "ws_type_xrayState",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "xrayState",
|
||
"data": "running"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"→ type: notification": {
|
||
"ws": {
|
||
"tags": [
|
||
"WebSocket"
|
||
],
|
||
"summary": "In-panel toast notification. Fired on Xray stop/restart, DB import, panel restart, etc.",
|
||
"operationId": "ws_type_notification",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "notification",
|
||
"title": "Xray service restarted",
|
||
"body": "Xray has been restarted successfully",
|
||
"severity": "success"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"→ type: invalidate": {
|
||
"ws": {
|
||
"tags": [
|
||
"WebSocket"
|
||
],
|
||
"summary": "Instructs the UI to re-fetch a resource. Fired when another admin session modifies data (e.g. toggling inbound enable).",
|
||
"operationId": "ws_type_invalidate",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful response",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"msg": {
|
||
"type": "string"
|
||
},
|
||
"obj": {}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "invalidate",
|
||
"resource": "inbounds"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|