games.namespaces.getGameNamespaceById

Description

Gets a game namespace by namespace ID.

Code Examples

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

Request Parameters

game_id

required path parameter

namespace_id

required path parameter

Response Body

namespace
object
A full namespace.
- namespace.namespace_id
  string
- namespace.create_ts
  string
  RFC3339 timestamp
- namespace.display_name
  string
  Represent a resource's readable display name.
- namespace.version_id
  string
- namespace.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.
- namespace.config
  object
  Cloud configuration for a given namespace.
  namespace.config.cdn
  object
  CDN configuration for a given namespace.
  namespace.config.cdn.enable_domain_public_auth
  boolean
  Whether or not to allow users to connect to the given namespace via domain name.
  namespace.config.cdn.domains
  array of objects
  A list of CDN domains for a given namespace.
  namespace.config.cdn.domains.domain
  string
  A valid domain name (no protocol).
  namespace.config.cdn.domains.create_ts
  string
  RFC3339 timestamp
  namespace.config.cdn.domains.verification_status
  string
  A value denoting the status of a CDN domain's verification status.
  namespace.config.cdn.domains.verification_method
  object
  A union representing the verification method used for this CDN domain.
  namespace.config.cdn.domains.verification_method.invalid
  empty object
  namespace.config.cdn.domains.verification_method.http
  object
  namespace.config.cdn.domains.verification_method.http.cname_record
  string
  namespace.config.cdn.domains.verification_errors
  array of strings
  namespace.config.cdn.auth_type
  string
  A value denoting what type of authentication to use for a game namespace's CDN.
  namespace.config.cdn.auth_user_list
  array of objects
  A list of CDN authenticated users for a given namespace.
  namespace.config.cdn.auth_user_list.user
  string
  A user name.
  namespace.config.matchmaker
  object
  Matchmaker configuration for a given namespace.
  namespace.config.matchmaker.lobby_count_max
  number
  Unsigned 32 bit integer.
  namespace.config.matchmaker.max_players_per_client
  number
  Unsigned 32 bit integer.
  namespace.config.matchmaker.max_players_per_client_vpn
  number
  Unsigned 32 bit integer.
  namespace.config.matchmaker.max_players_per_client_proxy
  number
  Unsigned 32 bit integer.
  namespace.config.matchmaker.max_players_per_client_tor
  number
  Unsigned 32 bit integer.
  namespace.config.matchmaker.max_players_per_client_hosting
  number
  Unsigned 32 bit integer.
  namespace.config.kv
  empty object
  KV configuration for a given namespace.
  namespace.config.identity
  empty object
  Identity configuration for a given namespace.