DELETE /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id} — cloud.docs

Delete Data Store Entry

Marks the specified entry for deletion.

Entries are not be deleted immediately; instead, the state field will be set to DELETED. Permanent deletion occurs after 30 days.

On success, returns 200 OK. If the entry doesn't exist, returns 404 Not Found.

Endpoint

Method: DELETE

Path: /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_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.
scope_id	path	true	The scope ID.
entry_id	path	true	The entry 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"
    }
  },
  {
    "name": "scope_id",
    "in": "path",
    "description": "The scope ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "entry_id",
    "in": "path",
    "description": "The entry ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {}
  }
}

Authentication

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

DataStoreEntry

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Delete Data Store Entry",
  "description": "Marks the specified entry for deletion.\n\nEntries are not be deleted immediately; instead, the `state` field will\nbe set to `DELETED`. Permanent deletion occurs after 30 days.\n\nOn success, returns 200 OK. If the entry doesn't exist, returns\n404 Not Found.",
  "operationId": "Cloud_DeleteDataStoreEntry__Using_Universes_DataStores_Scopes",
  "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"
      }
    },
    {
      "name": "scope_id",
      "in": "path",
      "description": "The scope ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "entry_id",
      "in": "path",
      "description": "The entry ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {}
    }
  },
  "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.objects:delete"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "universe-datastores.objects:delete"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/DataStoreEntry",
      "name": "DataStoreEntry"
    }
  }
}