It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Take snapshot
editTake snapshot
editDEPRECATED (Scheduled to be removed in the next major version): To create a snapshot of the specified Elasticsearch cluster, uses the configured snapshot repository.
Request
editPOST /api/v1/clusters/elasticsearch/{cluster_id}/_snapshot
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Request body
edit(ClusterSnapshotRequest
) Overrides default settings for the snapshot
Responses
edit-
202
-
(
ClusterSnapshotResponse
) The create command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress -
401
-
(
BasicFailedReply
) The supplied credentials for the snapshot repository are invalid. (code:clusters.snapshot.invalid_credentials
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.snapshot.invalid_credentials
]) - The error codes associated with the response
-
-
404
-
(
BasicFailedReply
) * The cluster specified by {cluster_id} cannot be found. (code:clusters.cluster_not_found
) * The snapshot repository was not found. (code:clusters.snapshot.repository_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_not_found
,clusters.snapshot.repository_not_found
]) - The error codes associated with the response
-
-
409
-
(
BasicFailedReply
) The cluster name specified is already in use. (code:clusters.snapshot.name_conflict
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.snapshot.name_conflict
]) - The error codes associated with the response
-
-
449
-
(
BasicFailedReply
) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
-
500
-
(
BasicFailedReply
) * The snapshot request failed. (code:clusters.snapshot.failed
) * The snapshot request failed. (code:clusters.snapshot.repository_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.snapshot.failed
,clusters.snapshot.repository_not_found
]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XPOST https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/_snapshot \ -H "Authorization: ApiKey $ECE_API_KEY" \ -d ' { "name" : "string", "password" : "string", "repository_name" : "string", "username" : "string" } '