IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Set legacy security settings Update cluster snapshot settings »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.13] ›RESTful API ›API reference ›Clusters - Elasticsearch - CRUD - Configuration

Get cluster snapshot settings

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get cluster snapshot settings

edit

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

Gets cluster snapshot settings.

Request

edit

GET /api/v1/clusters/elasticsearch/{cluster_id}/snapshot/settings

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

Identifier for the Elasticsearch cluster

Responses

edit
200

(ClusterSnapshotSettings)

The cluster snapshot settings were 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/elasticsearch/{cluster_id}/snapshot/settings \
-H "Authorization: ApiKey $ECE_API_KEY"
« Set legacy security settings Update cluster snapshot settings »