Create an API key of the cross_cluster type for the API key based remote cluster access.
A cross_cluster API key cannot be used to authenticate through the REST interface.
Important
To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.
Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.
Note
Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property.
A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.
By default, API keys never expire. You can specify expiration information when you create the API keys.
Cross-cluster API keys can only be updated with the update cross-cluster API key API.
Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.
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.
Note
No explicit privileges should be specified for either search or replication access.
The creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly.
replicationobject[]
A list of indices permission entries for cross-cluster replication.
namesunionstring | string[]required
A list of indices (or index name patterns) to which the permissions in this entry apply.
allow_restricted_indicesboolean · default: false
This needs to be set to true if the patterns in the names field should cover system indices.
searchobject[]
A list of indices permission entries for cross-cluster search.
field_securityobject
The document fields that the owners of the role have read access to.
A list of indices (or index name patterns) to which the permissions in this entry apply.
queryuniononeOf
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.
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
templateobject
When you create a role, you can specify a query that defines the document level security permissions. You can optionally
use Mustache templates in the role query to insert the username of the current authenticated user into the role.
Like other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based
templates and define custom parameters. You access the details for the current authenticated user through the _user parameter.
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
idstring
The id for a stored script.
paramsmapstring to object
Specifies any named parameters that are passed into the script as variables.
Use parameters instead of hard-coded values to decrease compile time.
langunionanyOf · default: painless
Specifies the language the script is written in.
Supported values include:
painless: Painless scripting language, purpose-built for Elasticsearch.
expression: Lucene’s expressions language, compiles a JavaScript expression to bytecode.
mustache: Mustache templated, used for templates.
java: Expert Java API
Values:painlessexpressionmustachejava
optionsmapstring to string
allow_restricted_indicesboolean · default: false
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.
expirationstring
Expiration time for the API key.
By default, API keys never expire.
metadataobject
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.
namestringrequired
Specifies the name for this API key.
certificate_identitystring
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.