Take snapshotedit
To create a snapshot of the specified Elasticsearch cluster, uses the configured snapshot repository.
Requestedit
POST /api/v1/clusters/elasticsearch/{cluster_id}/_snapshot
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Request bodyedit
(ClusterSnapshotRequest) Overrides default settings for the snapshot
Responsesedit
-
202 -
(
ClusterSnapshotResponse) The create snapshot command was issued successfully -
401 -
(
BasicFailedReply) The supplied credentials for the snapshot repository are invalid (code: 'clusters.snapshot.invalid_credentials') -
404 -
(
BasicFailedReply) The cluster specified by {cluster_id} cannot be found, or the snapshot repository was not found (code: 'clusters.cluster_not_found', 'clusters.snapshot.repository_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.unauthorized.rbac.elevated_permissions_required"') -
500 -
(
BasicFailedReply) The snapshot request failed (code: 'clusters.snapshot.failed', clusters.endpoint_not_found)
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/_snapshot \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
"name" : "string",
"password" : "string",
"repository_name" : "string",
"username" : "string"
}
'