Restore an API key

Restores a deleted API key.

POST /1/keys/{key}/restore

curl

cURL

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

200

{
  "key": "13ad45b4d0a2f6ea65ecbddf6aa260f2",
  "createdAt": "2023-07-04T12:49:15Z"
}

Restoring resets the validity attribute to 0.

Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can’t be restored.

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.

Path Parameters

key · string · required

API key.

Example:

"ALGOLIA_API_KEY"

Response

200

application/json

OK

key · string · required

API key.

Example:

"13ad45b4d0a2f6ea65ecbddf6aa260f2"

createdAt · string · required

Date and time when the object was created, in RFC 3339 format.

Example:

"2023-07-04T12:49:15Z"