GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}/operations/{operation_id} — openapi

Get Update Instance Operation

Retrieves the status of the operation to update an instance.

Endpoint

Method: GET

Path: /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}/operations/{operation_id}

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
place_id	path	true	The place ID.
instance_id	path	true	The instance ID.
operation_id	path	true	The operation ID.

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "place_id",
    "in": "path",
    "description": "The place ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "instance_id",
    "in": "path",
    "description": "The instance ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "operation_id",
    "in": "path",
    "description": "The operation ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

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 Update Instance Operation",
  "description": "Retrieves the status of the operation to [update an instance](https://create.roblox.com/docs/cloud/reference/features/universes#Cloud_UpdateInstance).",
  "operationId": "Cloud_GetUpdateInstanceOperation",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "place_id",
      "in": "path",
      "description": "The place ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "instance_id",
      "in": "path",
      "description": "The instance ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "operation_id",
      "in": "path",
      "description": "The operation ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "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": 45
    }
  },
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": true
  },
  "security": [
    {
      "roblox-api-key": []
    }
  ],
  "tags": [
    "Places"
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/places#Cloud_GetUpdateInstanceOperation"
  }
}