API Reference / API Methods / API keys / Restore API Key
Required API Key: Admin
Method signature
$client->restoreApiKey(string apiKey);

About this method # A

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 # A

Restore an API key#

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

Parameters # A

apiKey #
type: string
default: no default
Required

API Key to restore

Response # A

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
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?
PHP v3