Skip to main content
This page documents an earlier version of the API client. For the latest version, see Delete an API key.
Required ACL: Admin Be careful not to accidentally revoke a user’s access to the Dashboard by deleting any key that grants such access. More generally: always be aware of a key’s permissions before deleting it, to avoid any unexpected consequences.

Examples

To delete an existing key:
client.DeleteApiKey("YourAPIKey");

// Asynchronous
await client.DeleteApiKeyAsync("YourAPIKey");

Parameters

apiKey
string
required
API key to delete

Response

deletedAt
string
The date at which the key was deleted.

Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.
JSON
{
  "deletedAt": "2017-12-16T22:21:31.871Z"
}
I