Skip to main content

GetGameNamespaceById​

Gets a game namespace by namespace 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.

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

Responses

GetGameNamespaceById 200 response

Schema
  • namespace object required

    A full namespace.

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

    • config object required

      Cloud configuration for a given namespace.

      • cdn object required

        CDN configuration for a given namespace.

        • enable_domain_public_auth boolean required

          Whether or not to allow users to connect to the given namespace via domain name.

        • domains object[] required

          A list of CDN domains for a given namespace.

          • domain string required

            A valid domain name (no protocol).

        • auth_type string required

          Possible values: [none, basic]

          A value denoting what type of authentication to use for a game namespace's CDN.

        • auth_user_list object[] required

          A list of CDN authenticated users for a given namespace.

          • user string required

            A user name.

      • matchmaker object required

        Matchmaker configuration for a given namespace.

        • lobby_count_max int32 required

          Unsigned 32 bit integer.

        • max_players_per_client int32 required

          Unsigned 32 bit integer.

        • max_players_per_client_vpn int32 required

          Unsigned 32 bit integer.

        • max_players_per_client_proxy int32 required

          Unsigned 32 bit integer.

        • max_players_per_client_tor int32 required

          Unsigned 32 bit integer.

        • max_players_per_client_hosting int32 required

          Unsigned 32 bit integer.

      • kv object required

        KV configuration for a given namespace.

      • identity object required

        Identity configuration for a given namespace.