API Overview

Welcome to the MyEmailVault API documentation. This section provides detailed information about the available API endpoints.

All API endpoints are prefixed with /api/v1.

Authentication

Before making requests to protected endpoints, you must authenticate with the API. See the Authentication Guide for details on how to obtain and use API tokens.

API Services

• Auth: User authentication (login, setup, status).
• Archived Emails: Retrieve and delete archived emails.
• Search: Full-text email search.
• Ingestion: Manage email ingestion sources.
• Dashboard: Aggregated statistics and summaries.
• Integrity: SHA-256 hash verification.
• Storage: File downloads.
• Upload: File uploads for PST/EML/MBOX imports.
• Users: User account management.
• IAM: Roles and permissions.
• API Keys: API key management.
• Settings: System configuration.
• Jobs: Background job queue monitoring.
• Audit Log: Audit trail queries.