Sign In

games.namespaces.logs.listNamespaceLobbies

Description

Returns a list of lobbies for the given game namespace.

Code Examples

curl -X GET 'https://api.rivet.gg/cloud/games/{game_id}/namespaces/{namespace_id}/logs/lobbies'

Request Parameters

game_id

required path parameter

namespace_id

required path parameter

before_create_ts

optional query parameter

Returns lobbies created before this timestamp.

Response Body

  • lobbies
    array of objects

    A list of lobby log summaries.

    • lobbies.lobby_id
      string
    • lobbies.namespace_id
      string
    • lobbies.lobby_group_name_id
      string

      A human readable short identifier used to references resources. Different than a rivet.common#Uuid because this is intended to be human readable. Different than rivet.common#DisplayName because this should not include special characters and be short.

    • lobbies.region_id
      string
    • lobbies.create_ts
      string

      RFC3339 timestamp

    • lobbies.start_ts
      string

      RFC3339 timestamp

    • lobbies.ready_ts
      string

      RFC3339 timestamp

    • lobbies.status
      object

      A union representing the state of a lobby.

      • lobbies.status.running
        empty object
      • lobbies.status.stopped
        object

        The status of a stopped lobby.

        • lobbies.status.stopped.stop_ts
          string

          RFC3339 timestamp

        • lobbies.status.stopped.failed
          boolean

          Whether or not the lobby failed or stopped successfully.

        • lobbies.status.stopped.exit_code
          number

          The exit code returned by the lobby's main process when stopped.