games.namespaces.getGameNamespaceById


Description

Gets a game namespace by namespace ID.


Code Examples

Request

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

Request Parameters

game_id

Path parameter, required

namespace_id

Path parameter, required


Response Body

namespace

object (required)

A full namespace.

namespace.config

object (required)

Cloud configuration for a given namespace.

namespace.config.cdn

object (required)

CDN configuration for a given namespace.

namespace.config.cdn.auth_type

string (required)

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

namespace.config.cdn.auth_user_list

array<object> (required)

A list of CDN authenticated users for a given namespace.

namespace.config.cdn.auth_user_list[*].user

string (required)

A user name.

namespace.config.cdn.domains

array<object> (required)

A list of CDN domains for a given namespace.

namespace.config.cdn.domains[*].create_ts

string (required)

RFC3339 timestamp.

namespace.config.cdn.domains[*].domain

string (required)

A valid domain name (no protocol).

namespace.config.cdn.domains[*].verification_errors

array<string> (required)

namespace.config.cdn.domains[*].verification_method

object (required)

A union representing the verification method used for this CDN domain.

namespace.config.cdn.domains[*].verification_method.http

object

namespace.config.cdn.domains[*].verification_method.http.cname_record

string (required)

namespace.config.cdn.domains[*].verification_method.invalid

object

namespace.config.cdn.domains[*].verification_status

string (required)

A value denoting the status of a CDN domain's verification status.

namespace.config.cdn.enable_domain_public_auth

boolean (required)

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

namespace.config.identity

object (required)

Identity configuration for a given namespace.

namespace.config.kv

object (required)

KV configuration for a given namespace.

namespace.config.matchmaker

object (required)

Matchmaker configuration for a given namespace.

namespace.config.matchmaker.lobby_count_max

integer (required)

Unsigned 32 bit integer.

namespace.config.matchmaker.max_players_per_client

integer (required)

Unsigned 32 bit integer.

namespace.config.matchmaker.max_players_per_client_hosting

integer (required)

Unsigned 32 bit integer.

namespace.config.matchmaker.max_players_per_client_proxy

integer (required)

Unsigned 32 bit integer.

namespace.config.matchmaker.max_players_per_client_tor

integer (required)

Unsigned 32 bit integer.

namespace.config.matchmaker.max_players_per_client_vpn

integer (required)

Unsigned 32 bit integer.

namespace.create_ts

string (required)

RFC3339 timestamp.

namespace.display_name

string (required)

Represent a resource's readable display name.

namespace.name_id

string (required)

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

string (required)

namespace.version_id

string (required)