POST /cloud/v2/universes/{universe_id}/memory-store:flush — cloud.docs

Flush Memory Store

Asynchronously flush all data structures in the universe.

Unlike some other endpoints, the flush response path already includes the cloud/v2 prefix. Poll the operation at https://apis.roblox.com/{path} without adding another prefix.

Endpoint

Method: POST

Path: /cloud/v2/universes/{universe_id}/memory-store:flush

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
scope	query	false	The scope of the memory store to flush. Possible values: \| Value \| Description \| \| --- \| --- \| \| LIVE \| Flush the live memory store scope. This is the default. \| \| TEST \| Flush the test memory store scope. \|

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "scope",
    "in": "query",
    "description": "The scope of the memory store to flush.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | LIVE |  Flush the live memory store scope. This is the default. |\n  | TEST | Flush the test memory store scope. |",
    "schema": {
      "example": "LIVE",
      "enum": [
        "LIVE",
        "TEST"
      ],
      "type": "string",
      "format": "enum"
    }
  }
]

Responses

Status	Description
200	OK

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

Authentication

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

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Flush Memory Store",
  "description": "Asynchronously flush all data structures in the universe.\n\nUnlike some other endpoints, the flush response `path` already\nincludes the `cloud/v2` prefix. Poll the operation at\n`https://apis.roblox.com/{path}` without adding another prefix.",
  "operationId": "Cloud_FlushMemoryStore",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "scope",
      "in": "query",
      "description": "The scope of the memory store to flush.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | LIVE |  Flush the live memory store scope. This is the default. |\n  | TEST | Flush the test memory store scope. |",
      "schema": {
        "example": "LIVE",
        "enum": [
          "LIVE",
          "TEST"
        ],
        "type": "string",
        "format": "enum"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Operation"
          }
        }
      }
    }
  },
  "x-long-running-operation-parameters": {
    "metadata": {
      "$ref": "#/components/schemas/FlushMemoryStoreMetadata"
    },
    "response": {
      "$ref": "#/components/schemas/FlushMemoryStoreResponse"
    }
  },
  "x-visibility": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-scopes": [
    {
      "name": "memory-store:flush"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "memory-store:flush"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/MemoryStore",
      "name": "MemoryStore"
    }
  }
}