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
required path parameterwatch_index
optional query parameterA query parameter denoting the requests watch index.
Response Body
game
required objectA full game.
available_regions
required array<object>A list of region summaries.
available_regions[*]
objectA region summary.
provider
required stringThe server provider of this region.
provider_display_name
required stringRepresent a resource's readable display name.
region_display_name
required stringRepresent a resource's readable display name.
region_id
required stringregion_name_id
required stringA 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.
banner_url
stringThe URL of this game's banner image.
create_ts
required stringRFC3339 timestamp
developer_group_id
required stringdisplay_name
required stringRepresent a resource's readable display name.
game_id
required stringlogo_url
stringThe URL of this game's logo image.
name_id
required stringA 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.
namespaces
required array<object>A list of namespace summaries.
namespaces[*]
objectA namespace summary.
create_ts
required stringRFC3339 timestamp
display_name
required stringRepresent a resource's readable display name.
name_id
required stringA 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.
namespace_id
required stringversion_id
required stringtotal_player_count
required integerUnsigned 32 bit integer.
versions
required array<object>A list of version summaries.
versions[*]
objectA version summary.
create_ts
required stringRFC3339 timestamp
display_name
required stringRepresent a resource's readable display name.
version_id
required stringwatch
required objectProvided by watchable endpoints used in blocking loops.
index
required stringIndex indicating the version of the data responded.
Pass this to WatchQuery to block and wait for the next response.