games.getGameById

Description

Returns a game by its game id.

Code Examples

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

Request Parameters

game_id

required path parameter

watch_index

optional query parameter

A query parameter denoting the requests watch index.

Response Body

game
object
A full game.
- game.game_id
  string
- game.create_ts
  string
  RFC3339 timestamp
- game.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.
- game.display_name
  string
  Represent a resource's readable display name.
- game.developer_group_id
  string
- game.total_player_count
  number
  Unsigned 32 bit integer.
- game.logo_url
  string
  The URL of this game's logo image.
- game.banner_url
  string
  The URL of this game's banner image.
- game.namespaces
  array of objects
  A list of namespace summaries.
  game.namespaces.namespace_id
  string
  game.namespaces.create_ts
  string
  RFC3339 timestamp
  game.namespaces.display_name
  string
  Represent a resource's readable display name.
  game.namespaces.version_id
  string
  game.namespaces.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.
- game.versions
  array of objects
  A list of version summaries.
  game.versions.version_id
  string
  game.versions.create_ts
  string
  RFC3339 timestamp
  game.versions.display_name
  string
  Represent a resource's readable display name.
- game.available_regions
  array of objects
  A list of region summaries.
  game.available_regions.region_id
  string
  game.available_regions.region_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.
  game.available_regions.provider
  string
  The server provider of this region.
  game.available_regions.universal_region
  any value
  game.available_regions.provider_display_name
  string
  Represent a resource's readable display name.
  game.available_regions.region_display_name
  string
  Represent a resource's readable display name.
watch
object
Provided by watchable endpoints used in blocking loops.
- watch.index
  string
  Index indicating the version of the data responded. Pass this to WatchQuery to block and wait for the next response.