Get cluster metadata settings

DEPRECATED (Scheduled to be removed in the next major version): 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

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

Path parameters

Name Type Required Description

cluster_id

string

Y

The APM deployment identifier.

Responses

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

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

Request example

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