POST /ordered-data-stores/v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries — openapi

Creates a new entry with the content value provided.

Endpoint

Method: POST

Path: /ordered-data-stores/v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universeId	path	true	The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
orderedDataStore	path	true	The name of the ordered data store.
scope	path	true	The name of the data store scope. See Scopes.
id	query	true	The name of the entry.

[
  {
    "name": "universeId",
    "in": "path",
    "description": "The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "orderedDataStore",
    "in": "path",
    "description": "The name of the ordered data store.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "scope",
    "in": "path",
    "description": "The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "id",
    "in": "query",
    "description": "The name of the entry.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request Body

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

Responses

Status	Description
200	OK
400	Bad Request: invalid orderedDataStore, scope or entry name or encoding.
403	Forbidden: studio access to APIs is not allowed, incorrect API key or scope.
404	Not found.
429	Too Many Requests.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Entry"
        }
      }
    }
  },
  "400": {
    "description": "Bad Request: invalid orderedDataStore, scope or entry name or encoding."
  },
  "403": {
    "description": "Forbidden: studio access to APIs is not allowed, incorrect API key or scope."
  },
  "404": {
    "description": "Not found."
  },
  "429": {
    "description": "Too Many Requests."
  }
}

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": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Data and memory stores"
  ],
  "description": "Creates a new entry with the content value provided.",
  "operationId": "OrderedDataStores_CreateEntry",
  "x-roblox-cloud-api-operation-name": "Create",
  "x-roblox-stability": "BETA",
  "parameters": [
    {
      "name": "universeId",
      "in": "path",
      "description": "The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "orderedDataStore",
      "in": "path",
      "description": "The name of the ordered data store.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "scope",
      "in": "path",
      "description": "The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "id",
      "in": "query",
      "description": "The name of the entry.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/CreateEntryRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Entry"
          }
        }
      }
    },
    "400": {
      "description": "Bad Request: invalid orderedDataStore, scope or entry name or encoding."
    },
    "403": {
      "description": "Forbidden: studio access to APIs is not allowed, incorrect API key or scope."
    },
    "404": {
      "description": "Not found."
    },
    "429": {
      "description": "Too Many Requests."
    }
  },
  "security": [
    {
      "roblox-api-key": []
    }
  ],
  "x-roblox-scopes": [
    {
      "name": "universe.ordered-data-store.scope.entry:write"
    }
  ],
  "x-roblox-cloud-api-operation-code-samples": [
    {
      "language": "curl",
      "script": "curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries?id=<id>' \\\n--header 'x-api-key: <insert-api-key>' \\\n--header 'Content-Type: application/json' \\\n--data '{ \n    \"value\": <long> \n}'\n"
    }
  ],
  "x-roblox-rate-limits": {
    "description": "See [Throttling](/cloud/guides/data-stores/throttling.md).",
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 500
    }
  },
  "x-roblox-recommended-alternatives": [
    {
      "url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries",
      "httpMethod": "POST",
      "documentationUrl": "https://create.roblox.com/docs/cloud/reference/features/storage#Cloud_CreateOrderedDataStoreEntry"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/storage#OrderedDataStores_CreateEntry"
  }
}