Athena
Api keys

List all API keys

Requires the static admin key stored in `ATHENA_KEY_12`.

GET
/admin/api-keys

Header Parameters

apikey*string

The static admin key configured as ATHENA_KEY_12. Authorization headers (Bearer <key>), X-API-Key, X-Athena-Key, or ?api_key= are also accepted.

Response Body

application/json

application/json

curl -X GET "https://athena-cluster.com/admin/api-keys" \  -H "apikey: string"
{
  "api_keys": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "public_id": "string",
      "name": "string",
      "description": "string",
      "client_name": "string",
      "expires_at": "2019-08-24T14:15:22Z",
      "is_active": true,
      "last_used_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "rights": [
        "string"
      ]
    }
  ]
}
{
  "status": "error",
  "message": "string",
  "error": "string"
}

Update an API key right PATCH

Renames or updates metadata for an existing API key right definition.

Create a new API key POST

Creates a new API key record and returns a one-time plaintext credential (`ath_{public}.{secret}`). Persist the returned secret securely; it is not retrievable later from the API.