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

› › › ›

Get cluster metadata settings

edit

Get cluster metadata settings

edit

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

Retrieves a structured version of the cluster metadata as a collection of top-level settings. If a particular setting isn't returned, then the free-form JSON endpoint (/metadata/raw) must be used.

Request

edit

GET /api/v1/clusters/kibana/{cluster_id}/metadata/settings

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.

Responses

edit

200

(ClusterMetadataSettings)

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/kibana/{cluster_id}/metadata/settings \
-H "Authorization: ApiKey $ECE_API_KEY"

« Set cluster metadata Update cluster metadata settings »