Fluxmail

Get API information

Return the Fluxmail version and the URL of the OpenAPI document.

GET /api/v1

Return the Fluxmail version and the URL of the OpenAPI document.

Authentication

This endpoint does not require authentication.

Request

curl 'http://localhost:8977/api/v1'

This endpoint has no parameters or request body.

Responses

StatusDescriptionContent type
200REST API discoveryapplication/json

200 response

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "enum": [
            "fluxmail"
          ]
        },
        "version": {
          "type": "string"
        },
        "openapi": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "version",
        "openapi"
      ],
      "additionalProperties": false
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}

Last updated