Fluxmail

GET /api/v1/admin/api-keys

List API key metadata without returning plaintext secrets. Requires admin.api_keys.

List API key metadata without returning plaintext secrets. Requires admin.api_keys.

Authentication

Pass an administrator member session or an API key as a bearer token. The key must belong to an administrator and include the capability listed above.

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

Request

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

This endpoint has no parameters or request body.

Responses

StatusDescriptionContent type
200API keysapplication/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": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "createdAt": {
            "type": "string"
          },
          "lastUsedAt": {
            "type": "string",
            "nullable": true
          },
          "memberId": {
            "type": "string"
          },
          "permissionProfile": {
            "type": "string",
            "enum": [
              "read-only",
              "read-write",
              "full",
              "custom"
            ]
          },
          "capabilities": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "mail.read",
                "mail.drafts",
                "mail.organize",
                "mail.trash",
                "mail.delete",
                "mail.send",
                "admin.accounts",
                "admin.members",
                "admin.api_keys",
                "admin.license",
                "admin.audit"
              ]
            }
          },
          "supplementalCapabilities": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "admin.accounts",
                "admin.members",
                "admin.api_keys",
                "admin.license",
                "admin.audit"
              ]
            }
          },
          "accountIds": {
            "type": "array",
            "nullable": true,
            "items": {
              "type": "string"
            }
          },
          "issuedByMemberId": {
            "type": "string",
            "nullable": true
          },
          "issuedByEmail": {
            "type": "string",
            "nullable": true
          },
          "issuedByStatus": {
            "type": "string",
            "nullable": true,
            "enum": [
              "pending",
              "active",
              "suspended",
              null
            ]
          }
        },
        "required": [
          "id",
          "name",
          "createdAt",
          "lastUsedAt",
          "memberId",
          "permissionProfile",
          "capabilities",
          "supplementalCapabilities",
          "accountIds",
          "issuedByMemberId",
          "issuedByEmail",
          "issuedByStatus"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "data"
  ]
}

Last updated