Get server status
Return provider and mailbox status for the accounts available to the API key.
GET /api/v1/status
Return provider and mailbox status for the accounts available to the API key.
Authentication
Pass a Fluxmail API key as a bearer token. The key determines the member, mailbox scope, and permissions for the request.
Request
curl 'http://localhost:8977/api/v1/status' \
-H "Authorization: Bearer $FLUXMAIL_API_KEY"This endpoint has no parameters or request body.
Responses
| Status | Description | Content type |
|---|---|---|
200 | Status | application/json |
400 | Invalid request | application/json |
401 | Authentication required | application/json |
403 | Permission or plan denied | application/json |
404 | Resource not found | application/json |
409 | Request conflict | application/json |
422 | Unsupported capability | application/json |
429 | Provider rate limit | application/json |
500 | Internal error | application/json |
503 | Provider unavailable | application/json |
200 response
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": {}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"data"
],
"additionalProperties": false
}Last updated