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

Delete API Key

Required API Key: Admin
Method signature
$client->deleteApiKey(apiKey)

About this method

Delete an existing API Key.

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 privileges before deleting it, to avoid any unexpected consequences.

Examples

To delete an existing key:

1
2
// Deletes a key
$res = $client->deleteApiKey('myAPIKey');

Parameters

apiKey
type: string
default: no default
Required

API Key to delete

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
{
  "deletedAt": "2017-12-16T22:21:31.871Z"
}
deletedAt
string

The date at which the key was deleted.

Did you find this page helpful?