POST /cloud/v2/universes/{universe_id}/data-stores:snapshot — cloud.docs

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.

Endpoint

Method: POST

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

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SnapshotDataStoresRequest"
      }
    }
  },
  "required": true
}

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/SnapshotDataStoresResponse"
        }
      }
    }
  }
}

Authentication

{
  "security": [],
  "securitySchemes": {}
}

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Snapshot Data Stores",
  "description": "Takes a new snapshot of the data stores in an experience.\n\nAfter a snapshot, the next write to every key in the experience will\ncreate a versioned backup of the previous data, regardless of the time of\nthe last write.\n\nIn effect, all data current at the time of the snapshot is guaranteed to be\navailable as a versioned backup for at least 30 days.\n\nSnapshots can be taken once per UTC day, per experience. If the latest\nsnapshot was taken within the same UTC day, this operation is a no-op and\nthe time of the latest snapshot will be returned.\n\nFor more information on using snapshots, see the [Data\nstores](https://create.roblox.com/docs/cloud-services/data-stores#snapshots)\nEngine guide.",
  "operationId": "Cloud_SnapshotDataStores",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/SnapshotDataStoresRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SnapshotDataStoresResponse"
          }
        }
      }
    }
  },
  "x-visibility": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-rate-limits": {
    "description": "Data stores requests are subject to additional throttling limits described in the [Open Cloud guide for data stores](https://create.roblox.com/docs/cloud/guides/data-stores/throttling)."
  },
  "x-roblox-scopes": [
    {
      "name": "universe-datastores.control:snapshot"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "universe-datastores.control:snapshot"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/DataStore",
      "name": "DataStore"
    }
  }
}