GET /server-management/v1/universes/{universeId}/places/{placeId}/versions/{versionNumber}/game-servers/{jobId}/logs — openapi

Lists game server logs for a specific server job id

Endpoint

Method: GET

Path: /server-management/v1/universes/{universeId}/places/{placeId}/versions/{versionNumber}/game-servers/{jobId}/logs

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universeId	path	true	The universe id
placeId	path	true	The place id
versionNumber	path	true	The version number
jobId	path	true	The server job id
MaxPageSize	query	false	The maximum number of log entries to return. Defaults to 25 and values above 100 are capped at 100.
PageToken	query	false	An opaque token from a previous response. Preserve the other query parameters when requesting the next page.
OrderBy	query	false	Sorts by `message_timestamp` or `log_severity`. Append `desc` for descending order. Each endpoint defines its own default when this value is omitted.
Filter	query	false	Filters log entries with CEL. Use `severity` with equality or `in`, `message_timestamp` with comparisons, or `search` with equality or inequality for case-insensitive full-text matching.

[
  {
    "name": "universeId",
    "in": "path",
    "description": "The universe id",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "placeId",
    "in": "path",
    "description": "The place id",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "versionNumber",
    "in": "path",
    "description": "The version number",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "jobId",
    "in": "path",
    "description": "The server job id",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "MaxPageSize",
    "in": "query",
    "description": "The maximum number of log entries to return. Defaults to 25 and values above 100 are\r\ncapped at 100.",
    "schema": {
      "maximum": 100,
      "minimum": 1,
      "type": "integer",
      "format": "int32"
    }
  },
  {
    "name": "PageToken",
    "in": "query",
    "description": "An opaque token from a previous response. Preserve the other query parameters when\r\nrequesting the next page.",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "OrderBy",
    "in": "query",
    "description": "Sorts by `message_timestamp` or `log_severity`. Append ` desc` for descending order.\r\nEach endpoint defines its own default when this value is omitted.",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "Filter",
    "in": "query",
    "description": "Filters log entries with CEL. Use `severity` with equality or `in`, `message_timestamp`\r\nwith comparisons, or `search` with equality or inequality for case-insensitive full-text matching.",
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	Success
400	Bad Request
401	Unauthorized
403	Forbidden

{
  "200": {
    "description": "Success",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ListGameServerLogsResponse"
        }
      }
    }
  },
  "400": {
    "description": "Bad Request",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ServerManagementService.ProblemDetails"
        }
      }
    }
  },
  "401": {
    "description": "Unauthorized",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ServerManagementService.ProblemDetails"
        }
      }
    }
  },
  "403": {
    "description": "Forbidden",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ServerManagementService.ProblemDetails"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": [
        "universe:read"
      ]
    }
  ],
  "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": [
    "Observability"
  ],
  "summary": "Lists game server logs for a specific server job id",
  "operationId": "GameServers_ListGameServerLogs",
  "parameters": [
    {
      "name": "universeId",
      "in": "path",
      "description": "The universe id",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "placeId",
      "in": "path",
      "description": "The place id",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "versionNumber",
      "in": "path",
      "description": "The version number",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "jobId",
      "in": "path",
      "description": "The server job id",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "MaxPageSize",
      "in": "query",
      "description": "The maximum number of log entries to return. Defaults to 25 and values above 100 are\r\ncapped at 100.",
      "schema": {
        "maximum": 100,
        "minimum": 1,
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "name": "PageToken",
      "in": "query",
      "description": "An opaque token from a previous response. Preserve the other query parameters when\r\nrequesting the next page.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "OrderBy",
      "in": "query",
      "description": "Sorts by `message_timestamp` or `log_severity`. Append ` desc` for descending order.\r\nEach endpoint defines its own default when this value is omitted.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "Filter",
      "in": "query",
      "description": "Filters log entries with CEL. Use `severity` with equality or `in`, `message_timestamp`\r\nwith comparisons, or `search` with equality or inequality for case-insensitive full-text matching.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListGameServerLogsResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad Request",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ServerManagementService.ProblemDetails"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ServerManagementService.ProblemDetails"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ServerManagementService.ProblemDetails"
          }
        }
      }
    }
  },
  "x-roblox-stability": "BETA",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 100
    },
    "perOauth2Authorization": {
      "period": "MINUTE",
      "maxInPeriod": 100
    }
  },
  "x-roblox-scopes": [
    {
      "name": "universe:read",
      "targetResourceSpecifier": "universes"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": [
        "universe:read"
      ]
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/observability#GameServers_ListGameServerLogs"
  }
}