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 settings
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
Get cluster metadata settings
editThis 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
editGET /api/v1/clusters/kibana/{cluster_id}/metadata/settings
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Kibana deployment identifier. |
Responses
edit-
200 -
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 -
The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
Request example
editcurl -XGET https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/metadata/settings \
-H "Authorization: ApiKey $ECE_API_KEY"