IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Has privileges API Invalidate token API »
Elastic Docs ›Elasticsearch Guide [7.3] ›REST APIs ›Security APIs

Invalidate API key API

edit

Invalidate API key API

edit

Invalidates one or more API keys.

Request

edit

DELETE /_security/api_key

Prerequisites

edit
  • To use this API, you must have at least the manage_api_key cluster privilege.

Description

edit

The API keys created by create API Key can be invalidated using this API.

Request body

edit

The following parameters can be specified in the body of a DELETE request and pertain to invalidating api keys:

id
(Optional, string) An API key id. This parameter cannot be used with any of name, realm_name or username are used.
name
(Optional, string) An API key name. This parameter cannot be used with any of id, realm_name or username are used.
realm_name
(Optional, string) The name of an authentication realm. This parameter cannot be used with either id or name.
username
(Optional, string) The username of a user. This parameter cannot be used with either id or name.

While all parameters are optional, at least one of them is required.

Response body

edit

A successful call returns a JSON structure that contains the ids of the API keys that were invalidated, the ids of the API keys that had already been invalidated, and potentially a list of errors encountered while invalidating specific api keys.

Examples

edit

If you create an API key as follows:

POST /_security/api_key
{
  "name": "my-api-key"
}

A successful call returns a JSON structure that provides API key information. For example:

{
  "id":"VuaCfGcBCdbkQm-e5aOx",
  "name":"my-api-key",
  "api_key":"ui2lp2axTNmsyakw9tvNnw"
}

The following example invalidates the API key identified by specified id immediately:

DELETE /_security/api_key
{
  "id" : "VuaCfGcBCdbkQm-e5aOx"
}

The following example invalidates the API key identified by specified name immediately:

DELETE /_security/api_key
{
  "name" : "my-api-key"
}

The following example invalidates all API keys for the native1 realm immediately:

DELETE /_security/api_key
{
  "realm_name" : "native1"
}

The following example invalidates all API keys for the user myuser in all realms immediately:

DELETE /_security/api_key
{
  "username" : "myuser"
}

Finally, the following example invalidates all API keys for the user myuser in the native1 realm immediately:

DELETE /_security/api_key
{
  "username" : "myuser",
  "realm_name" : "native1"
}
{
  "invalidated_api_keys": [ 
    "api-key-id-1"
  ],
  "previously_invalidated_api_keys": [ 
    "api-key-id-2",
    "api-key-id-3"
  ],
  "error_count": 2, 
  "error_details": [ 
    {
      "type": "exception",
      "reason": "error occurred while invalidating api keys",
      "caused_by": {
        "type": "illegal_argument_exception",
        "reason": "invalid api key id"
      }
    },
    {
      "type": "exception",
      "reason": "error occurred while invalidating api keys",
      "caused_by": {
        "type": "illegal_argument_exception",
        "reason": "invalid api key id"
      }
    }
  ]
}

The IDs of the API keys that were invalidated as part of this request.

The IDs of the API keys that were already invalidated.

The number of errors that were encountered when invalidating the API keys.

Details about these errors. This field is not present in the response when error_count is 0.
« Has privileges API Invalidate token API »