POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries — cloud.docs

Create Ordered 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}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
ordered_data_store_id	path	true	The ordered-data-store ID.
scope_id	path	true	The scope ID.
id	query	false	The ID to use for the ordered data store entry, which will become the final component of the ordered data store entry's resource path. This value should be A 1-63 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": "ordered_data_store_id",
    "in": "path",
    "description": "The ordered-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 ordered data store entry, which will become the final\ncomponent of the ordered data store entry's resource path.\n\nThis value should be A 1-63 character string. We strongly recommend using\nonly lowercase letters, numeric digits, and hyphens.",
    "schema": {
      "type": "string"
    },
    "examples": {
      "id": {
        "description": "A 1-63 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/OrderedDataStoreEntry"
      }
    }
  },
  "required": true
}

Responses

Status	Description
200	OK

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

Authentication

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

OrderedDataStoreEntry

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Create Ordered 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_CreateOrderedDataStoreEntry",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "ordered_data_store_id",
      "in": "path",
      "description": "The ordered-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 ordered data store entry, which will become the final\ncomponent of the ordered data store entry's resource path.\n\nThis value should be A 1-63 character string. We strongly recommend using\nonly lowercase letters, numeric digits, and hyphens.",
      "schema": {
        "type": "string"
      },
      "examples": {
        "id": {
          "description": "A 1-63 character string. We strongly recommend using only lowercase letters, numeric digits, and hyphens.",
          "value": "my-entry"
        }
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrderedDataStoreEntry"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrderedDataStoreEntry"
          }
        }
      }
    }
  },
  "x-visibility": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-rate-limits": {
    "description": "Ordered 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.ordered-data-store.scope.entry:write"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "universe.ordered-data-store.scope.entry:write"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/OrderedDataStoreEntry",
      "name": "OrderedDataStoreEntry"
    }
  }
}