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.
Request
- Base URLhttps://apis.roblox.com
- URLhttps://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores:snapshot
- AuthAPI key in header x-api-key
Path parameters
The universe ID.
Request body
Takes a new snapshot for the given experience.
Response
OK
Example response
{
"newSnapshotTaken": true,
"latestSnapshotTime": "2023-07-05T12:34:56Z"
}Changes
No recorded changes to this operation across all 33 revisions of this API.