Set cluster metadata

Advanced use only: Sets the internal cluster metadata (free-form JSON) for an Elasticsearch cluster. Must only be used to set a modified version of the JSON returned from the get version of the metadata.


POST /api/v1/clusters/elasticsearch/{cluster_id}/metadata/raw

Path Parameters

cluster_id (required)
(string) Identifier for the Elasticsearch cluster

Query Parameters

(integer) If specified then checks for conflicts against the version of the cluster metadata (returned in 'x-cloud-resource-version' of the GET request)

Request body

(string) (required) The freeform JSON for the cluster (should always be based on the current version retrieved from the GET)



(object) The cluster metadata was successfully changed (the updated JSON is returned)


x-cloud-resource-created (string, required)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string, required)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string, required)
The version of the resource - used to avoid update conflicts from multiple concurrent operations
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
(BasicFailedReply) When running as an administrator (other than root), sudo is required (code: 'root.needs_sudo')