POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry — datastores-api/v1

Set entry.

Sets the value, metadata and user IDs associated with an entry.

Endpoint

Method: POST

Path: /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Servers:

https://apis.roblox.com/datastores

Parameters

Name	Location	Required	Description
universeId	path	true	The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
datastoreName	query	false	The name of the data store.
entryKey	query	false	The key identifying the entry.
matchVersion	query	false	Provide to update only if the current version matches this.
exclusiveCreate	query	false	Create the entry only if it does not exist.
scope	query	false	The value is `global` by default. See Scopes.
roblox-entry-attributes	header	false	Attributes to be associated with new version of the entry. Serialized by JSON map objects. If not provided, existing attributes are cleared.
roblox-entry-userids	header	false	Comma-separated list of Roblox user IDs tagged with the entry. If not provided, existing user IDs are cleared.
content-md5	header	false	The base64-encoded MD5 checksum of the content. See Content-MD5.

[
  {
    "name": "universeId",
    "in": "path",
    "required": true,
    "description": "The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "datastoreName",
    "in": "query",
    "description": "The name of the data store.",
    "schema": {
      "type": "string",
      "nullable": true
    }
  },
  {
    "name": "entryKey",
    "in": "query",
    "description": "The key identifying the entry.",
    "schema": {
      "type": "string",
      "nullable": true
    }
  },
  {
    "name": "matchVersion",
    "in": "query",
    "description": "Provide to update only if the current version matches this.",
    "schema": {
      "type": "string",
      "default": null,
      "nullable": true
    }
  },
  {
    "name": "exclusiveCreate",
    "in": "query",
    "description": "Create the entry only if it does not exist.",
    "schema": {
      "type": "boolean",
      "default": false
    }
  },
  {
    "name": "scope",
    "in": "query",
    "description": "The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).",
    "schema": {
      "type": "string",
      "default": "global",
      "nullable": true
    }
  },
  {
    "name": "roblox-entry-attributes",
    "in": "header",
    "description": "Attributes to be associated with new version of the entry. Serialized by JSON map objects. If not provided, existing attributes are cleared.",
    "schema": {
      "type": "string",
      "nullable": true
    }
  },
  {
    "name": "roblox-entry-userids",
    "in": "header",
    "description": "Comma-separated list of Roblox user IDs tagged with the entry. If not provided, existing user IDs are cleared.",
    "schema": {
      "type": "string",
      "nullable": true
    }
  },
  {
    "name": "content-md5",
    "in": "header",
    "description": "The base64-encoded MD5 checksum of the content. See [Content-MD5](/cloud/guides/data-stores/request-handling.md#content-md5).",
    "schema": {
      "type": "string",
      "nullable": true
    }
  }
]

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "maxLength": 4194304,
        "type": "string"
      }
    }
  }
}

Responses

Status	Description
200

{
  "200": {
    "description": "",
    "content": {
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/EntryVersion"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": [
        "universe-datastores.objects:create",
        "universe-datastores.objects:update",
        "universe-datastores.control:create"
      ]
    }
  ],
  "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.",
      "in": "header",
      "name": "x-api-key"
    }
  }
}

EntryVersion

Complete Operation Definition

{
  "tags": [
    "Entries"
  ],
  "summary": "Set entry.",
  "description": "Sets the value, metadata and user IDs associated with an entry.",
  "operationId": "Entries_SetEntryAsync",
  "x-roblox-cloud-api-operation-name": "Set Entry",
  "x-roblox-stability": "BETA",
  "parameters": [
    {
      "name": "universeId",
      "in": "path",
      "required": true,
      "description": "The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "datastoreName",
      "in": "query",
      "description": "The name of the data store.",
      "schema": {
        "type": "string",
        "nullable": true
      }
    },
    {
      "name": "entryKey",
      "in": "query",
      "description": "The key identifying the entry.",
      "schema": {
        "type": "string",
        "nullable": true
      }
    },
    {
      "name": "matchVersion",
      "in": "query",
      "description": "Provide to update only if the current version matches this.",
      "schema": {
        "type": "string",
        "default": null,
        "nullable": true
      }
    },
    {
      "name": "exclusiveCreate",
      "in": "query",
      "description": "Create the entry only if it does not exist.",
      "schema": {
        "type": "boolean",
        "default": false
      }
    },
    {
      "name": "scope",
      "in": "query",
      "description": "The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).",
      "schema": {
        "type": "string",
        "default": "global",
        "nullable": true
      }
    },
    {
      "name": "roblox-entry-attributes",
      "in": "header",
      "description": "Attributes to be associated with new version of the entry. Serialized by JSON map objects. If not provided, existing attributes are cleared.",
      "schema": {
        "type": "string",
        "nullable": true
      }
    },
    {
      "name": "roblox-entry-userids",
      "in": "header",
      "description": "Comma-separated list of Roblox user IDs tagged with the entry. If not provided, existing user IDs are cleared.",
      "schema": {
        "type": "string",
        "nullable": true
      }
    },
    {
      "name": "content-md5",
      "in": "header",
      "description": "The base64-encoded MD5 checksum of the content. See [Content-MD5](/cloud/guides/data-stores/request-handling.md#content-md5).",
      "schema": {
        "type": "string",
        "nullable": true
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "maxLength": 4194304,
          "type": "string"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "",
      "content": {
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/EntryVersion"
          }
        }
      }
    }
  },
  "security": [
    {
      "roblox-api-key": [
        "universe-datastores.objects:create",
        "universe-datastores.objects:update",
        "universe-datastores.control:create"
      ]
    }
  ],
  "x-roblox-scopes": [
    {
      "name": "universe-datastores.objects:update",
      "description": "If the entry key being set exists."
    },
    {
      "name": "universe-datastores.objects:create",
      "description": "If the entry key being set doesn't exist."
    },
    {
      "name": "universe-datastores.control:create",
      "description": "If the Data Store the entry key is in doesn't exist."
    }
  ],
  "x-roblox-cloud-api-operation": true,
  "x-roblox-lua-equivalent": "GlobalDataStore:SetAsync",
  "x-roblox-cloud-api-operation-code-samples": [
    {
      "language": "curl",
      "script": "curl --include --location --request POST \"https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry?datastoreName=Coins&entryKey=269323\" \\\n--header \"x-api-key: ${API_KEY}\" \\\n--header \"content-md5: IGPBYI1uC6+AJJxC4r5YBA==\" \\\n--header \"content-type: application/json\" \\\n--header \"roblox-entry-userids: [269323]\" \\\n--header \"roblox-entry-attributes: {}\" \\\n--d \"value\""
    }
  ],
  "x-roblox-rate-limits": {
    "description": "See [Throttling](/cloud/guides/data-stores/throttling.md)."
  },
  "x-roblox-recommended-alternatives": [
    {
      "url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}",
      "httpMethod": "PATCH"
    },
    {
      "url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}",
      "httpMethod": "PATCH"
    },
    {
      "url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries",
      "httpMethod": "POST"
    },
    {
      "url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries",
      "httpMethod": "POST"
    }
  ]
}

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry — datastores-api/v1

Endpoint

Parameters

Request Body

Responses

Authentication

Related Schemas

Complete Operation Definition