games.namespaces.getGameNamespaceById
Description
Gets a game namespace by namespace ID.
Code Examples
Request
curl -X GET 'https://api.rivet.gg/cloud/games/{game_id}/namespaces/{namespace_id}'
Request Parameters
game_id
required path parameternamespace_id
required path parameterResponse Body
namespace
required objectA full namespace.
config
required objectCloud configuration for a given namespace.
cdn
required objectCDN configuration for a given namespace.
auth_type
required stringA value denoting what type of authentication to use for a game namespace's CDN.
auth_user_list
required array<object>A list of CDN authenticated users for a given namespace.
auth_user_list[*]
objectAn authenticated CDN user for a given namespace.
user
required stringA user name.
domains
required array<object>A list of CDN domains for a given namespace.
domains[*]
objectA CDN domain for a given namespace.
create_ts
required stringRFC3339 timestamp
domain
required stringA valid domain name (no protocol).
verification_errors
required array<string>verification_errors[*]
stringverification_method
required objectA union representing the verification method used for this CDN domain.
http
objectcname_record
required stringinvalid
objectverification_status
required stringA value denoting the status of a CDN domain's verification status.
enable_domain_public_auth
required booleanWhether or not to allow users to connect to the given namespace via domain name.
identity
required objectIdentity configuration for a given namespace.
kv
required objectKV configuration for a given namespace.
matchmaker
required objectMatchmaker configuration for a given namespace.
lobby_count_max
required integerUnsigned 32 bit integer.
max_players_per_client
required integerUnsigned 32 bit integer.
max_players_per_client_hosting
required integerUnsigned 32 bit integer.
max_players_per_client_proxy
required integerUnsigned 32 bit integer.
max_players_per_client_tor
required integerUnsigned 32 bit integer.
max_players_per_client_vpn
required integerUnsigned 32 bit integer.
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 string