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

List Luau Execution Session Task Logs

Lists log chunks generated by a LuauExecutionSessionTask.

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}/logs

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.
maxPageSize	query	false	The maximum number of luau execution session task logs to return. The service might return fewer than this value. If unspecified, at most 10000 luau execution session task logs are returned. The maximum value is 10000 and higher values are set to 10000.
pageToken	query	false	A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token.
view	query	false	The view in which to retrieve the luau execution session task log. Supports FLAT and STRUCTURED. Defaults to FLAT. Possible values: \| Value \| Description \| \| --- \| --- \| \| VIEW_UNSPECIFIED \| The luau execution session task log view is not specified; the default will be used. \| \| FLAT \| If this view is selected, the `messages` field will be populated (and the `structuredMessages` field will not). Each entry of the `messages` array contains only the log message, without additional medata. This is the default. \| \| STRUCTURED \| If this view is selected, the `structuredMessages` field will be populated (and the `messages` field will not). Each entry of the `structuredMessages` array contains the log message plus additional metadata (see `LogMessage` for details). \|

[
  {
    "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": "maxPageSize",
    "in": "query",
    "description": "The maximum number of luau execution session task logs to return. The\nservice might return fewer than this value. If unspecified, at most 10000\nluau execution session task logs are returned. The maximum value is 10000\nand higher values are set to 10000.",
    "schema": {
      "type": "integer",
      "format": "int32"
    },
    "examples": {
      "maxPageSize": {
        "description": "An integer between 1 and 10000, inclusive",
        "value": 10000
      }
    }
  },
  {
    "name": "pageToken",
    "in": "query",
    "description": "A page token, received from a previous call, to retrieve a subsequent page.\n\nWhen paginating, all other parameters provided to the subsequent call must\nmatch the call that provided the page token.",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "view",
    "in": "query",
    "description": "The view in which to retrieve the luau execution session task log.\n\nSupports FLAT and STRUCTURED.\n\nDefaults to FLAT.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | VIEW_UNSPECIFIED | The luau execution session task log view is not specified; the default will be used. |\n  | FLAT | If this view is selected, the `messages` field will be populated (and the `structuredMessages` field will not). Each entry of the `messages` array contains only the log message, without additional medata. This is the default. |\n  | STRUCTURED | If this view is selected, the `structuredMessages` field will be populated (and the `messages` field will not). Each entry of the `structuredMessages` array contains the log message plus additional metadata (see `LogMessage` for details). |",
    "schema": {
      "example": "VIEW_UNSPECIFIED",
      "enum": [
        "VIEW_UNSPECIFIED",
        "FLAT",
        "STRUCTURED"
      ],
      "type": "string",
      "format": "enum"
    }
  }
]

Responses

Status	Description
200	OK

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

Authentication

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

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "List Luau Execution Session Task Logs",
  "description": "Lists log chunks generated by a `LuauExecutionSessionTask`.",
  "operationId": "Cloud_ListLuauExecutionSessionTaskLogs",
  "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": "maxPageSize",
      "in": "query",
      "description": "The maximum number of luau execution session task logs to return. The\nservice might return fewer than this value. If unspecified, at most 10000\nluau execution session task logs are returned. The maximum value is 10000\nand higher values are set to 10000.",
      "schema": {
        "type": "integer",
        "format": "int32"
      },
      "examples": {
        "maxPageSize": {
          "description": "An integer between 1 and 10000, inclusive",
          "value": 10000
        }
      }
    },
    {
      "name": "pageToken",
      "in": "query",
      "description": "A page token, received from a previous call, to retrieve a subsequent page.\n\nWhen paginating, all other parameters provided to the subsequent call must\nmatch the call that provided the page token.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "view",
      "in": "query",
      "description": "The view in which to retrieve the luau execution session task log.\n\nSupports FLAT and STRUCTURED.\n\nDefaults to FLAT.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | VIEW_UNSPECIFIED | The luau execution session task log view is not specified; the default will be used. |\n  | FLAT | If this view is selected, the `messages` field will be populated (and the `structuredMessages` field will not). Each entry of the `messages` array contains only the log message, without additional medata. This is the default. |\n  | STRUCTURED | If this view is selected, the `structuredMessages` field will be populated (and the `messages` field will not). Each entry of the `structuredMessages` array contains the log message plus additional metadata (see `LogMessage` for details). |",
      "schema": {
        "example": "VIEW_UNSPECIFIED",
        "enum": [
          "VIEW_UNSPECIFIED",
          "FLAT",
          "STRUCTURED"
        ],
        "type": "string",
        "format": "enum"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListLuauExecutionSessionTaskLogsResponse"
          }
        }
      }
    }
  },
  "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/LuauExecutionSessionTaskLog",
      "name": "LuauExecutionSessionTaskLog"
    }
  }
}