Getting Started
The PPMail API uses REST principles and returns JSON responses. All API requests require authentication using an API key.
Base URL
https://api.ppmail.us/v1
Authentication
Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Example Request
curl -X GET "https://api.ppmail.us/v1/domains" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
API Features
Domain Management
Add, configure, and manage email domains
User Management
Create and manage mailboxes and users
Alias Management
Create email aliases and forwarding rules
Statistics
Access email and spam statistics
Endpoints
Domains
GET
/v1/domains
POST
/v1/domains
GET
/v1/domains/{domain}
DELETE
/v1/domains/{domain}
Users / Mailboxes
GET
/v1/domains/{domain}/users
POST
/v1/domains/{domain}/users
PUT
/v1/domains/{domain}/users/{email}
DELETE
/v1/domains/{domain}/users/{email}
Aliases
GET
/v1/domains/{domain}/aliases
POST
/v1/domains/{domain}/aliases
DELETE
/v1/domains/{domain}/aliases/{alias}
Response Format
All responses are returned in JSON format:
{
"success": true,
"data": {
"domain": "example.com",
"active": true,
"users": 5
}
}
Error Response
{
"success": false,
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid"
}
}
Full API Documentation Coming Soon
We're working on comprehensive API documentation with code examples in multiple languages.
Request API Access