--- type: api title: Update an API key description: Update attributes of an existing API key. url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/operation/operation-security-update-api-key resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/operation/operation-security-update-api-key products: - Elasticsearch --- # Update an API key Availability: 8.4+ ## Paths - `PUT` `/_security/api_key/{id}` - [Api key auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/authentication#apikeyauth) - [Basic auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/authentication#basicauth) - [Bearer auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/authentication#bearerauth) #### Path Parameters - `id` (string Id) The ID of the API key to update. ## Description 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` ## Request Body `application/json` - `role_descriptors` (map string to RoleDescriptor) — optional The role descriptors to assign to this API key. The API key's effective permissions are an intersection of its assigned privileges and the point in time snapshot of permissions of the owner user. You can assign new privileges by specifying them in this parameter. To remove assigned privileges, you can supply an empty `role_descriptors` parameter, that is to say, an empty object `{}`. If an API key has no assigned privileges, it inherits the owner user's full permissions. The snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter or not. The structure of a role descriptor is the same as the request for the create API keys API. Map values ({} RoleDescriptor) - `cluster` ([] union ClusterPrivilege) — optional A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute. Values: `all`, `cancel_task`, `clone_api_key`, `create_snapshot`, `cross_cluster_replication`, `cross_cluster_search`, `delegate_pki`, `grant_api_key`, `manage`, `manage_api_key`, `manage_autoscaling`, `manage_behavioral_analytics`, `manage_ccr`, `manage_data_frame_transforms`, `manage_data_stream_global_retention`, `manage_enrich`, `manage_esql`, `manage_ilm`, `manage_index_templates`, `manage_inference`, `manage_ingest_pipelines`, `manage_logstash_pipelines`, `manage_ml`, `manage_oidc`, `manage_own_api_key`, `manage_pipeline`, `manage_reindex`, `manage_rollup`, `manage_saml`, `manage_search_application`, `manage_search_query_rules`, `manage_search_synonyms`, `manage_security`, `manage_service_account`, `manage_slm`, `manage_token`, `manage_transform`, `manage_user_profile`, `manage_watcher`, `monitor`, `monitor_data_frame_transforms`, `monitor_data_stream_global_retention`, `monitor_enrich`, `monitor_esql`, `monitor_inference`, `monitor_ml`, `monitor_reindex`, `monitor_rollup`, `monitor_snapshot`, `monitor_stats`, `monitor_text_structure`, `monitor_transform`, `monitor_watcher`, `none`, `post_behavioral_analytics_event`, `read_ccr`, `read_fleet_secrets`, `read_ilm`, `read_pipeline`, `read_security`, `read_slm`, `transport_client`, `write_connector_secrets`, `write_fleet_secrets` - `indices` ([] IndicesPrivileges) — optional A list of indices permissions entries. - `field_security` ({} FieldSecurity) — optional The document fields that the owners of the role have read access to. - `except` (string Fields) — optional - `grant` (string Fields) — optional - `names` (union IndexName | [] IndexName) — required A list of indices (or index name patterns) to which the permissions in this entry apply. - `privileges` ([] union IndexPrivilege) — required The index level privileges that owners of the role have on the specified indices. Values: `all`, `auto_configure`, `create`, `create_doc`, `create_index`, `create_view`, `cross_cluster_replication`, `cross_cluster_replication_internal`, `delete`, `delete_index`, `delete_view`, `index`, `maintenance`, `manage`, `manage_data_stream_lifecycle`, `manage_follow_index`, `manage_ilm`, `manage_leader_index`, `manage_view`, `monitor`, `none`, `read`, `read_cross_cluster`, `read_view_metadata`, `view_index_metadata`, `write` - `query` (IndicesPrivilegesQuery) — optional A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. - `allow_restricted_indices` (boolean · default: false) — optional Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`. - `remote_indices` ([] RemoteIndicesPrivileges) — optional A list of indices permissions for remote clusters. - `clusters` (string Names) — required A list of cluster aliases to which the permissions in this entry apply. - `field_security` ({} FieldSecurity) — optional The document fields that the owners of the role have read access to. - `except` (string Fields) — optional - `grant` (string Fields) — optional - `names` (union IndexName | [] IndexName) — required A list of indices (or index name patterns) to which the permissions in this entry apply. - `privileges` ([] union IndexPrivilege) — required The index level privileges that owners of the role have on the specified indices. Values: `all`, `auto_configure`, `create`, `create_doc`, `create_index`, `create_view`, `cross_cluster_replication`, `cross_cluster_replication_internal`, `delete`, `delete_index`, `delete_view`, `index`, `maintenance`, `manage`, `manage_data_stream_lifecycle`, `manage_follow_index`, `manage_ilm`, `manage_leader_index`, `manage_view`, `monitor`, `none`, `read`, `read_cross_cluster`, `read_view_metadata`, `view_index_metadata`, `write` - `query` (IndicesPrivilegesQuery) — optional A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. - `allow_restricted_indices` (boolean · default: false) — optional Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`. - `remote_cluster` ([] RemoteClusterPrivileges) — optional A list of cluster permissions for remote clusters. NOTE: This is limited a subset of the cluster permissions. - `clusters` (string Names) — required A list of cluster aliases to which the permissions in this entry apply. - `privileges` ([] enum RemoteClusterPrivilege) — required The cluster level privileges that owners of the role have on the remote cluster. Values: `monitor_enrich`, `monitor_stats` - `global` ({} GlobalPrivilege) — optional An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. - `application` ({} ApplicationGlobalUserPrivileges) — optional - `manage` ({} ManageUserPrivileges) — required - `applications` ([] string) — required - `profile` ({} WriteProfileGlobalUserPrivileges) — optional A privilege that grants the ability to write the `data` and `access` sections of user profiles for the specified applications. - `write` ({} ManageUserPrivileges) — optional The applications for which user profile data can be written. Absent when the `profile` section is present but grants no privileges. - `applications` ([] string) — required - `role` ({} ManageRolesGlobalUserPrivileges) — optional A privilege that grants the ability to manage roles that are scoped to the specified indices. - `manage` ({} ManageRolesPrivileges) — optional The index-scoped role management privileges. Absent when the `role` section is present but grants no privileges. - `indices` ([] ManageRolesIndexPermissions) — required - `names` ([] string) — required A list of indices (or index name patterns) that the owners of the role can manage roles for. - `privileges` ([] string) — required The index privileges that the managed roles are allowed to grant on the specified indices. - `data_source` ([] DataSourcePrivileges) — optional A list of data source privilege entries, used to grant access to ES|QL data sources. - `names` ([] string) — required A list of data source names or wildcard patterns to which the permissions in this entry apply. - `privileges` ([] union DataSourcePrivilege) — required The data source privileges that owners of the role have for the specified data sources. Supported values include: - `create`: Grants privilege to create a data source with a matching name. - `delete`: Grants privilege to delete a data source with a matching name. - `read_metadata`: Grants privilege to read a data source's metadata. - `read`: Grants privilege to attach a dataset to a data source with a matching name. - `manage`: Grants all data source privileges, including `create`, `delete`, `read`, and `read_metadata`. Values: `create`, `delete`, `read_metadata`, `read`, `manage` - `applications` ([] ApplicationPrivileges) — optional A list of application privilege entries - `application` (string) — required The name of the application to which this entry applies. - `privileges` ([] string) — required A list of strings, where each element is the name of an application privilege or action. - `resources` ([] string) — required A list resources to which the privileges are applied. - `metadata` (Metadata) — optional Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage. - `run_as` ([] string) — optional A list of users that the API keys can impersonate. NOTE: In Elastic Cloud Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected. - `description` (string) — optional Optional description of the role descriptor - `restriction` ({} Restriction) — optional Restriction for when the role descriptor is allowed to be effective. - `workflows` ([] union RestrictionWorkflow) — required A list of workflows to which the API key is restricted. NOTE: In order to use a role restriction, an API key must be created with a single role descriptor. Values: `search_application_query` - `transient_metadata` (map string to object) — optional - `metadata` (Metadata) — optional Arbitrary metadata that you want to associate with the API key. It supports a nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage. When specified, this value fully replaces the metadata previously associated with the API key. - `expiration` (string Duration) — optional The expiration time for the API key. By default, API keys never expire. This property can be omitted to leave the expiration unchanged. ## Response `application/json` - `updated` (boolean) If `true`, the API key was updated. If `false`, the API key didn't change because no change was detected. ## Code Examples #### Console ```console PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx { "role_descriptors": { "role-a": { "indices": [ { "names": ["*"], "privileges": ["write"] } ] } }, "metadata": { "environment": { "level": 2, "trusted": true, "tags": ["production"] } } } ``` #### JavaScript ```javascript 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 ```python 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 ```curl 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 ```java 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# ```c# var response = await client.Security .UpdateApiKeyAsync(id: "VuaCfGcBCdbkQm-e5aOx", d1 => d1 .Metadata(new Dictionary() { { "environment", JsonSerializer.Deserialize(""" { "level": 2, "trusted": true, "tags": [ "production" ] } """) } }) .RoleDescriptors(d2 => d2 .Add("role-a", d3 => d3 .Indices(d4 => d4 .Names(["*"]) .Privileges(IndexPrivilege.Write) ) ) ) ); ``` #### PHP ```php $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 ```ruby 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 Examples #### Update role and metadata A successful response from `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx`. The API key's effective permissions after the update will be the intersection of the supplied role descriptors and the owner user's permissions. ```json { "updated": true } ```