IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get cluster metadata Get cluster metadata settings »

› › › ›

Set cluster metadata

edit

Set cluster metadata

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use set resource raw metadata instead.

Advanced use only. Sets the internal metadata, in free-form JSON, for the Elasticsearch cluster. Only use the parameter to set the modified JSON that is returned from the get version of the metadata.

Request

edit

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

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

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

Responses

edit

200

(object)

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

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

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 -XPOST https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/metadata/raw \
-H "Authorization: ApiKey $ECE_API_KEY"

« Get cluster metadata Get cluster metadata settings »