DELETE /cloud/v2/universes/{universe_id}/data-stores/{data_store_id} — cloud.docs

Delete Data Store

Schedules the specified data store for permanent deletion.

This operation assigns the data store an expiry time 30 days in the future, at which point permanent deletion begins. To cancel, use the UndeleteDataStore operation before the data store's expiry time.

Permanent deletion consists of deleting all of the entries in the data store and then the data store resource itself. The data store is no longer returned by the ListDataStores Open Cloud endpoint or ListDataStoresAsync Luau API, and you can reuse the data store's name.

The duration of the permanent deletion process depends on the number of entries in the data store. However, you can expect a data store with 1 million or fewer entries to be permanently deleted within 3 days.

Data stores scheduled for permanent deletion are returned by the ListDataStores Open Cloud endpoint when the query parameter showDeleted is set to true. In the return value, each data store will have a DELETED state and an expireTime field.

Data stores scheduled for permanent deletion are immediately made inaccessible, meaning attempts to read or write to their entries will fail.

Note: Due to caching in the backend service, attempts to read from or write to entries in these data stores can continue to succeed for a limited time after the deletion:

GetDataStoreEntry: can succeed for up to 24 hours.
All other endpoints: can succeed for several minutes.

If the data store is already in a DELETED state, this operation is a no-op, and the data store is returned as-is.

Endpoint

Method: DELETE

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

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
data_store_id	path	true	The data-store ID.

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

Responses

Status	Description
200	OK

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

Authentication

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

DataStore

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Delete Data Store",
  "description": "Schedules the specified data store for permanent deletion.\n\nThis operation assigns the data store an expiry time 30 days in the future,\nat which point permanent deletion begins. To cancel, use the\n`UndeleteDataStore` operation before the data store's expiry time.\n\nPermanent deletion consists of deleting all of the entries in the data\nstore and then the data store resource itself. The data store is no longer\nreturned by the `ListDataStores` Open Cloud endpoint or\n`ListDataStoresAsync` Luau API, and you can reuse the data store's name.\n\nThe duration of the permanent deletion process depends on the number of\nentries in the data store. However, you can expect a data store with 1\nmillion or fewer entries to be permanently deleted within 3 days.\n\nData stores scheduled for permanent deletion are returned by the\n`ListDataStores` Open Cloud endpoint when the query parameter `showDeleted`\nis set to `true`. In the return value, each data store will have a\n`DELETED` state and an `expireTime` field.\n\nData stores scheduled for permanent deletion are immediately made\ninaccessible, meaning attempts to read or write to their entries will fail.\n\nNote: Due to caching in the backend service, attempts to read from or write\nto entries in these data stores can continue to succeed for a limited time\nafter the deletion:\n* `GetDataStoreEntry`: can succeed for up to 24 hours.\n* All other endpoints: can succeed for several minutes.\n\nIf the data store is already in a `DELETED` state, this operation is a\nno-op, and the data store is returned as-is.",
  "operationId": "Cloud_DeleteDataStore",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "data_store_id",
      "in": "path",
      "description": "The data-store ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/DataStore"
          }
        }
      }
    }
  },
  "x-visibility": "BETA",
  "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:delete"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "universe-datastores.control:delete"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/DataStore",
      "name": "DataStore"
    }
  }
}