API Reference / API Methods / API keys / Delete API Key
Required API Key: Admin
Method signature
$client->deleteApiKey(string apiKey)

About this method # A

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

To delete an existing key:

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

Parameters # A

apiKey #
type: string
default: no default
Required

API Key to delete

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

The date at which the key was deleted.

Did you find this page helpful?
PHP v3