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 cluster metadata settings Cancel monitoring »

› › › ›

Update cluster metadata settings

edit

Update cluster metadata settings

edit

All changes in the specified object are applied to the metadata object. Omitting existing fields causes the same values to be reapplied. Specifying a null value reverts the field to the default value, or removes the field when no default value exists.

Request

edit

PATCH /api/v1/clusters/elasticsearch/{cluster_id}/metadata/settings

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	Elasticsearch cluster identifier

Query parameters

edit

Name	Type	Required	Description
`version`	`integer`	N	Checks for conflicts against the metadata version, then returns the value in the `x-cloud-resource-version` header.

Request body

edit

(ClusterMetadataSettings) (required) The cluster settings including updated values

Responses

edit

200

(ClusterMetadataSettings) The Elasticsearch cluster metadata successfully updated.

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

403

(BasicFailedReply) You are unable to update the Elasticsearch cluster.

404

(BasicFailedReply) The {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}/metadata/settings \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "contact_email" : "string",
   "hidden" : true,
   "name" : "string",
   "owner_id" : "string",
   "resources" : {
      "cpu" : {
         "boost" : true,
         "hard_limit" : true
      }
   },
   "subscription_level" : "string",
   "system_owned" : true
}
'

« Get cluster metadata settings Cancel monitoring »