POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries — openapi

Create Data Store Entry

Creates an entry with the provided ID and value.

Returns a 400 Bad Request if the entry exists.

Endpoint

Method: POST

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

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.
id	query	false	The ID to use for the data store entry, which will become the final component of the data store entry's resource path. This value should be a 1-50 character string. We strongly recommend using only lowercase letters, numeric digits, and hyphens.

[
  {
    "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": "id",
    "in": "query",
    "description": "The ID to use for the data store entry, which will become the final\ncomponent of the data store entry's resource path.\n\nThis value should be a 1-50 character string. We strongly recommend using\nonly lowercase letters, numeric digits, and hyphens.",
    "schema": {
      "type": "string"
    },
    "examples": {
      "id": {
        "description": "a 1-50 character string. We strongly recommend using only lowercase letters, numeric digits, and hyphens.",
        "value": "my-entry"
      }
    }
  }
]

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": "Create Data Store Entry",
  "description": "Creates an entry with the provided ID and value.\n\nReturns a 400 Bad Request if the entry exists.",
  "operationId": "Cloud_CreateDataStoreEntry__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": "scope_id",
      "in": "path",
      "description": "The scope ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "id",
      "in": "query",
      "description": "The ID to use for the data store entry, which will become the final\ncomponent of the data store entry's resource path.\n\nThis value should be a 1-50 character string. We strongly recommend using\nonly lowercase letters, numeric digits, and hyphens.",
      "schema": {
        "type": "string"
      },
      "examples": {
        "id": {
          "description": "a 1-50 character string. We strongly recommend using only lowercase letters, numeric digits, and hyphens.",
          "value": "my-entry"
        }
      }
    }
  ],
  "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:create"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "universe-datastores.objects:create"
      ]
    },
    "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_CreateDataStoreEntry__Using_Universes_DataStores"
  }
}