API client / Methods / API keys
Required API Key: Admin
Method signature
$client->deleteApiKey(string apiKey)

About this method

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

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.

Delete an API Key.

Be careful not to accidentally revoke a user’s access to the Dashboard by deleting any key that grants such access. More generally: always be aware of a key’s permissions before deleting it, to avoid any unexpected consequences.

Examples

Read the Algolia CLI documentation for more information.

To delete an existing key:

1
$res = $client->deleteApiKey('YourAPIKey');

Parameters

apiKey
type: string
default: no default
Required

API Key to delete

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format

1
2
3
{
  "deletedAt": "2017-12-16T22:21:31.871Z"
}
deletedAt
string

The date at which the key was deleted.

Did you find this page helpful?