APIAPI v2.x

deleteApiKey #

Deletes a user API key.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/users/<userId>/api-keys/<apiKeyId>[?refresh=wait_for]
Method: DELETE
Available since 2.57.0

The API key can also be targeted by its clear-text key or its fingerprint instead of its _id, using query string parameters:

URL: http://kuzzle:7512/users/<userId>/api-keys[?key=<key>&refresh=wait_for]
Method: DELETE
URL: http://kuzzle:7512/users/<userId>/api-keys[?fingerprint=<fingerprint>&refresh=wait_for]
Method: DELETE

A key passed in the query string is a secret written in the URL, so it can end up in proxy and access logs. Prefer the fingerprint, or another protocol.

Other protocols #

{
  "controller": "security",
  "action": "deleteApiKey",
  "userId": "mWakSm4BWtbu6xy6NY8K",
  "_id": "api-key-id"
}

Arguments #

One of the following must be provided to identify the API key to delete. If several are given, _id is used first, then key, then fingerprint, and the others are ignored:

  • _id: API key ID
  • key: the clear-text API key
    Available since 2.57.0
  • fingerprint: the API key fingerprint (SHA-256 hash of the clear-text key)
    Available since 2.57.0

Optional: #

  • refresh: if set to wait_for, Kuzzle will not respond until the API key deletion is indexed (default: "wait_for")

Response #

Returns the deleted API key ID.

{
  "status": 200,
  "error": null,
  "result": {
    "_id": "api-key-id"
  },
  "action": "deleteApiKey",
  "controller": "security",
  "requestId": "<unique request identifier>"
}

Possible errors #