This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.

Required API Key: Admin

Method signature
$client->deleteApiKey(string apiKey)

About this method #

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

Examples #

To delete an existing key:

1
$res = $client->deleteApiKey('YourAPIKey');

Parameters #

apiKey #
type: string
default: no default
Required

API Key to delete

Response #

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format#

1
2
3
{
  "deletedAt": "2017-12-16T22:21:31.871Z"
}
Field Description
deletedAt #
string

The date at which the key was deleted.

Did you find this page helpful?
PHP API clients v3