List API keys

Lists all API keys associated with your Algolia application, including their permissions and restrictions.

GET /1/keys

curl

cURL

curl --request GET \
  --url https://algolia_application_id.algolia.net/1/keys \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "keys": [
    {
      "acl": [
        "search",
        "addObject"
      ],
      "createdAt": 1656345570000,
      "value": "13ad45b4d0a2f6ea65ecbddf6aa260f2",
      "description": "Used for indexing by the CLI",
      "indexes": [
        "dev_*",
        "prod_en_products"
      ],
      "maxHitsPerQuery": 0,
      "maxQueriesPerIPPerHour": 0,
      "queryParameters": "typoTolerance=strict&restrictSources=192.168.1.0/24",
      "referers": [
        "*algolia.com*"
      ],
      "validity": 86400
    }
  ]
}

Requires Admin API key

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Response

200

application/json

OK

keys · object[] · required

API keys.

Show child attributes