Restore API key

Required API Key: Admin

Method signature

$client->restoreApiKey(string apiKey);

client.restore_api_key(String apiKey)

client.restoreApiKey(string apiKey)

client.restore_api_key(str apiKey)

client.restoreAPIKey(
  _ apiKey: APIKey,
  requestOptions: RequestOptions? = nil,
  completion: Result<APIKeyCreation> -> Void
)

suspend fun ClientSearch.restoreAPIKey(
    apiKey: APIKey,
    requestOptions: RequestOptions? = null
): CreationAPIKey

client.RestoreApiKey(apiKey)

client.restoreApiKey(apiKey)

client.RestoreAPIKey(apiKey)

restore key apiKey

See code examples

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.

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

Read the Algolia CLI documentation for more information.

Restore an API key

Copy

1
$client->restoreApiKey("myAPIKey");

Parameters

Parameter	Description
`apiKey`	type: string default: no default Required API Key to restore

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

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

        

Field	Description
`key`	string The restored key.
`createdAt`	string The date at which the key has been restored.

Did you find this page helpful?