games.games.getGameById
Description
Returns a game by its game id.
Code Examples
Request
curl -X GET 'https://api.rivet.gg/cloud/games/{game_id}'
Request Parameters
game_id
Path parameter, required
watch_index
Query parameter, optional
A query parameter denoting the requests watch index.
Response Body
game
object (required)
A full game.
game.available_regions
array<object> (required)
A list of region summaries.
game.available_regions[*].provider
string (required)
The server provider of this region.
game.available_regions[*].provider_display_name
string (required)
Represent a resource's readable display name.
game.available_regions[*].region_display_name
string (required)
Represent a resource's readable display name.
game.available_regions[*].region_id
string (required)
game.available_regions[*].region_name_id
string (required)
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.banner_url
string
The URL of this game's banner image.
game.create_ts
string (required)
RFC3339 timestamp.
game.developer_group_id
string (required)
game.display_name
string (required)
Represent a resource's readable display name.
game.game_id
string (required)
game.logo_url
string
The URL of this game's logo image.
game.name_id
string (required)
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.namespaces
array<object> (required)
A list of namespace summaries.
game.namespaces[*].create_ts
string (required)
RFC3339 timestamp.
game.namespaces[*].display_name
string (required)
Represent a resource's readable display name.
game.namespaces[*].name_id
string (required)
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.namespaces[*].namespace_id
string (required)
game.namespaces[*].version_id
string (required)
game.total_player_count
integer (required)
Unsigned 32 bit integer.
game.versions
array<object> (required)
A list of version summaries.
game.versions[*].create_ts
string (required)
RFC3339 timestamp.
game.versions[*].display_name
string (required)
Represent a resource's readable display name.
game.versions[*].version_id
string (required)
watch
object (required)
Provided by watchable endpoints used in blocking loops.
watch.index
string (required)
Index indicating the version of the data responded.
Pass this to WatchQuery to block and wait for the next response.