Base URL: /api/v1, Version: 1.0.0
This is the API spec for PostMaster.
Manage the local administrators of the application
Operation | Description |
---|---|
GET /admins | Get all the administrators |
POST /admins | Create an administrator |
GET /admins/{admin_id} | Get a specific administrator |
PUT /admins/{admin_id} | Update an existing administrator |
DELETE /admins/{admin_id} | Delete a specific administrator |
PUT /admins/{admin_id}/unlock | Unlocks a locked out local administrator |
Manage the email aliases
Operation | Description |
---|---|
GET /aliases | Get all the aliases |
POST /aliases | Create an alias |
GET /aliases/{alias_id} | Get a specific alias |
PUT /aliases/{alias_id} | Update an existing alias |
DELETE /aliases/{alias_id} | Delete a specific alias |
Manage the configuration items for the application
Operation | Description |
---|---|
GET /configs | Get all the configuration items |
GET /configs/{config_id} | Get a specific configuration item |
PUT /configs/{config_id} | Update an existing configuration item |
Manage the email domains the application can control
Operation | Description |
---|---|
GET /domains | Get all the domains |
POST /domains | Create a domain |
GET /domains/{domain_id} | Get a specific domain |
DELETE /domains/{domain_id} | Delete a specific domain |
Get the last 50 log entries
Operation | Description |
---|---|
GET /logs | Get the last 50 logs in the log file |
Manage the email users
Operation | Description |
---|---|
GET /users | Get all the users |
POST /users | Create a user |
GET /users/{user_id} | Get a specific user |
PUT /users/{user_id} | Update an existing user |
DELETE /users/{user_id} | Delete a specific user |
application/json
search | Search query to filter the administrators returned |
query | string (string) |
application/json
The requested administrators were returned
application/json
The administrator object to create
application/json
The administrator was created
The administrator was not found
application/json
admin_id | The ID of the administrator to unlock |
path | integer (int64) |
application/json
The administrator was unlocked
The administrator was not found
application/json
admin_id | The ID of administrator to delete |
path | integer (int64) |
application/json
The administrator was deleted
The administrator was not found
application/json
admin_id | The ID of the administrator to return |
path | integer (int64) |
application/json
The administrator was returned
The administrator was not found
application/json
The attributes of the administrator to update
admin_id | The ID of the administrator to update |
path | integer (int64) |
application/json
The administrator was updated
The administrator was not found
application/json
search | Search query to filter the aliases returned |
query | string (string) |
application/json
The requested aliases were returned
application/json
The alias object to create
application/json
The alias was created
The alias was not found
application/json
alias_id | The ID of the alias to delete |
path | integer (int64) |
application/json
The alias was deleted
The alias was not found
application/json
alias_id | The ID of the alias to return |
path | integer (int64) |
application/json
The alias was returned
The alias was not found
application/json
The attributes of the alias to update
alias_id | The ID of the alias to update |
path | integer (int64) |
application/json
The alias was updated
The alias was not found
application/json
application/json
The configuration items were returned
application/json
config_id | The ID of configuration item to return |
path | integer (int64) |
application/json
The configuration item was returned
The configuration item was not found
application/json
The configuration item value to update
config_id | The ID of the configuration item to return |
path | integer (int64) |
application/json
The configuration item was updated
The configuration item was not found
application/json
search | Search query to filter the domains returned |
query | string (string) |
application/json
The requested domains were returned
application/json
The domain object to create
application/json
The domain was created
The domain was not found
application/json
domain_id | The ID of the domain to delete |
path | integer (int64) |
application/json
The domain was deleted
The domain was not found
application/json
domain_id | The ID of the domain to return |
path | integer (int64) |
application/json
The domain was returned
The domain was not found
application/json
The last 50 logs in the log file were returned
application/json
search | Search query to filter the users returned |
query | string (string) |
application/json
The requested users were returned
application/json
The user object to create
application/json
The user was created
The user was not found
application/json
user_id | The ID of the user to delete |
path | integer (int64) |
application/json
The user was deleted
The user was not found
application/json
user_id | The ID of the user to return |
path | integer (int64) |
application/json
The user was returned
The user was not found
application/json
The attributes of the user to update
user_id | The ID of user to update |
path | integer (int64) |
application/json
THe user was updated
The user was not found
"matt"
"hunter2"
"some_alias@example.com"
"the_real_mailbox@example.com"