Skip to main content

GetGameById​

Returns a game by its game id.

Path Parameters
  • game_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.

Query Parameters
  • watch_index string

    A query parameter denoting the requests watch index.

Responses

GetGameById 200 response

Schema
  • game object required

    A full game.

    • game_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.

    • create_ts date-time required

      RFC3339 timestamp.

    • name_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.

    • display_name string required

      Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$

      Represent a resource's readable display name.

    • developer_group_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.

    • total_player_count int32 required

      Unsigned 32 bit integer.

    • logo_url string

      The URL of this game's logo image.

    • banner_url string

      The URL of this game's banner image.

    • namespaces object[] required

      A list of namespace summaries.

      • namespace_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.

      • create_ts date-time required

        RFC3339 timestamp.

      • display_name string required

        Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$

        Represent a resource's readable display name.

      • version_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.

      • name_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.

    • versions object[] required

      A list of version summaries.

      • version_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.

      • create_ts date-time required

        RFC3339 timestamp.

      • display_name string required

        Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$

        Represent a resource's readable display name.

    • available_regions object[] required

      A list of region summaries.

      • region_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.

      • region_name_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 string required

        The server provider of this region.

      • universal_region number required

        A universal number given to this region.

      • provider_display_name string required

        Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$

        Represent a resource's readable display name.

      • region_display_name string required

        Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$

        Represent a resource's readable display name.

  • watch object required

    Provided by watchable endpoints used in blocking loops.

    • index string required

      Index indicating the version of the data responded.

      Pas this to rivet.common#WatchQuery to block and wait for the next response.