Public API — Сводный индекс endpoint'ов

Интерактивный справочник: Swagger UI (/api/docs/public), spec — GET /api/openapi.json.

Ядро: 1.0.13 | Обновлено: 18.09.2026

Ниже — API ядра (auth, mail, db, meta). Files API — модуль 1.0.0. Методы расширений — discovery.

Public Auth — /api/v1/auth

МетодПутьАутентификация
POST/api/v1/auth/registerNone
POST/api/v1/auth/loginNone
POST/api/v1/auth/email/verifyNone
GET/api/v1/auth/meJWT (тип «public»)
PATCH/api/v1/auth/meJWT (тип «public»)
PATCH/api/v1/auth/me/passwordJWT (тип «public»)
POST/api/v1/auth/token/refreshrefresh in body
POST/api/v1/auth/logoutJWT + optional refresh
POST/api/v1/auth/mfa/setupJWT (тип «public»)
POST/api/v1/auth/mfa/enableJWT (тип «public»)
POST/api/v1/auth/mfa/disableJWT (тип «public»)

API почты — /api/v1/mail

МетодПутьАутентификация
POST/api/v1/mail/sendX-API-Key (mail:send)
GET/api/v1/mail/jobs/{job_id}X-API-Key (mail:send)

API работы с данными — /api/v1/db

МетодПутьАутентификация
POST/api/v1/db/queryX-API-Key (db:query)
POST/api/v1/db/transaction/beginX-API-Key (db:query)
POST/api/v1/db/transaction/{id}/commitX-API-Key (db:query)
POST/api/v1/db/transaction/{id}/rollbackX-API-Key (db:query)
GET/api/v1/db/transaction/listX-API-Key (db:query)
GET/api/v1/db/datasourcesX-API-Key (db:query)

Files API — модуль «Медиатека файлов» 1.0.0

Только при установленном модуле и ядре ≥ 1.0.13. Документация модуля.

МетодПутьАутентификация
POST/api/v1/files/uploadJWT или X-API-Key (files:upload)
GET/api/v1/files/{file_id}/downloadJWT или X-API-Key (files:download)
GET/api/v1/files/{file_id}JWT или X-API-Key

Раздача: /media/…

API расширений

Обзор · pattern /api/module/{plugin_name}/{path} · discovery через OpenAPI.

Meta / Observability

МетодПутьАутентификация
GET/api/openapi.jsonNone
GET/api/docs/publicNone
GET/api/v1/public/runtime-configNone или X-API-Key
GET/metricsNone