Fluxmail

Get license status

Get license status and usage without returning the configured license key. Requires admin.license.

GET /api/v1/admin/license

Get license status and usage without returning the configured license key. Requires admin.license.

Authentication

Pass a Fluxmail API key as a bearer token. The key owner must be an administrator, and the key must include the administrative capability named in the endpoint description.

Remote administrative requests require HTTPS. Requests from the local computer can use HTTP.

Request

curl 'http://localhost:8977/api/v1/admin/license' \
  -H "Authorization: Bearer $FLUXMAIL_API_KEY"

This endpoint has no parameters or request body.

Responses

StatusDescriptionContent type
200License status without the configured keyapplication/json
400Invalid requestapplication/json
401Authentication requiredapplication/json
403Administrative access deniedapplication/json
404Resource not foundapplication/json
409Request conflictapplication/json
413Request body too largeapplication/json
415Unsupported media typeapplication/json
500Internal errorapplication/json
502License could not be verifiedapplication/json

200 response

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}

Last updated