Clone an API key

POST also PUT /_security/api_key/clone

Create a copy of an existing API key with a new ID. The cloned key inherits the role descriptors of the source key. This is intended for applications (such as Kibana) that need to create API keys on behalf of a user using an existing API key credential, since derived API keys (API keys created by API keys) are not otherwise supported.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Query parameters

Request body

Response

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT /_security/api_key/clone
{
  "api_key": "string"
}

Generated from the API spec

curl Shell

curl -X PUT "${ELASTICSEARCH_URL}/_security/api_key/clone" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "string"
  }'

Generated from the API spec

Response

No example

Required authorization

Authentication

Query parameters

Request body { }

Response

Request body