Update an API key

Replaces the permissions of an existing API key.

Any unspecified attribute resets that attribute to its default value.

Usage

Requires Admin API key
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
from algoliasearch.search.client import SearchClientSync

# In an asynchronous context, you can use SearchClient instead, which exposes the exact same methods.
client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

response = client.update_api_key(
    key="ALGOLIA_API_KEY",
    api_key={
        "acl": [
            "search",
            "addObject",
        ],
        "validity": 300,
        "maxQueriesPerIPPerHour": 100,
        "maxHitsPerQuery": 20,
    },
)
Did you find this page helpful?
Python API clients v4