Update an API key

PUT /_security/api_key/{id}

Update attributes of an existing API key. This API supports updates to an API key's access scope, expiration, and metadata.

To use this API, you must have at least the manage_own_api_key cluster privilege. Users can only update API keys that they created or that were granted to them. To update another user’s API key, use the run_as feature to submit a request on behalf of another user.

IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.

Use this API to update API keys created by the create API key or grant API Key APIs. If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead. It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.

The access scope of an API key is derived from the role_descriptors you specify in the request and a snapshot of the owner user's permissions at the time of the request. The snapshot of the owner's permissions is updated automatically on every call.

IMPORTANT: If you don't specify role_descriptors in the request, a call to this API might still change the API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.

Required authorization

Cluster privileges: manage_own_api_key

Path Parameters

id string Id required: The ID of the API key to update.

Request

Response

application/json

Examples

Run PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx to assign new role descriptors and metadata to an API key.

Request Console 1 / 8 languages

Console Kibana Dev Tools

PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx
{
  "role_descriptors": {
    "role-a": {
      "indices": [
        {
          "names": ["*"],
          "privileges": ["write"]
        }
      ]
    }
  },
  "metadata": {
    "environment": {
      "level": 2,
      "trusted": true,
      "tags": ["production"]
    }
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.security.updateApiKey({
  id: "VuaCfGcBCdbkQm-e5aOx",
  role_descriptors: {
    "role-a": {
      indices: [
        {
          names: ["*"],
          privileges: ["write"],
        },
      ],
    },
  },
  metadata: {
    environment: {
      level: 2,
      trusted: true,
      tags: ["production"],
    },
  },
});

Python Elasticsearch Python Client

resp = client.security.update_api_key(
    id="VuaCfGcBCdbkQm-e5aOx",
    role_descriptors={
        "role-a": {
            "indices": [
                {
                    "names": [
                        "*"
                    ],
                    "privileges": [
                        "write"
                    ]
                }
            ]
        }
    },
    metadata={
        "environment": {
            "level": 2,
            "trusted": True,
            "tags": [
                "production"
            ]
        }
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_security/api_key/VuaCfGcBCdbkQm-e5aOx" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "role_descriptors": {
      "role-a": {
        "indices": [
          {
            "names": [
              "*"
            ],
            "privileges": [
              "write"
            ]
          }
        ]
      }
    },
    "metadata": {
      "environment": {
        "level": 2,
        "trusted": true,
        "tags": [
          "production"
        ]
      }
    }
  }'

Java Elasticsearch Java Client

client.security().updateApiKey(u -> u
    .id("VuaCfGcBCdbkQm-e5aOx")
    .metadata("environment", JsonData.fromJson("{\"level\":2,\"trusted\":true,\"tags\":[\"production\"]}"))
    .roleDescriptors("role-a", r -> r
        .indices(i -> i
            .names("*")
            .privileges("write")
        )
    )
);

C# Elasticsearch .NET Client

var response = await client.Security
    .UpdateApiKeyAsync(id: "VuaCfGcBCdbkQm-e5aOx", d1 => d1
        .Metadata(new Dictionary<string, object>()
        {
            { "environment", JsonSerializer.Deserialize<JsonElement>("""
            {
              "level": 2,
              "trusted": true,
              "tags": [
                "production"
              ]
            }
            """) }
        })
        .RoleDescriptors(d2 => d2
            .Add("role-a", d3 => d3
                .Indices(d4 => d4
                    .Names(["*"])
                    .Privileges(IndexPrivilege.Write)
                )
            )
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->security()->updateApiKey([
    "id" => "VuaCfGcBCdbkQm-e5aOx",
    "body" => [
        "role_descriptors" => [
            "role-a" => [
                "indices" => array(
                    [
                        "names" => array(
                            "*",
                        ),
                        "privileges" => array(
                            "write",
                        ),
                    ],
                ),
            ],
        ],
        "metadata" => [
            "environment" => [
                "level" => 2,
                "trusted" => true,
                "tags" => array(
                    "production",
                ),
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.security.update_api_key(
  id: "VuaCfGcBCdbkQm-e5aOx",
  body: {
    "role_descriptors": {
      "role-a": {
        "indices": [
          {
            "names": [
              "*"
            ],
            "privileges": [
              "write"
            ]
          }
        ]
      }
    },
    "metadata": {
      "environment": {
        "level": 2,
        "trusted": true,
        "tags": [
          "production"
        ]
      }
    }
  }
)

Response

{
  "updated": true
}

Run PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx to remove the API key's previously assigned permissions. It will inherit the owner user's full permissions.

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx
{
  "role_descriptors": {}
}

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_security/api_key/VuaCfGcBCdbkQm-e5aOx" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "role_descriptors": {}
}'

Required authorization

Path Parameters

Request { role_descriptors , metadata , expiration , }

Response

Request