Delete API Key | JavaScript API Client V3 (Deprecated)

client.deleteApiKey(apiKey, callback)

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');

1
2
# Deletes a key
client.delete_api_key('myAPIKey')

1
2
3
4
5
6
// Deletes a key
client.deleteApiKey('myAPIKey', (err, content) => {
  if (err) throw err;

  console.log(content);
});

1
2
# Deletes a key
print(client.delete_api_key('myAPIKey'))

1
2
3
4
5
// Deletes a key
client.DeleteApiKey("myAPIKey");

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

1
2
3
4
5
// Deletes a key
client.deleteApiKey("myAPIKey");

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

1
2
// Deletes a key
res, err := client.DeleteAPIKey("myAPIKey")

1
2
3
4
// global key
client.execute {
    delete key "myAPIKey"
}

1
client.deleteAPIKey(APIKey("f420238212c54dcfad07ea0aa6d5c45f"))

Parameters

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