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

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": [
    {
      "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"
  ],
  "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-roblox-engine-usability": {
    "apiKeyWithHttpService": true
  },
  "x-roblox-scopes": [
    {
      "name": "memory-store:flush",
      "targetResourceSpecifier": "universes"
    },
    {
      "name": "memory-store:flush"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "memory-store:flush"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/MemoryStore",
      "name": "MemoryStore"
    }
  },
  "x-roblox-stability": "STABLE",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 1000000
    }
  },
  "security": [
    {
      "roblox-api-key": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/storage#Cloud_FlushMemoryStore"
  }
}