A newer version is available. For the latest information, see the
current release documentation.
Get cluster metadata settingsedit
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.
Requestedit
GET /api/v1/clusters/kibana/{cluster_id}/metadata/settings
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Kibana deployment identifier. |
Responsesedit
-
200
-
(
ClusterMetadataSettings
) The cluster metadata was successfully returnedHeaders
-
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 exampleedit
curl -XGET {{hostname}}/api/v1/clusters/kibana/{cluster_id}/metadata/settings \ -H "Authorization: ApiKey $ECE_API_KEY"