Sign in

v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB
Data and memory stores

Snapshot Data Stores

Takes a new snapshot of the data stores in an experience.

After a snapshot, the next write to every key in the experience will create a versioned backup of the previous data, regardless of the time of the last write.

In effect, all data current at the time of the snapshot is guaranteed to be available as a versioned backup for at least 30 days.

Snapshots can be taken once per UTC day, per experience. If the latest snapshot was taken within the same UTC day, this operation is a no-op and the time of the latest snapshot will be returned.

For more information on using snapshots, see the Data stores Engine guide.

post/cloud/v2/universes/{universe_id}/data-stores:snapshot

Path parameters

universe_idstring required

The universe ID.

Request body

SnapshotDataStoresRequest required

Takes a new snapshot for the given experience.

Response

OK

newSnapshotTakenboolean

Whether a new snapshot was taken by this operation. (Only one snapshot can be taken per experience per UTC day.)

latestSnapshotTimestring date-time

The time of the latest snapshot after the operation (regardless of whether a new snapshot was created). This time is always returned in UTC.

Example response

{
  "newSnapshotTaken": true,
  "latestSnapshotTime": "2023-07-05T12:34:56Z"
}