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.

« Set cluster name Set cluster metadata »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.3] ›RESTful API ›API reference ›Clusters - Elasticsearch - CRUD - Configuration

Get cluster metadata

edit

Get cluster metadata

edit

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')

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

Request example

edit
curl -XGET {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/metadata/raw \
-u $CLOUD_USER:$CLOUD_KEY
« Set cluster name Set cluster metadata »