validate-game-version

ValidateGameVersion

Validates information used to create a new game version.

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.

Request Body required

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.
config object required
Cloud configuration for a given version.
cdn object
CDN configuration for a given version.
site_id string
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.
routes object[]
Multiple CDN version routes.
glob string required
priority int32 required
Unsigned 32 bit integer.
middlewares object[] required
Multiple CDN version middleware.
kind required
matchmaker object
Matchmaker configuration for a given version.
lobby_groups object[] required
A list of game modes.
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.
regions object[] required
A list of game mode regions.
region_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.
tier_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.
idle_lobbies object
Configuration for how many idle lobbies a game version should have.
min_idle_lobbies int32 required
Unsigned 32 bit integer.
max_idle_lobbies int32 required
Unsigned 32 bit integer.
max_players_normal int32 required
Unsigned 32 bit integer.
max_players_direct int32 required
Unsigned 32 bit integer.
max_players_party int32 required
Unsigned 32 bit integer.
runtime required
A union representing the runtime a game mode runs on.
captcha object
Matchmaker captcha configuration.
hcaptcha object
hCpatcha configuration.
level string required
Possible values: [easy, moderate, difficult, always_on]
How hard a captcha should be.
requests_before_reverify int32 required
Denotes how many requests a connection can make before it is required to reverify a captcha.
verification_ttl int64 required
Denotes how long a connection can continue to reconnect without having to reverify a captcha (in milliseconds).
kv object
KV configuration for a given version.
identity object
Identity configuration for a given version.
custom_display_names object[] required
display_name string required
Possible values: 1 ≤ length ≤ 11, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$
custom_avatars object[] required
upload_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

ValidateGameVersion 200 response

Schema

errors object[] required
A list of validation errors.
path string[] required
A list of strings denoting the origin of a validation error.

ValidateGameVersion​

ValidateGameVersion