API Reference / API Methods / API keys / Restore API Key
Feb. 26, 2019

Restore API Key

Required API Key: Admin
Method signature
searchClient.restoreApiKey(apiKey);

About this method

Restore a deleted API key, along with its associated rights.

The request must be authenticated by the admin API key.

The validity limit is automatically reset to 0 (unlimited).

We store up to 1,000 deleted API keys. Above that point, the oldest deleted API keys are permanently deleted and can’t be restored.

Examples

Restore an API key

1
$searchClient->restoreApiKey("107da8d0afc2d225ff9a7548caaf599f");

Parameters

apiKey
type: string
default: no default
Required

API Key to restore

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

1
2
3
4
{
  "key": "1eb37de6308abdccf9b760ddacb418b4",
  "createdAt": "2017-12-16T22:21:31.871Z"
}
key
string

The restored key.

createdAt
string

The date at which the key has been restored.

Did you find this page helpful?