API Reference
CloakMail REST API documentation
API Reference
CloakMail provides a RESTful API for programmatic access to all features. The API is designed to be simple, predictable, and easy to integrate.
Quick Links
API Overview
Introduction to the CloakMail API, authentication, and response formats
Endpoints
Complete reference for all REST API endpoints
OpenAPI Spec
Download the OpenAPI specification for code generation
Base URL
http://localhost:3000In production, replace with your actual domain:
https://api.mail.example.comAuthentication
The CloakMail API is designed to be used without authentication by default, matching the philosophy of the service — instant, anonymous access.
For production deployments with restricted access, you can configure API keys or rate limiting at the reverse proxy level.
Quick Example
# Get emails for an inbox
curl http://localhost:3000/api/inbox/test@mail.example.com
# Get a specific email
curl http://localhost:3000/api/email/abc123
# Delete an inbox
curl -X DELETE http://localhost:3000/api/inbox/test@mail.example.com
# Health check
curl http://localhost:3000/api/health