OpenArchiver/docs/api/index.md

aside

aside
false

API Overview

Welcome to the Open Archiver 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 Service: Handles user authentication.
• Archived Email Service: Manages archived emails.
• Dashboard Service: Provides data for the main dashboard.
• Ingestion Service: Manages email ingestion sources.
• Search Service: Handles email search functionality.
• Storage Service: Manages file storage and downloads.