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.

External documentation

Path parameters

id string Required

The ID of the cross-cluster API key to update.

application/json

Body Required

access object Required

Additional properties are allowed.
Hide access attributes Show access attributes object
- replication array[object]
  
  A list of indices permission entries for cross-cluster replication.
  Hide replication attributes Show replication attributes object
  
  names string | array[string]
  
  A list of indices (or index name patterns) to which the permissions in this entry apply.
  
  One of:
  _types:IndexName string array-2 array[string]
  
  allow_restricted_indices boolean
  
  This needs to be set to true if the patterns in the names field should cover system indices.
- search array[object]
  
  A list of indices permission entries for cross-cluster search.
  Hide search attributes Show search attributes object
  
  field_security object
  
  Additional properties are allowed.
  
  Hide field_security attributes Show field_security attributes object
  
  except string | array[string]
  
  grant string | array[string]
  
  names string | array[string]
  
  A list of indices (or index name patterns) to which the permissions in this entry apply.
  
  One of:
  _types:IndexName string array-2 array[string]
  
  query string | object
  
  While creating or updating a role you can provide either a JSON structure or a string to the API. However, the response provided by Elasticsearch will only be string with a json-as-text content.
  
  Since this is embedded in IndicesPrivileges, the same structure is used for clarity in both contexts.
  
  One of:
  _types:IndicesPrivilegesQuery string query_dsl:QueryContainer object _types:RoleTemplateQuery object
  
  Additional properties are allowed.
  
  External documentation
  
  allow_restricted_indices boolean
  
  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.
expiration string

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
metadata object
Hide metadata attribute Show metadata attribute object
- * object Additional properties
  
  Additional properties are allowed.

Responses

200 application/json
Hide response attribute Show response attribute object
- updated boolean Required
  
  If true, the API key was updated. If false, the API key didn’t change because no change was detected.

PUT /_security/cross_cluster/api_key/{id}

curl \
 -X PUT http://api.example.com/_security/cross_cluster/api_key/{id} \
 -H "Content-Type: application/json" \
 -d '{"access":{"replication":[{"names":"string","allow_restricted_indices":true}],"search":[{"field_security":{"except":"string","grant":"string"},"names":"string","":"string","allow_restricted_indices":true}]},"expiration":"string","metadata":{"additionalProperty1":{},"additionalProperty2":{}}}'

Request examples

{
  "access": {
    "replication": [
      {
        "names": "string",
        "allow_restricted_indices": true
      }
    ],
    "search": [
      {
        "field_security": {
          "except": "string",
          "grant": "string"
        },
        "names": "string",
        "": "string",
        "allow_restricted_indices": true
      }
    ]
  },
  "expiration": "string",
  "metadata": {
    "additionalProperty1": {},
    "additionalProperty2": {}
  }
}

Response examples (200)

{
  "updated": true
}

Update a cross-cluster API key

Path parameters

Body Required

names string | array[string]

names string | array[string]

query string | object

Responses