You're viewing an archived version of our docs. Check out our current documentation →

Retrieve API key permissions

Gets the permissions and restrictions of an API key.

When authenticating with the admin API key, you can request information for any of your application’s keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by <redacted>.

Usage

1
2
3
4
5
6
7
8
9
from algoliasearch.search.client import SearchClientSync
from json import loads

# 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.get_api_key(
    key="myTestApiKey",
)
Python API clients v4