GET /cloud/v2/universes/{universe_id}/memory-store/operations/{operation_id} — openapi

Get Memory Store Flush Operation

Retrieves the status of the operation to flush the memory stores of a universe.

Endpoint

Method: GET

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

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
operation_id	path	true	The operation ID.
scope	query	false	The scope of the memory store flush operation. 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": "operation_id",
    "in": "path",
    "description": "The operation ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "scope",
    "in": "query",
    "description": "The scope of the memory store flush operation.\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/OCV2.Operations.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": {}
        }
      }
    }
  }
}

OCV2.Operations.Operation

Complete Operation Definition

{
  "summary": "Get Memory Store Flush Operation",
  "description": "Retrieves the status of the operation to [flush the memory stores of a universe](https://create.roblox.com/docs/cloud/reference/features/storage#Cloud_FlushMemoryStore).",
  "operationId": "Cloud_GetMemoryStoreFlushOperation",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "operation_id",
      "in": "path",
      "description": "The operation ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "scope",
      "in": "query",
      "description": "The scope of the memory store flush operation.\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/OCV2.Operations.Operation"
          }
        }
      }
    }
  },
  "x-roblox-stability": "BETA",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 1000000
    }
  },
  "x-roblox-scopes": [
    {
      "name": "memory-store:get",
      "targetResourceSpecifier": "universes"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": true
  },
  "security": [
    {
      "roblox-api-key": []
    }
  ],
  "tags": [
    "Data and memory stores"
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/storage#Cloud_GetMemoryStoreFlushOperation"
  }
}