It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Get settings from this cluster’s keystore Set cluster name »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.1] ›RESTful API ›API reference ›Clusters - Elasticsearch - CRUD - Configuration

Add or remove settings

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Add or remove settings

edit

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} can't be found (code: 'clusters.cluster_not_found')

449

(BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XPATCH {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/keystore \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "secrets" : {
      "some_property" : {
         "as_file" : true,
         "value" : {}
      }
   }
}
'
« Get settings from this cluster’s keystore Set cluster name »