games.namespaces.createGameNamespaceTokenDevelopment
Description
Creates a development token for the given namespace.
Code Examples
Request
# Write the request body to body.json before running
curl -X POST -d '@body.json' 'https://api.rivet.gg/cloud/games/{game_id}/namespaces/{namespace_id}/tokens/development'
Request Parameters
game_id
required path parameter
namespace_id
required path parameter
Request Body
hostname
required string
The hostname used for the token.
ports
map<string, object>
ports.<port>
object
A port configuration used to create development tokens.
port
integer
port_range
object
Range of ports that can be connected to.
If configured, network_mode
must equal host
.
Port ranges may overlap between containers, it is the responsibility of the developer to ensure ports are available before using.
Read more about host networking here.
Only available on Rivet Open Source & Enterprise.
Related
- cloud.version.matchmaker.PortProtocol
- cloud.version.matchmaker.ProxyKind
max
required integer
Unsigned 32 bit integer.
min
required integer
Unsigned 32 bit integer.
protocol
required string
Signifies the protocol of the port.
Note that when proxying through GameGuard (via ProxyKind
), the port number returned by /find
, /join
, and /create
will not be the same as the port number configured in the config:
- With HTTP, the port will always be 80. The hostname of the port correctly routes the incoming connection to the correct port being used by the game server.
- With HTTPS, the port will always be 443. The hostname of the port correctly routes the incoming connection to the correct port being used by the game server.
- Using TCP/UDP, the port will be a random number between 26000 and 31999. This gets automatically routed to the correct port being used by the game server.
Related - cloud.version.matchmaker.GameModeRuntimeDockerPort - cloud.version.matchmaker.ProxyKind - /docs/dynamic-servers/concepts/game-guard - matchmaker.lobbies.find
Response Body
token
required string
A JSON Web Token. Slightly modified to include a description prefix and use Protobufs of JSON.