Update a cross-cluster API key

PUT /_security/cross_cluster/api_key/{id}

Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.

To use this API, you must have at least the manage_security cluster privilege. Users can only update API keys that they created. 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. To update an API key, the owner user's credentials are required.

It's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.

This API supports updates to an API key's access scope, metadata, and expiration. The owner user's information, such as the username and realm, is also updated automatically on every call.

NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.

To learn more about how to use this API, refer to the Update cross cluter API key API examples page.

Required authorization

Cluster privileges: manage_security

About adding remote clusters

Path Parameters

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

Request

access {} Access required: The access to be granted to this API key. The access is composed of permissions for cross cluster search and cross cluster replication. At least one of them must be specified. When specified, the new access assignment fully replaces the previously assigned access.
expiration string Duration: The expiration time for the API key. By default, API keys never expire. This property can be omitted to leave the value unchanged.
metadata Metadata: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with _ are reserved for system usage. When specified, this information fully replaces metadata previously associated with the API key.
certificate_identity string: The certificate identity to associate with this API key. This field is used to restrict the API key to connections authenticated by a specific TLS certificate. The value should match the certificate's distinguished name (DN) pattern. When specified, this fully replaces any previously assigned certificate identity. To clear an existing certificate identity, explicitly set this field to null. When omitted, the existing certificate identity remains unchanged.

Response

application/json

Examples

Run PUT /_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx to update a cross-cluster API key, assigning it new access scope and metadata.

Request Console 1 / 8 languages

Console Kibana Dev Tools

PUT /_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx
{
  "access": {
    "replication": [
      {
        "names": ["archive"]
      }
    ]
  },
  "metadata": {
    "application": "replication"
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.security.updateCrossClusterApiKey({
  id: "VuaCfGcBCdbkQm-e5aOx",
  access: {
    replication: [
      {
        names: ["archive"],
      },
    ],
  },
  metadata: {
    application: "replication",
  },
});

Python Elasticsearch Python Client

resp = client.security.update_cross_cluster_api_key(
    id="VuaCfGcBCdbkQm-e5aOx",
    access={
        "replication": [
            {
                "names": [
                    "archive"
                ]
            }
        ]
    },
    metadata={
        "application": "replication"
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "access": {
      "replication": [
        {
          "names": [
            "archive"
          ]
        }
      ]
    },
    "metadata": {
      "application": "replication"
    }
  }'

Java Elasticsearch Java Client

client.security().updateCrossClusterApiKey(u -> u
    .access(a -> a
        .replication(r -> r
            .names("archive")
        )
    )
    .id("VuaCfGcBCdbkQm-e5aOx")
    .metadata("application", JsonData.fromJson("\"replication\""))
);

C# Elasticsearch .NET Client

var response = await client.Security
    .UpdateCrossClusterApiKeyAsync(id: "VuaCfGcBCdbkQm-e5aOx", d1 => d1
        .Access(d2 => d2
            .Replication(d3 => d3
                .Names(["archive"])
            )
        )
        .Metadata(new Dictionary<string, object>()
        {
            { "application", "replication" }
        })
    );

PHP Elasticsearch PHP Client

$resp = $client->security()->updateCrossClusterApiKey([
    "id" => "VuaCfGcBCdbkQm-e5aOx",
    "body" => [
        "access" => [
            "replication" => array(
                [
                    "names" => array(
                        "archive",
                    ),
                ],
            ),
        ],
        "metadata" => [
            "application" => "replication",
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.security.update_cross_cluster_api_key(
  id: "VuaCfGcBCdbkQm-e5aOx",
  body: {
    "access": {
      "replication": [
        {
          "names": [
            "archive"
          ]
        }
      ]
    },
    "metadata": {
      "application": "replication"
    }
  }
)

Response

{
  "updated": true
}

Required authorization

Path Parameters

Request { access , expiration , metadata , certificate_identity , }

Response

Request