PLEXICHATNarrative Docs
Admin
Guides, route-group overviews, and live schema entry points for the Plexichat backend.
REST http://api.plexichat.com/api/v1Gateway ws://api.plexichat.com/gatewayVersion a.1.0-49
Admin API Surface
The backend exposes an operator-only admin surface in addition to the public API.
Base Path
All paths below are relative to the configured admin base path, shown here as <admin-base>. The default value is /admin, and these routes are mounted at the application root rather than under https://api.plexichat.com.
Access Model
- admin auth and most JSON routes require administrator credentials or an admin session token
- host restrictions are enforced before admin handlers run
- some UI routes are intentionally excluded from the OpenAPI schema
Route Groups
Authentication And Session Management
POST <admin-base>/loginPOST <admin-base>/verify-otpPOST <admin-base>/logoutPOST <admin-base>/auth/change-passwordGET <admin-base>/auth/security-statusPOST <admin-base>/auth/2fa/begin-setupPOST <admin-base>/auth/2fa/disablePOST <admin-base>/auth/2fa/regenerate-backup-codes
Dashboard, Logs, And Database Health
GET <admin-base>/dashboardGET <admin-base>/logsGET <admin-base>/logs/{filename}GET <admin-base>/database/pool-health
Ticket And User Operations
GET <admin-base>/ticketsGET <admin-base>/tickets/{ticket_id}PATCH <admin-base>/tickets/{ticket_id}/statusGET <admin-base>/tickets/{ticket_id}/notesPOST <admin-base>/tickets/{ticket_id}/notesGET <admin-base>/users/searchGET <admin-base>/users/{user_id}PUT <admin-base>/users/{user_id}/tierPOST <admin-base>/users/{user_id}/badges/{badge}DELETE <admin-base>/users/{user_id}/badges/{badge}GET <admin-base>/users/{user_id}/notesPOST <admin-base>/users/{user_id}/notesPOST <admin-base>/users/{user_id}/force-username-change
Security Controls
GET <admin-base>/security/blocked-ipsPOST <admin-base>/security/block-ipDELETE <admin-base>/security/unblock-ip/{ip_address}GET <admin-base>/security/access-tokensPOST <admin-base>/security/access-tokensGET <admin-base>/security/access-tokens/{token_id}PATCH <admin-base>/security/access-tokens/{token_id}POST <admin-base>/security/access-tokens/{token_id}/rotatePOST <admin-base>/security/access-tokens/{token_id}/scopesDELETE <admin-base>/security/access-tokens/{token_id}/scopes/{scope_id}POST <admin-base>/security/access-tokens/{token_id}/revokeGET <admin-base>/security/banned-usernamesPOST <admin-base>/security/banned-usernamesDELETE <admin-base>/security/banned-usernames/{pattern_id}POST <admin-base>/security/force-logoutPOST <admin-base>/security/lock-userPOST <admin-base>/security/unlock-userPOST <admin-base>/security/logout-all
Moderation And AutoMod
GET <admin-base>/hash-reportsGET <admin-base>/hash-reports/countsPOST <admin-base>/hash-reports/{report_id}/reviewGET <admin-base>/message-reportsGET <admin-base>/message-reports/countsPOST <admin-base>/message-reports/{report_id}/reviewGET <admin-base>/user-reportsGET <admin-base>/user-reports/countsPOST <admin-base>/user-reports/{report_id}/reviewGET <admin-base>/blocked-hashesPOST <admin-base>/blocked-hashesDELETE <admin-base>/blocked-hashes/{hash_value}GET <admin-base>/blocked-usersPOST <admin-base>/blocked-usersDELETE <admin-base>/blocked-users/{user_id}GET <admin-base>/automod/rulesPOST <admin-base>/automod/rulesPATCH <admin-base>/automod/rules/{rule_id}DELETE <admin-base>/automod/rules/{rule_id}GET <admin-base>/automod/configPUT <admin-base>/automod/config
Admin Telemetry And UI
GET <admin-base>/telemetry/statsGET <admin-base>/telemetry/historyPOST <admin-base>/telemetry/resetGET <admin-base>/telemetry/exportGET <admin-base>/GET <admin-base>/loginGET <admin-base>/uiGET <admin-base>/ui-dashboard
Notes
- the admin surface is operational and human/operator focused, not a public third-party integration surface
- UI routes serve HTML and redirect helpers, while the rest of the routes return JSON responses
- if
admin_ui.enabledis false, the admin router is not mounted at runtime