PATCH /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id} — openapi

Update Data Store Entry

Updates the value, attributes, and users of an entry.

Updating specific revisions of the entry is unsupported. If you specify a revision ID in the path and allow_missing is true, the update request will instead create a new entry with the @<revisionId> suffix as part of the key.

Partial update is unsupported. If attributes or users are not provided when updating the value, they will be cleared. Value must always be provided when updating an entry.

Endpoint

Method: PATCH

Path: /cloud/v2/universes/{universe_id}/data-stores/{data_store_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.
entry_id	path	true	The entry ID.
allowMissing	query	false	If set to true, and the data store entry is not found, a data store entry is created.

[
  {
    "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": "entry_id",
    "in": "path",
    "description": "The entry ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "allowMissing",
    "in": "query",
    "description": "If set to true, and the data store entry is not found, a data store entry\nis created.",
    "schema": {
      "example": true,
      "type": "boolean"
    }
  }
]

Request Body

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

Responses

Status	Description
200	OK

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

Authentication

{
  "security": [
    {
      "roblox-api-key": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

DataStoreEntry

Complete Operation Definition

{
  "tags": [
    "Data and memory stores"
  ],
  "summary": "Update Data Store Entry",
  "description": "Updates the value, attributes, and users of an entry.\n\nUpdating specific revisions of the entry is **unsupported**. If you specify\na revision ID in the path and `allow_missing` is `true`, the update request\nwill instead create a new entry with the `@<revisionId>` suffix as part of\nthe key.\n\nPartial update is **unsupported**. If attributes or users are not\nprovided when updating the value, they will be cleared. Value must always\nbe provided when updating an entry.",
  "operationId": "Cloud_UpdateDataStoreEntry__Using_Universes_DataStores",
  "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": "entry_id",
      "in": "path",
      "description": "The entry ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "allowMissing",
      "in": "query",
      "description": "If set to true, and the data store entry is not found, a data store entry\nis created.",
      "schema": {
        "example": true,
        "type": "boolean"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/DataStoreEntry"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/DataStoreEntry"
          }
        }
      }
    }
  },
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": true
  },
  "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).",
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 1000000
    }
  },
  "x-roblox-scopes": [
    {
      "name": "universe-datastores.objects:update"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "universe-datastores.objects:update"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/DataStoreEntry",
      "name": "DataStoreEntry"
    }
  },
  "x-roblox-stability": "STABLE",
  "security": [
    {
      "roblox-api-key": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/storage#Cloud_UpdateDataStoreEntry__Using_Universes_DataStores"
  }
}