Add or remove settings from the cluster keystore

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use set Elasticsearch keystore contents instead.

Adds the specified values to the Elasticsearch keystore, or removes the keys for the unspecified values.

Request

edit

PATCH /api/v1/clusters/elasticsearch/{cluster_id}/keystore

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

Identifier for the Elasticsearch cluster

Request body

edit

(KeystoreContents) (required) Keystore settings to update

Responses

edit
202

(KeystoreContents)

The keystore will be updated

404

(BasicFailedReply)

The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')

449

(BasicFailedReply)

Elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')

Request example

edit
curl -XPATCH https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/keystore \
-H "Authorization: ApiKey $ECE_API_KEY" \
-d '
{
   "secrets" : {
      "some_property" : {
         "as_file" : true,
         "value" : {}
      }
   }
}
'