List API keys

This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.

This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.

This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.

This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.

This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.

This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.

This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.

This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.

This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.

This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.

Required API Key: Admin

Method signature

$client->listApiKeys()

client.list_api_keys()

client.listApiKeys()

client.list_api_keys()

client.listAPIKeys(
  requestOptions: RequestOptions? = nil,
  completion: Result<ListAPIKeysResponse> -> Void
)

suspend fun ClientSearch.listAPIKeys(
    requestOptions: RequestOptions? = null
): ResponseListAPIKey

client.ListApiKeys()

client.listApiKeys()

client.ListAPIKeys()

list.keys()

See code examples

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

Get a list of API keys.

Examples

Read the Algolia CLI documentation for more information.

List existing keys

Copy

1
$client->listApiKeys();

Parameters

This method doesn't take any parameters.

Response

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format

Copy

          {
  "keys": [
    {
      "value": "0eb3e6308abccdf9b67d70ddacb418b4",
      "createdAt": 1513462891,
      "acl": ["search"],
      "validity": 0
    },
    {
      "value": "90dff5755e694f341fe68aaf6e41a6d4"
      "createdAt":1470244596,
      "acl":["search"],
      "validity":0,
      "description": "Search-only API Key"
    },
    {
      "value": "d6a23f212331969e41493051ede9865f",
      "createdAt": 1513610838,
      "acl": ["search"],
      "validity": 0
    }
  ]
}

        

Field	Description
`keys`	list of

keys ➔ (api key)

Field	Description
`value`	string The API key.
`createdAt`	number The timestamp at which the key has been created. Since admin API keys don’t have a creation date, this field isn’t returned for admin API keys.
`acl`	list Set of permissions associated with the key. The possible access controls are: Search (`search`): allowed to perform search operations. Browse Index (`browse`): allowed to retrieve all index data with the `browse` endpoint. Add records (`addObject`): allowed to add or update records in the index. Delete records (`deleteObject`): allowed to delete an existing record. List indices (`listIndexes`): allowed to get a list of all existing indices. Delete index (`deleteIndex`): allowed to delete an index. Get index settings (`settings`): allowed to read all index settings. Set index settings (`editSettings`): allowed to update all index settings. Use analytics API (`analytics`): allowed to retrieve data with the Analytics API. Use recommendation API (`recommendation`): allowed to interact with the Recommendation API. Use usage API (`usage`): allowed to retrieve data with the Usage API. Access logs (`logs`): allowed to query the logs. Get unretrievable attributes (`seeUnretrievableAttributes`): allowed to retrieve `unretrievableAttributes` for all operations that return records.
`validity`	integer Timestamp of the date at which the key expires. A value of `0` means the key never expires.
`indexes`	list The list of targeted indices. This field isn’t returned when empty.
`description`	string Description for the key. This field isn’t returned when the description is empty.
`maxHitsPerQuery`	integer Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced and the field is not returned.
`maxQueriesPerIPPerHour`	integer Maximum number of API calls per hour allowed from a given IP address or a user token. Each time an API call is performed with this key, a check is performed. If the IP address or the user token at the origin of the call made more than the specified number of queries within the last hour, the API returns a 429 (Too Many Requests) status code. If zero, the field is not returned.
`queryParameters`	URL-encoded query string List query parameters that are applied for each query made with this API key. If empty, the field is not returned and no query parameters are applied.
`referers`	list Lists referrer restrictions for this API key. Leading or trailing asterisks (``) indicate wildcards. For example: `https://algolia.com/` allows all referrers starting with `https://algolia.com/` `.algolia.com` allows all referrers ending with `.algolia.com` `algolia.com*` allows the whole domain `algolia.com` If empty, this field isn’t returned and all referrers are allowed.

Did you find this page helpful?