API Documentation

High-level endpoint map for Veil. Dashboard endpoints require authentication. Public endpoints are limited to status, OAuth entry points and static site features.

Public endpoints

MethodEndpointPurpose
GET/api/public/statusPublic uptime/version snapshot used by the status page.
GET/api/public/invite-analyticsAggregated invite click totals for the public status page.
GET/inviteRecords a source tag and redirects to Discord OAuth bot authorization.
GET/sitemap.xmlSEO sitemap for public pages.

Authenticated dashboard endpoints

ModuleExamplesNotes
Config/api/config/:guildId, /api/config/:guildId/presetLoad, save and apply server configuration presets.
Dashboard/api/dashboard/home, /api/healthcheck, /api/metrics/commandsHome widgets, server health and command analytics.
Translations/api/translations/status, /api/translations/entries, /api/translations/keyGlobal translation editor. Write operations require owner access.
Tickets/api/tickets/stats, /api/tickets/transcripts, /api/tickets/notesTicket workflow, archive, notes and canned responses.
Music/api/music/status, /api/music/action, /api/music/playlistsLive queue, controls and favorite playlists.
Logs/api/logs/view, /api/logs/export.csv, /api/logs/retention/runDiscord log viewer, CSV export and retention cleanup.
Owner/api/owner/premium, /api/owner/presence, /api/owner/bot-identity/:guildId/presetOwner-only premium, presence and per-server bot identity tools.