ATStatus Wiki

--- title: API Reference description: Complete API documentation for ATStatus auto_generated: true last_updated: 2026-01-08T00:43:18.531Z --- # API Reference This documentation is automatically generated from the ATStatus source code. ## Authentication Most API endpoints require authentication. Include your API key in the request headers: ```bash curl -H "Authorization: Bearer YOUR_API_KEY" \ https://your-domain.com/api/endpoint ``` ## Endpoints ### Admin #### `GET` /api/admin/cache 🔓 ```bash curl -X GET \ https://your-domain.com/api/admin/cache ``` --- #### `POST` /api/admin/cache 🔓 ```bash curl -X POST \ https://your-domain.com/api/admin/cache ``` --- #### `GET` /api/admin/export 🔓 ```bash curl -X GET \ https://your-domain.com/api/admin/export ``` --- #### `POST` /api/admin/export 🔓 ```bash curl -X POST \ https://your-domain.com/api/admin/export ``` --- #### `POST` /api/admin/reset-rate-limits 🔓 POST /api/admin/reset-rate-limits Development only: Reset all rate limits This endpoint is disabled in production ```bash curl -X POST \ https://your-domain.com/api/admin/reset-rate-limits ``` --- #### `GET` /api/admin/roles 🔒 GET /api/admin/roles Get all role permission data for display in the UI. Requires ROLES_VIEW permission. ```bash curl -X GET -H "Authorization: Bearer API_KEY" \ https://your-domain.com/api/admin/roles ``` --- #### `POST` /api/admin/step-up 🔓 ⚡ Step-Up Authentication API Routes POST /api/admin/step-up - Create step-up token POST /api/admin/step-up/verify-password - Verify password for step-up POST /api/admin/step-up/verify-totp - Verify TOTP for step-up GET /api/admin/step-up/[token] - Get step-up token status ```bash curl -X POST \ https://your-domain.com/api/admin/step-up ``` --- #### `GET` /api/admin/step-up 🔓 ⚡ Step-Up Authentication API Routes POST /api/admin/step-up - Create step-up token POST /api/admin/step-up/verify-password - Verify password for step-up POST /api/admin/step-up/verify-totp - Verify TOTP for step-up GET /api/admin/step-up/[token] - Get step-up token status ```bash curl -X GET \ https://your-domain.com/api/admin/step-up ``` --- #### `GET` /api/admin/system 🔓 ```bash curl -X GET \ https://your-domain.com/api/admin/system ``` --- #### `GET` /api/admin/users 🔓 ⚡ User Management API Routes GET /api/admin/users - List users POST /api/admin/users - Create user ```bash curl -X GET \ https://your-domain.com/api/admin/users ``` --- #### `POST` /api/admin/users 🔓 ⚡ User Management API Routes GET /api/admin/users - List users POST /api/admin/users - Create user ```bash curl -X POST \ https://your-domain.com/api/admin/users ``` --- #### `POST` /api/admin/users/[id]/actions 🔓 ⚡ User Actions API Routes POST /api/admin/users/[id]/reset-password - Reset user password POST /api/admin/users/[id]/reset-2fa - Reset user 2FA POST /api/admin/users/[id]/revoke-sessions - Revoke user sessions ```bash curl -X POST \ https://your-domain.com/api/admin/users/[id]/actions ``` --- #### `GET` /api/admin/users/[id] 🔓 ⚡ User Detail API Routes GET /api/admin/users/[id] - Get user details DELETE /api/admin/users/[id] - Delete user PATCH /api/admin/users/[id] - Update user ```bash curl -X GET \ https://your-domain.com/api/admin/users/[id] ``` --- #### `DELETE` /api/admin/users/[id] 🔓 ⚡ User Detail API Routes GET /api/admin/users/[id] - Get user details DELETE /api/admin/users/[id] - Delete user PATCH /api/admin/users/[id] - Update user ```bash curl -X DELETE \ https://your-domain.com/api/admin/users/[id] ``` --- #### `PATCH` /api/admin/users/[id] 🔓 ⚡ User Detail API Routes GET /api/admin/users/[id] - Get user details DELETE /api/admin/users/[id] - Delete user PATCH /api/admin/users/[id] - Update user ```bash curl -X PATCH \ https://your-domain.com/api/admin/users/[id] ``` --- ### Api-keys #### `GET` /api/api-keys 🔓 ```bash curl -X GET \ https://your-domain.com/api/api-keys ``` --- #### `POST` /api/api-keys 🔓 ```bash curl -X POST \ https://your-domain.com/api/api-keys ``` --- #### `DELETE` /api/api-keys 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/api-keys ``` --- #### `PATCH` /api/api-keys/[id] 🔓 ```bash curl -X PATCH \ https://your-domain.com/api/api-keys/[id] ``` --- #### `DELETE` /api/api-keys/[id] 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/api-keys/[id] ``` --- ### Audit #### `GET` /api/audit 🔓 ```bash curl -X GET \ https://your-domain.com/api/audit ``` --- ### Audit-events #### `GET` /api/audit-events/export 🔓 AUDIT EVENTS EXPORT API ======================= GET /api/audit-events/export Export audit logs as JSON or CSV ```bash curl -X GET \ https://your-domain.com/api/audit-events/export ``` --- #### `GET` /api/audit-events 🔓 ENTERPRISE AUDIT LOG API ======================== GET /api/audit-events Query audit events with filters, pagination, and aggregations GET /api/audit-events/export Export audit logs as JSON or CSV GET /api/audit-events/statistics Get audit log statistics POST /api/audit-events/verify Verify audit log chain integrity ```bash curl -X GET \ https://your-domain.com/api/audit-events ``` --- #### `GET` /api/audit-events/statistics 🔓 AUDIT EVENTS STATISTICS API =========================== GET /api/audit-events/statistics Get audit log statistics and analytics ```bash curl -X GET \ https://your-domain.com/api/audit-events/statistics ``` --- #### `POST` /api/audit-events/verify 🔓 AUDIT EVENTS VERIFY API ======================= POST /api/audit-events/verify Verify the integrity of the audit log hash chain ```bash curl -X POST \ https://your-domain.com/api/audit-events/verify ``` --- ### Auth #### `POST` /api/auth/2fa/disable 🔓 ```bash curl -X POST \ https://your-domain.com/api/auth/2fa/disable ``` --- #### `POST` /api/auth/2fa/regenerate-codes 🔓 ```bash curl -X POST \ https://your-domain.com/api/auth/2fa/regenerate-codes ``` --- #### `POST` /api/auth/2fa/setup 🔓 POST /api/auth/2fa/setup Generate a new TOTP secret for 2FA setup For legacy admin: Returns instructions to add to .env For database users: Stores encrypted secret in database ```bash curl -X POST \ https://your-domain.com/api/auth/2fa/setup ``` --- #### `GET` /api/auth/2fa/status 🔓 GET /api/auth/2fa/status Check if 2FA is enabled/required for current session ```bash curl -X GET \ https://your-domain.com/api/auth/2fa/status ``` --- #### `POST` /api/auth/2fa/verify-setup 🔓 POST /api/auth/2fa/verify-setup Verify a TOTP code during 2FA setup For legacy admin: Returns .env instructions For database users: Saves encrypted secret to database ```bash curl -X POST \ https://your-domain.com/api/auth/2fa/verify-setup ``` --- #### `POST` /api/auth/change-password 🔓 ```bash curl -X POST \ https://your-domain.com/api/auth/change-password ``` --- #### `POST` /api/auth/login 🔓 ```bash curl -X POST \ https://your-domain.com/api/auth/login ``` --- #### `POST` /api/auth/logout 🔓 ```bash curl -X POST \ https://your-domain.com/api/auth/logout ``` --- #### `GET` /api/auth/me 🔓 ```bash curl -X GET \ https://your-domain.com/api/auth/me ``` --- #### `GET` /api/auth/permissions 🔓 ```bash curl -X GET \ https://your-domain.com/api/auth/permissions ``` --- #### `POST` /api/auth/verify-2fa 🔓 ```bash curl -X POST \ https://your-domain.com/api/auth/verify-2fa ``` --- ### Badge #### `GET` /api/badge 🔓 ```bash curl -X GET \ https://your-domain.com/api/badge ``` --- ### Calendar #### `GET` /api/calendar 🔓 ```bash curl -X GET \ https://your-domain.com/api/calendar ``` --- ### Comments #### `GET` /api/comments/admin 🔓 ```bash curl -X GET \ https://your-domain.com/api/comments/admin ``` --- #### `PATCH` /api/comments/admin/[id] 🔓 ```bash curl -X PATCH \ https://your-domain.com/api/comments/admin/[id] ``` --- #### `DELETE` /api/comments/admin/[id] 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/comments/admin/[id] ``` --- #### `GET` /api/comments 🔓 ```bash curl -X GET \ https://your-domain.com/api/comments ``` --- #### `POST` /api/comments 🔓 ```bash curl -X POST \ https://your-domain.com/api/comments ``` --- ### Components #### `GET` /api/components 🔓 ```bash curl -X GET \ https://your-domain.com/api/components ``` --- #### `POST` /api/components 🔓 ```bash curl -X POST \ https://your-domain.com/api/components ``` --- #### `GET` /api/components/[id]/details 🔓 ```bash curl -X GET \ https://your-domain.com/api/components/[id]/details ``` --- #### `POST` /api/components/[id]/reset-stats 🔓 ```bash curl -X POST \ https://your-domain.com/api/components/[id]/reset-stats ``` --- #### `GET` /api/components/[id]/response-times 🔓 ```bash curl -X GET \ https://your-domain.com/api/components/[id]/response-times ``` --- #### `GET` /api/components/[id] 🔓 ```bash curl -X GET \ https://your-domain.com/api/components/[id] ``` --- #### `PUT` /api/components/[id] 🔓 ```bash curl -X PUT \ https://your-domain.com/api/components/[id] ``` --- #### `PATCH` /api/components/[id] 🔓 ```bash curl -X PATCH \ https://your-domain.com/api/components/[id] ``` --- #### `DELETE` /api/components/[id] 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/components/[id] ``` --- ### Csrf #### `GET` /api/csrf 🔓 GET /api/csrf Returns a CSRF token for the current session ```bash curl -X GET \ https://your-domain.com/api/csrf ``` --- ### Export-settings #### `GET` /api/export-settings 🔓 ```bash curl -X GET \ https://your-domain.com/api/export-settings ``` --- #### `PUT` /api/export-settings 🔓 ```bash curl -X PUT \ https://your-domain.com/api/export-settings ``` --- ### Features #### `GET` /api/features 🔓 ```bash curl -X GET \ https://your-domain.com/api/features ``` --- #### `PUT` /api/features 🔓 ```bash curl -X PUT \ https://your-domain.com/api/features ``` --- ### Feed #### `GET` /api/feed/rss 🔓 ```bash curl -X GET \ https://your-domain.com/api/feed/rss ``` --- ### Groups #### `PUT` /api/groups/reorder 🔓 ```bash curl -X PUT \ https://your-domain.com/api/groups/reorder ``` --- #### `GET` /api/groups 🔓 ```bash curl -X GET \ https://your-domain.com/api/groups ``` --- #### `POST` /api/groups 🔓 ```bash curl -X POST \ https://your-domain.com/api/groups ``` --- #### `GET` /api/groups/[id] 🔓 ```bash curl -X GET \ https://your-domain.com/api/groups/[id] ``` --- #### `PUT` /api/groups/[id] 🔓 ```bash curl -X PUT \ https://your-domain.com/api/groups/[id] ``` --- #### `PATCH` /api/groups/[id] 🔓 ```bash curl -X PATCH \ https://your-domain.com/api/groups/[id] ``` --- #### `DELETE` /api/groups/[id] 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/groups/[id] ``` --- ### Health #### `GET` /api/health 🔓 ```bash curl -X GET \ https://your-domain.com/api/health ``` --- ### Incident-updates #### `POST` /api/incident-updates 🔓 ```bash curl -X POST \ https://your-domain.com/api/incident-updates ``` --- #### `DELETE` /api/incident-updates/[id] 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/incident-updates/[id] ``` --- ### Incidents #### `GET` /api/incidents 🔓 ```bash curl -X GET \ https://your-domain.com/api/incidents ``` --- #### `POST` /api/incidents 🔓 ```bash curl -X POST \ https://your-domain.com/api/incidents ``` --- #### `POST` /api/incidents/[id]/rca/generate 🔓 ```bash curl -X POST \ https://your-domain.com/api/incidents/[id]/rca/generate ``` --- #### `GET` /api/incidents/[id]/rca 🔓 ```bash curl -X GET \ https://your-domain.com/api/incidents/[id]/rca ``` --- #### `PUT` /api/incidents/[id]/rca 🔓 ```bash curl -X PUT \ https://your-domain.com/api/incidents/[id]/rca ``` --- #### `GET` /api/incidents/[id] 🔓 ```bash curl -X GET \ https://your-domain.com/api/incidents/[id] ``` --- #### `PUT` /api/incidents/[id] 🔓 ```bash curl -X PUT \ https://your-domain.com/api/incidents/[id] ``` --- #### `DELETE` /api/incidents/[id] 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/incidents/[id] ``` --- ### Maintenance #### `GET` /api/maintenance/recurring 🔓 Generate upcoming maintenance instances from recurring templates This should be called periodically (e.g., daily) to create upcoming maintenance windows ```bash curl -X GET \ https://your-domain.com/api/maintenance/recurring ``` --- #### `GET` /api/maintenance 🔓 ```bash curl -X GET \ https://your-domain.com/api/maintenance ``` --- #### `POST` /api/maintenance 🔓 ```bash curl -X POST \ https://your-domain.com/api/maintenance ``` --- #### `GET` /api/maintenance/[id] 🔓 ```bash curl -X GET \ https://your-domain.com/api/maintenance/[id] ``` --- #### `PUT` /api/maintenance/[id] 🔓 ```bash curl -X PUT \ https://your-domain.com/api/maintenance/[id] ``` --- #### `DELETE` /api/maintenance/[id] 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/maintenance/[id] ``` --- ### Manifest #### `GET` /api/manifest 🔓 ```bash curl -X GET \ https://your-domain.com/api/manifest ``` --- ### Metrics #### `GET` /api/metrics 🔓 ```bash curl -X GET \ https://your-domain.com/api/metrics ``` --- ### Monitor #### `GET` /api/monitor/check 🔓 Check if a component is currently in an active maintenance window with suppressed alerts ```bash curl -X GET \ https://your-domain.com/api/monitor/check ``` --- #### `POST` /api/monitor/check 🔓 Check if a component is currently in an active maintenance window with suppressed alerts ```bash curl -X POST \ https://your-domain.com/api/monitor/check ``` --- ### Notifications #### `GET` /api/notifications 🔓 ```bash curl -X GET \ https://your-domain.com/api/notifications ``` --- #### `POST` /api/notifications 🔓 ```bash curl -X POST \ https://your-domain.com/api/notifications ``` --- #### `GET` /api/notifications/[id] 🔓 ```bash curl -X GET \ https://your-domain.com/api/notifications/[id] ``` --- #### `PUT` /api/notifications/[id] 🔓 ```bash curl -X PUT \ https://your-domain.com/api/notifications/[id] ``` --- #### `DELETE` /api/notifications/[id] 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/notifications/[id] ``` --- #### `POST` /api/notifications/[id]/test 🔓 ```bash curl -X POST \ https://your-domain.com/api/notifications/[id]/test ``` --- ### Push #### `POST` /api/push/subscribe 🔓 ```bash curl -X POST \ https://your-domain.com/api/push/subscribe ``` --- #### `DELETE` /api/push/subscribe 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/push/subscribe ``` --- #### `GET` /api/push/subscribe 🔓 ```bash curl -X GET \ https://your-domain.com/api/push/subscribe ``` --- ### Quicklinks #### `GET` /api/quicklinks 🔓 ```bash curl -X GET \ https://your-domain.com/api/quicklinks ``` --- #### `POST` /api/quicklinks 🔓 ```bash curl -X POST \ https://your-domain.com/api/quicklinks ``` --- #### `GET` /api/quicklinks/[id] 🔓 ```bash curl -X GET \ https://your-domain.com/api/quicklinks/[id] ``` --- #### `PUT` /api/quicklinks/[id] 🔓 ```bash curl -X PUT \ https://your-domain.com/api/quicklinks/[id] ``` --- #### `DELETE` /api/quicklinks/[id] 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/quicklinks/[id] ``` --- ### Selftest #### `GET` /api/selftest 🔓 ```bash curl -X GET \ https://your-domain.com/api/selftest ``` --- ### Settings #### `GET` /api/settings 🔓 ```bash curl -X GET \ https://your-domain.com/api/settings ``` --- #### `PUT` /api/settings 🔓 ```bash curl -X PUT \ https://your-domain.com/api/settings ``` --- ### Statuspages #### `POST` /api/statuspages/current 🔓 ```bash curl -X POST \ https://your-domain.com/api/statuspages/current ``` --- #### `GET` /api/statuspages/current 🔓 ```bash curl -X GET \ https://your-domain.com/api/statuspages/current ``` --- #### `GET` /api/statuspages 🔓 ```bash curl -X GET \ https://your-domain.com/api/statuspages ``` --- #### `POST` /api/statuspages 🔓 ```bash curl -X POST \ https://your-domain.com/api/statuspages ``` --- #### `GET` /api/statuspages/[id] 🔓 ```bash curl -X GET \ https://your-domain.com/api/statuspages/[id] ``` --- #### `PUT` /api/statuspages/[id] 🔓 ```bash curl -X PUT \ https://your-domain.com/api/statuspages/[id] ``` --- #### `DELETE` /api/statuspages/[id] 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/statuspages/[id] ``` --- ### Subscribers #### `GET` /api/subscribers 🔓 ```bash curl -X GET \ https://your-domain.com/api/subscribers ``` --- #### `POST` /api/subscribers 🔓 ```bash curl -X POST \ https://your-domain.com/api/subscribers ``` --- #### `GET` /api/subscribers/verify 🔓 ```bash curl -X GET \ https://your-domain.com/api/subscribers/verify ``` --- #### `DELETE` /api/subscribers/[id] 🔓 ```bash curl -X DELETE \ https://your-domain.com/api/subscribers/[id] ``` --- ### Translate #### `POST` /api/translate 🔓 Simple dictionary-based translation using predefined i18n translations Attempts to find matching phrases in the translation dictionary ```bash curl -X POST \ https://your-domain.com/api/translate ``` --- ### V1 #### `GET` /api/v1/components/[id] 🔓 ```bash curl -X GET \ https://your-domain.com/api/v1/components/[id] ``` --- #### `GET` /api/v1/status 🔓 ⚡ ```bash curl -X GET \ https://your-domain.com/api/v1/status ``` --- ### Verify-page-password #### `POST` /api/verify-page-password 🔓 ```bash curl -X POST \ https://your-domain.com/api/verify-page-password ``` --- ### Widget #### `GET` /api/widget 🔓 ```bash curl -X GET \ https://your-domain.com/api/widget ``` ---