Instaclustr Logo
Powered by Redocly

Backup & Restore

Operations related to backing up and restoring a cluster

List cluster backup events

List backups and restores for each node in a given cluster, for the last 7 days.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: ba74ca2b-7fc0-4487-a9d8-037823144753
Responses
200

Successfully retrieved the list of cluster backups.

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

get/provisioning/v1/{clusterId}/backups
Request samples 
Response samples 
application/json
{
  • "id": "77b5a4e1-c422-4a78-b551-d8fa5c42ad95",
  • "name": "example-cluster",
  • "clusterDataCentres": [
    ]
}
Trigger cluster backup
Triggers a cluster-wide backup on each node.


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
 Example:  ba74ca2b-7fc0-4487-a9d8-037823144753
Responses 
204
Successfully triggered a backup.


400
Bad Request


401
Not Authorized


403
Missing permissions


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


503
Backup capability is not available


post/provisioning/v1/{clusterId}/backups
Request samples 
Response samples 
application/json
{
  • "status": 0,
  • "message": "string",
  • "errorDetails": { },
  • "code": 0,
  • "link": "string"
}
Trigger cluster restore
Triggers a restore cluster operation.
Cluster backups may be used to restore data from a point-in-time to a new cluster. Data will be restored to a new cluster.

When restoring a cluster, you may choose to:
  • Restore all data or only selected tables: If restoring a subset of tables, the cluster schema will still be restored in its entirety and therefore the schemas for any non-restored keyspaces and tables will still be applied. However, only backup data for the selected tables will be restored.
  • Restore to a point-in-time: The restore process will use the latest backup data for each node, up to the specified point-in-time. If restoring a cluster with Continuous Backup enabled, then commit logs will also be restored.
Once the restore parameters are submitted, a new cluster will be provisioned under the account with a topology matching the designated point-in-time (e.g. if 3 nodes were added to a 3-node cluster on 01/10/2017 and the restore operation was for a point-in-time of 30/09/2017, then the restored cluster will have 3 nodes).

An empty request body will trigger a restore to the current date and time, using the most recent backup for each node and a cluster name marked as “restored” and containing the timestamp when the restore was requested.


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
 Example:  ba74ca2b-7fc0-4487-a9d8-037823144753
Request Body schema: application/json
One of:
clusterNameOverride
string[a-zA-Z0-9][a-zA-Z0-9_-]*
The display name of the restored cluster.

By default, the restored cluster will be created with its current name appended with “restored” and the date & time it was requested to be restored.


 
Array of objects (RestoreCdcInfoSchema) 
An optional list of Cluster Data Centres for which custom VPC settings will be used.

This property must be populated for all Cluster Data Centres or none at all.


 
pointInTime
integer <int64>   >= 1420070400000 
Timestamp in milliseconds since epoch. All backed up data will be restored for this point in time.

Defaults to the current date and time.


 
keyspaceTables
string
A comma separated list of keyspace/table names which follows the format <keyspace>.<table1>,<keyspace>.<table2>

Only data for the specified tables will be restored, for the point in time.


 
clusterNetwork
string <ipv4> 
The cluster network for this cluster to be restored to.


 
Responses 
200
Successfully triggered a restore.


400
Bad Request


401
Not Authorized


403
Missing permissions


404
Resource not found


412
Pre-condition failed


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


post/provisioning/v1/{clusterId}/backups/restore
Request samples 
application/json
{
  • "clusterNameOverride": "my-restored-cluster",
  • "cdcInfos": [
    ],
  • "pointInTime": 1420070400000,
  • "keyspaceTables": "keyspace1.test1,keyspace1.test2",
  • "clusterNetwork": "10.0.0.0/16"
}
Response samples 
application/json
{
  • "restoredCluster": "77b5a4e1-c422-4a78-b551-d8fa5c42ad95"
}
➔ Next to Bundle Information