GET /cloud/v2/universes/{universe_id}/places/{place_id}/versions/{version_id}/luau-execution-sessions/{luau_execution_session_id}/tasks/{task_id} — cloud.docs

Get Luau Execution Session Task

Gets information about a task.

Endpoint

Method: GET

Path: /cloud/v2/universes/{universe_id}/places/{place_id}/versions/{version_id}/luau-execution-sessions/{luau_execution_session_id}/tasks/{task_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.
version_id	path	true	The version ID.
luau_execution_session_id	path	true	The luau-execution-session ID.
task_id	path	true	The task ID.
view	query	false	The view in which to retrieve the luau execution session task. Supports BASIC and FULL. Defaults to BASIC. Possible values: \| Value \| Description \| \| --- \| --- \| \| VIEW_UNSPECIFIED \| The luau execution session task view is not specified; the default will be used. \| \| BASIC \| Excludes the `script` field. \| \| FULL \| Includes all fields. \|

[
  {
    "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": "version_id",
    "in": "path",
    "description": "The version ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "luau_execution_session_id",
    "in": "path",
    "description": "The luau-execution-session ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "task_id",
    "in": "path",
    "description": "The task ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "view",
    "in": "query",
    "description": "The view in which to retrieve the luau execution session task.\n\nSupports BASIC and FULL.\n\nDefaults to BASIC.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | VIEW_UNSPECIFIED | The luau execution session task view is not specified; the default will be used. |\n  | BASIC | Excludes the `script` field. |\n  | FULL | Includes all fields. |",
    "schema": {
      "example": "VIEW_UNSPECIFIED",
      "enum": [
        "VIEW_UNSPECIFIED",
        "BASIC",
        "FULL"
      ],
      "type": "string",
      "format": "enum"
    }
  }
]

Responses

Status	Description
200	OK

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

Authentication

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

LuauExecutionSessionTask

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Get Luau Execution Session Task",
  "description": "Gets information about a task.",
  "operationId": "Cloud_GetLuauExecutionSessionTask",
  "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": "version_id",
      "in": "path",
      "description": "The version ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "luau_execution_session_id",
      "in": "path",
      "description": "The luau-execution-session ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "task_id",
      "in": "path",
      "description": "The task ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "view",
      "in": "query",
      "description": "The view in which to retrieve the luau execution session task.\n\nSupports BASIC and FULL.\n\nDefaults to BASIC.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | VIEW_UNSPECIFIED | The luau execution session task view is not specified; the default will be used. |\n  | BASIC | Excludes the `script` field. |\n  | FULL | Includes all fields. |",
      "schema": {
        "example": "VIEW_UNSPECIFIED",
        "enum": [
          "VIEW_UNSPECIFIED",
          "BASIC",
          "FULL"
        ],
        "type": "string",
        "format": "enum"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/LuauExecutionSessionTask"
          }
        }
      }
    }
  },
  "x-visibility": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-scopes": [
    {
      "name": "universe.place.luau-execution-session:read"
    },
    {
      "name": "universe.place.luau-execution-session:write"
    }
  ],
  "x-roblox-docs": {
    "category": "Luau execution",
    "methodProperties": {
      "scopes": [
        "universe.place.luau-execution-session:read",
        "universe.place.luau-execution-session:write"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/LuauExecutionSessionTask",
      "name": "LuauExecutionSessionTask"
    }
  }
}