Immediately create a new cluster snapshot

Creates a new snapshot of the specified Elasticsearch cluster, using the configured snapshot repository.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/_snapshot

Path parameters

cluster_id (required)
(string) The Elasticsearch cluster identifier.

Request body

(ClusterSnapshotRequest) Overrides default settings for the snapshot

Responses

202
(ClusterSnapshotResponse) The create snapshot command was issued successfully
400
(BasicFailedReply) The cluster does not have a snapshot repository configured (code: 'clusters.snapshot.repository_not_configured')
404
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
409
(BasicFailedReply) The cluster name specified is already in use (code: 'clusters.snapshot.invalid_name')
449
(BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')
500
(BasicFailedReply) The snapshot request failed (code: 'clusters.snapshot.failed', clusters.endpoint_not_found)