Skip to main content

ListLobbies​

Lists all open lobbies.

Responses

ListLobbies 200 response

Schema
  • game_modes object[] required
    • game_mode_id string required

      Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[a-zA-Z0-9](?:[a-zA-Z0-9]-?)+[a-zA-Z0-9]$

      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.

  • regions object[] required
    • region_id string required

      Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[a-zA-Z0-9](?:[a-zA-Z0-9]-?)+[a-zA-Z0-9]$

      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.

    • provider_display_name string required

      Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

      A universally unique identifier.

    • region_display_name string required

      Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

      A universally unique identifier.

    • datacenter_coord object required

      Geographical coordinates for a location on Planet Earth.

      • latitude double required
      • longitude double required
    • datacenter_distance_from_client object required

      Distance available in multiple units.

      • kilometers double required
      • miles double required
  • lobbies object[] required
    • region_id string required
    • game_mode_id string required
    • lobby_id string required

      Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

      A universally unique identifier.

    • max_players_normal int32 required

      Unsigned 32 bit integer.

    • max_players_direct int32 required

      Unsigned 32 bit integer.

    • max_players_party int32 required

      Unsigned 32 bit integer.

    • total_player_count int32 required

      Unsigned 32 bit integer.