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

« Set cluster name Set cluster metadata »

› › › ›

Get cluster metadata

edit

Get cluster metadata

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use get deployment instead.

Advanced use only. Retrieves the internal cluster metadata, in free-form JSON, for the Elasticsearch cluster.

Request

edit

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

Path parameters

edit

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

Responses

edit

200

(object)

The cluster metadata was successfully 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')

Request example

edit

curl -XGET https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/metadata/raw \
-H "Authorization: ApiKey $ECE_API_KEY"

« Set cluster name Set cluster metadata »