Restore API Key | Ruby API Client V1 (Deprecated)

This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.

client.restore_api_key(apiKey)

About this method# Found an issue? Edit this guide A Edit this guide

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# Found an issue? Edit this guide A Edit this guide

Restore an API key#

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

1
client.restore_api_key('myAPIKey')

1
2
3
client.restoreApiKey('myAPIKey').then(() => {
  // done
});

1
client.restore_api_key('myAPIKey')

1
2
3
4
client.restoreAPIKey("myAPIKey") { result in
  if case .success(let response) = result {
  }
}

1
client.RestoreApiKey("myAPIKey");

1
2
3
4
client.restoreApiKey("myAPIKey");

// Async
client.restoreApiKeyAsync("myAPIKey");

1
res, err := client.RestoreAPIKey("myAPIKey")

1
2
3
client.execute {
  restore key "myAPIKey"
}

1
client.restoreAPIKey(APIKey("myAPIKey"))

Parameters# Found an issue? Edit this guide A Edit this guide

Response# Found an issue? Edit this guide A Edit this guide

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"
}