API Reference

Complete reference for the GSPKit API and common definitions.

Message ConfigFile

gspkit.common.game.v1.ConfigFile

Field Type Description
id string
game_id string
path string
parser string 'PROPERTIES', 'CFG', 'JSON', 'INI', 'YAML', etc.

Message Dependency

gspkit.common.game.v1.Dependency

Field Type Description
setting_id string ID of the setting this one depends on
condition Dependency.DependencyCondition
value SettingValue The value to compare against

Message RuleDependsOn

gspkit.common.game.v1.RuleDependsOn

Controls when this setting is visible or enabled based on other settings

Field Type Description
dependencies Dependency

Message RuleValidations

gspkit.common.game.v1.RuleValidations

Validation rules for the setting

Field Type Description
validation ValidationRules

Message Setting

gspkit.common.game.v1.Setting

A complete setting object combining the value and its UI metadata.

Field Type Description
current_value SettingValue
definition SettingDefinition

Message SettingDefinition

gspkit.common.game.v1.SettingDefinition

A setting definition describes how a setting should be rendered and validated in the UI.

Field Type Description
id string
label string
description string
type SettingType
default_value SettingValue Default value for the setting
rules SettingDefinitionRule Rules drive UI/validation/behavior without changing code.
options SettingOption Options for ENUM or MULTI_SELECT settings
group string Category or group for UI grouping (e.g., "Startup", "Gameplay", "Network")
read_only bool Whether the setting is read-only for the user
source_file string Source file where the setting is stored (e.g., "server.cfg", "server.properties") For the user, this will be the resolved path.
game_id string The game this setting belongs to
config_file_id string ID of the config file this setting belongs to. If empty, it's an internal setting (.properties in root)

Message SettingDefinitionRule

gspkit.common.game.v1.SettingDefinitionRule

A flexible container to hold different rule types for a setting definition.

Field Type Description
depends_on RuleDependsOn
validations RuleValidations

Message SettingOption

gspkit.common.game.v1.SettingOption

Field Type Description
label string
value SettingValue
dependencies Dependency Controls when this option is visible/selectable based on other settings

Message SettingValue

gspkit.common.game.v1.SettingValue

Represents the actual value of a setting with a type-safe oneof for easy automation.

Field Type Description
id string
string_value string
int_value int64
bool_value bool
float_value double
string_list_value StringList For MULTI_SELECT

Message StringList

gspkit.common.game.v1.StringList

Field Type Description
values string

Message ValidationRules

gspkit.common.game.v1.ValidationRules

Field Type Description
required bool
regex string Regular expression for text validation
min double Minimum value for numbers
max double Maximum value for numbers
min_length int32 Minimum length for text
max_length int32 Maximum length for text

Enum DependencyCondition

gspkit.common.game.v1.Dependency.DependencyCondition

Value Number Description
DEPENDENCY_CONDITION_UNSPECIFIED 0
DEPENDENCY_CONDITION_EQUALS 1
DEPENDENCY_CONDITION_NOT_EQUALS 2
DEPENDENCY_CONDITION_CONTAINS 3
DEPENDENCY_CONDITION_GREATER_THAN 4
DEPENDENCY_CONDITION_LESS_THAN 5

Enum SettingType

gspkit.common.game.v1.SettingType

Value Number Description
SETTING_TYPE_UNSPECIFIED 0
SETTING_TYPE_TEXT 1
SETTING_TYPE_NUMBER 2
SETTING_TYPE_BOOLEAN 3
SETTING_TYPE_ENUM 4
SETTING_TYPE_MULTI_SELECT 5
SETTING_TYPE_PASSWORD 6
SETTING_TYPE_COLOR 7

Message AddServerUserRequest

gspkit.api.gameserver.v1.AddServerUserRequest

Field Type Description
server_id string
identifier string email, username, or steamid
permissions string Bitmask as decimal string

Message CreateBackupRequest

gspkit.api.gameserver.v1.CreateBackupRequest

Field Type Description
server_id string
name string

Message CreateDatabaseRequest

gspkit.api.gameserver.v1.CreateDatabaseRequest

Field Type Description
server_id string
database_name string

Message CreateTransactionRequest

gspkit.api.gameserver.v1.CreateTransactionRequest

Field Type Description
game_id string
slots int32
memory_upgrade_mb int32
payment_method string

Message DeleteBackupRequest

gspkit.api.gameserver.v1.DeleteBackupRequest

Field Type Description
server_id string
backup_id string

Message DeleteDatabaseRequest

gspkit.api.gameserver.v1.DeleteDatabaseRequest

Field Type Description
server_id string
database_id string

Message DeleteFileRequest

gspkit.api.gameserver.v1.DeleteFileRequest

Field Type Description
server_id string
path string

Message DeleteScheduleRequest

gspkit.api.gameserver.v1.DeleteScheduleRequest

Field Type Description
server_id string
schedule_id string

Message GetDownloadUrlRequest

gspkit.api.gameserver.v1.GetDownloadUrlRequest

Field Type Description
server_id string
path string

Message GetFileContentRequest

gspkit.api.gameserver.v1.GetFileContentRequest

Field Type Description
server_id string
path string

Message GetGameServerDetailsRequest

gspkit.api.gameserver.v1.GetGameServerDetailsRequest

Field Type Description
server_id string

Message GetServerSettingsRequest

gspkit.api.gameserver.v1.GetServerSettingsRequest

Field Type Description
server_id string

Message GetServerUsageRequest

gspkit.api.gameserver.v1.GetServerUsageRequest

Field Type Description
server_id string

Message GetUploadUrlRequest

gspkit.api.gameserver.v1.GetUploadUrlRequest

Field Type Description
server_id string
path string Target destination path

Message InstallGameRequest

gspkit.api.gameserver.v1.InstallGameRequest

Field Type Description
server_id string
game_id string New game UUID to install

Message ListBackupsRequest

gspkit.api.gameserver.v1.ListBackupsRequest

Field Type Description
server_id string

Message ListDatabasesRequest

gspkit.api.gameserver.v1.ListDatabasesRequest

Field Type Description
server_id string

Message ListFilesRequest

gspkit.api.gameserver.v1.ListFilesRequest

Field Type Description
server_id string
path string Directory path relative to server root

Message ListGamesRequest

gspkit.api.gameserver.v1.ListGamesRequest

Optional filters

Field Type Description

Message ListScheduleTemplatesRequest

gspkit.api.gameserver.v1.ListScheduleTemplatesRequest

Field Type Description
server_id string

Message ListSchedulesRequest

gspkit.api.gameserver.v1.ListSchedulesRequest

Field Type Description
server_id string

Message ListServerUsersRequest

gspkit.api.gameserver.v1.ListServerUsersRequest

Field Type Description
server_id string

Message ListServersRequest

gspkit.api.gameserver.v1.ListServersRequest

Field Type Description
page_size int32 Optional pagination or filtering by game_id could go here
page_token string

Message MoveFileRequest

gspkit.api.gameserver.v1.MoveFileRequest

Field Type Description
server_id string
source_path string
destination_path string

Message OrderServerRequest

gspkit.api.gameserver.v1.OrderServerRequest

Field Type Description
server_name string
game_id string
slots int32
memory_upgrade_mb int32
transaction_id string

Message RemoveServerUserRequest

gspkit.api.gameserver.v1.RemoveServerUserRequest

Field Type Description
server_id string
user_id string

Message ResetDatabasePasswordRequest

gspkit.api.gameserver.v1.ResetDatabasePasswordRequest

Field Type Description
server_id string
database_id string

Message RestoreBackupRequest

gspkit.api.gameserver.v1.RestoreBackupRequest

Field Type Description
server_id string
backup_id string
wipe_first bool Clean directory before extracting

Message ScheduleTask

gspkit.api.gameserver.v1.ScheduleTask

Field Type Description
power_action SendPowerActionRequest.PowerAction
send_command string
wait_seconds uint32
create_backup bool

Message SendConsoleCommandRequest

gspkit.api.gameserver.v1.SendConsoleCommandRequest

Field Type Description
server_id string
command string

Message SendPowerActionRequest

gspkit.api.gameserver.v1.SendPowerActionRequest

Field Type Description
server_id string
action SendPowerActionRequest.PowerAction

Message SubscribeServerLogsRequest

gspkit.api.gameserver.v1.SubscribeServerLogsRequest

Field Type Description
server_id string
tail_lines int32 Number of previous lines to send immediately

Message SubscribeUsageMetricsRequest

gspkit.api.gameserver.v1.SubscribeUsageMetricsRequest

Field Type Description
server_id string

Message UninstallGameRequest

gspkit.api.gameserver.v1.UninstallGameRequest

Field Type Description
server_id string
game_id string

Message UpdateScheduleRequest

gspkit.api.gameserver.v1.UpdateScheduleRequest

Field Type Description
server_id string
schedule_id string Empty for new schedule
name string
cron_expression string
is_active bool
tasks ScheduleTask

Message UpdateServerSettingsRequest

gspkit.api.gameserver.v1.UpdateServerSettingsRequest

Field Type Description
server_id string
settings gspkit.common.game.v1.SettingValue List of setting values to update

Message UpdateServerUserPermissionsRequest

gspkit.api.gameserver.v1.UpdateServerUserPermissionsRequest

Field Type Description
server_id string
user_id string
permissions string Bitmask as decimal string

Message WatchTransactionRequest

gspkit.api.gameserver.v1.WatchTransactionRequest

Field Type Description
transaction_id string

Message WriteFileRequest

gspkit.api.gameserver.v1.WriteFileRequest

Field Type Description
server_id string
path string
content string Text-based content only

Enum PowerAction

gspkit.api.gameserver.v1.SendPowerActionRequest.PowerAction

Value Number Description
POWER_ACTION_UNSPECIFIED 0
POWER_ACTION_START 1
POWER_ACTION_STOP 2
POWER_ACTION_RESTART 3
POWER_ACTION_KILL 4

Message Game

gspkit.common.game.v1.Game

Field Type Description
id string id is a UUID string
name string Human readable English name
description string
primary_category GameCategory Categorization and tagging
tags string
images GameImageSet Asset references (URLs only for caching)
requirements GameRequirements Deployment constraints
pricing GamePricing Pricing configuration
created_at google.protobuf.Timestamp
deleted_at google.protobuf.Timestamp

Message GameImageSet

gspkit.common.game.v1.GameImageSet

Field Type Description
square string
widescreen string
vertical string
logo string
banner string

Message GamePricing

gspkit.common.game.v1.GamePricing

Field Type Description
price_per_slot double
price_per_mb_memory double

Message GameRequirements

gspkit.common.game.v1.GameRequirements

Field Type Description
min_memory_mb int32
min_slots int32
max_slots int32

Enum GameCategory

gspkit.common.game.v1.GameCategory

Value Number Description
GAME_CATEGORY_UNSPECIFIED 0
GAME_CATEGORY_SANDBOX 1
GAME_CATEGORY_FPS 2
GAME_CATEGORY_STRATEGY 3
GAME_CATEGORY_RPG 4
GAME_CATEGORY_SURVIVAL 5
GAME_CATEGORY_SIMULATION 6
GAME_CATEGORY_ACTION 7
GAME_CATEGORY_ADVENTURE 8
GAME_CATEGORY_HORROR 9

Message GameServer

gspkit.common.gameserver.v1.GameServer

Field Type Description
id string
server_name string
user_id string
game gspkit.common.game.v1.Game
region Region
status ServerStatus
resources_limit ResourceAlloc
resources_usage ResourceAlloc
ip_address string
port int32
slots int32
installed_games InstalledGame
max_installed_games int32
created_at google.protobuf.Timestamp
paid_until google.protobuf.Timestamp

Message InstalledGame

gspkit.common.gameserver.v1.InstalledGame

Field Type Description
game gspkit.common.game.v1.Game
is_active bool

Message ResourceAlloc

gspkit.common.gameserver.v1.ResourceAlloc

Field Type Description
cpu_cores int32
ram_mb int32
disk_mb int32

Enum Region

gspkit.common.gameserver.v1.Region

Value Number Description
REGION_UNSPECIFIED 0
REGION_US_EAST 1
REGION_EU_CENTRAL 2

Enum ServerStatus

gspkit.common.gameserver.v1.ServerStatus

Value Number Description
SERVER_STATUS_UNSPECIFIED 0
SERVER_STATUS_INSTALLING 1
SERVER_STATUS_OFFLINE 2
SERVER_STATUS_STARTING 3
SERVER_STATUS_RUNNING 4
SERVER_STATUS_STOPPING 5
SERVER_STATUS_SUSPENDED 6
SERVER_STATUS_TRANSITIONING 7

Message AddServerUserResponse

gspkit.api.gameserver.v1.AddServerUserResponse

Field Type Description
user ServerUser

Message BackupInfo

gspkit.api.gameserver.v1.BackupInfo

Field Type Description
id string
name string
size_bytes int64
created_at google.protobuf.Timestamp

Message CreateBackupResponse

gspkit.api.gameserver.v1.CreateBackupResponse

Field Type Description
backup BackupInfo

Message CreateDatabaseResponse

gspkit.api.gameserver.v1.CreateDatabaseResponse

Field Type Description
database DatabaseInfo

Message CreateTransactionResponse

gspkit.api.gameserver.v1.CreateTransactionResponse

Field Type Description
transaction_id string
amount double
payment_url string

Message DatabaseInfo

gspkit.api.gameserver.v1.DatabaseInfo

Field Type Description
id string
name string
host string
port int32
user string
password string

Message DeleteBackupResponse

gspkit.api.gameserver.v1.DeleteBackupResponse

Field Type Description

Message DeleteDatabaseResponse

gspkit.api.gameserver.v1.DeleteDatabaseResponse

Field Type Description

Message DeleteFileResponse

gspkit.api.gameserver.v1.DeleteFileResponse

Field Type Description

Message DeleteScheduleResponse

gspkit.api.gameserver.v1.DeleteScheduleResponse

Field Type Description

Message GetDownloadUrlResponse

gspkit.api.gameserver.v1.GetDownloadUrlResponse

Field Type Description
url string
expires_at google.protobuf.Timestamp

Message GetFileContentResponse

gspkit.api.gameserver.v1.GetFileContentResponse

Field Type Description
content string

Message GetGameServerDetailsResponse

gspkit.api.gameserver.v1.GetGameServerDetailsResponse

Field Type Description
server gspkit.common.gameserver.v1.GameServer
sftp_host string Connection info for DB or SFTP
sftp_port int32
sftp_user string

Message GetServerSettingsResponse

gspkit.api.gameserver.v1.GetServerSettingsResponse

Field Type Description
settings gspkit.common.game.v1.Setting

Message GetServerUsageResponse

gspkit.api.gameserver.v1.GetServerUsageResponse

Field Type Description
usage gspkit.common.gameserver.v1.ResourceAlloc
uptime_seconds int64

Message GetUploadUrlResponse

gspkit.api.gameserver.v1.GetUploadUrlResponse

Field Type Description
url string
expires_at google.protobuf.Timestamp

Message InstallGameResponse

gspkit.api.gameserver.v1.InstallGameResponse

Field Type Description
task_id string For tracking background installation progress

Message ListBackupsResponse

gspkit.api.gameserver.v1.ListBackupsResponse

Field Type Description
backups BackupInfo

Message ListDatabasesResponse

gspkit.api.gameserver.v1.ListDatabasesResponse

Field Type Description
databases DatabaseInfo

Message ListFilesResponse

gspkit.api.gameserver.v1.ListFilesResponse

Field Type Description
entries ListFilesResponse.FileEntry

Message FileEntry

gspkit.api.gameserver.v1.ListFilesResponse.FileEntry

Field Type Description
name string
type ListFilesResponse.FileEntry.EntryType
size_bytes int64
modified_at google.protobuf.Timestamp

Message ListGamesResponse

gspkit.api.gameserver.v1.ListGamesResponse

Field Type Description
games gspkit.common.game.v1.Game

Message ListScheduleTemplatesResponse

gspkit.api.gameserver.v1.ListScheduleTemplatesResponse

Field Type Description
templates ScheduleTemplate

Message ListSchedulesResponse

gspkit.api.gameserver.v1.ListSchedulesResponse

Field Type Description
schedules ScheduleInfo

Message ListServerUsersResponse

gspkit.api.gameserver.v1.ListServerUsersResponse

Field Type Description
users ServerUser

Message ListServersResponse

gspkit.api.gameserver.v1.ListServersResponse

Field Type Description
servers gspkit.common.gameserver.v1.GameServer
next_page_token string

Message MoveFileResponse

gspkit.api.gameserver.v1.MoveFileResponse

Field Type Description

Message OrderServerResponse

gspkit.api.gameserver.v1.OrderServerResponse

Field Type Description
server gspkit.common.gameserver.v1.GameServer

Message RemoveServerUserResponse

gspkit.api.gameserver.v1.RemoveServerUserResponse

Field Type Description

Message ResetDatabasePasswordResponse

gspkit.api.gameserver.v1.ResetDatabasePasswordResponse

Field Type Description
new_password string

Message RestoreBackupResponse

gspkit.api.gameserver.v1.RestoreBackupResponse

Field Type Description

Message ScheduleInfo

gspkit.api.gameserver.v1.ScheduleInfo

Field Type Description
id string
name string
cron_expression string
is_active bool
last_run_at google.protobuf.Timestamp
next_run_at google.protobuf.Timestamp
tasks ScheduleTask

Message ScheduleTemplate

gspkit.api.gameserver.v1.ScheduleTemplate

Field Type Description
id string
name string
tasks ScheduleTask

Message SendConsoleCommandResponse

gspkit.api.gameserver.v1.SendConsoleCommandResponse

Field Type Description

Message SendPowerActionResponse

gspkit.api.gameserver.v1.SendPowerActionResponse

Field Type Description

Message ServerUser

gspkit.api.gameserver.v1.ServerUser

Field Type Description
user_id string
username string
permissions string Bitmask as decimal string
added_at google.protobuf.Timestamp

Message SubscribeServerLogsResponse

gspkit.api.gameserver.v1.SubscribeServerLogsResponse

Field Type Description
line string
timestamp google.protobuf.Timestamp

Message SubscribeUsageMetricsResponse

gspkit.api.gameserver.v1.SubscribeUsageMetricsResponse

Field Type Description
usage gspkit.common.gameserver.v1.ResourceAlloc

Message UninstallGameResponse

gspkit.api.gameserver.v1.UninstallGameResponse

Field Type Description

Message UpdateScheduleResponse

gspkit.api.gameserver.v1.UpdateScheduleResponse

Field Type Description
schedule ScheduleInfo

Message UpdateServerSettingsResponse

gspkit.api.gameserver.v1.UpdateServerSettingsResponse

Field Type Description

Message UpdateServerUserPermissionsResponse

gspkit.api.gameserver.v1.UpdateServerUserPermissionsResponse

Field Type Description
user ServerUser

Message WatchTransactionResponse

gspkit.api.gameserver.v1.WatchTransactionResponse

Field Type Description
status WatchTransactionResponse.Status
message string

Message WriteFileResponse

gspkit.api.gameserver.v1.WriteFileResponse

Field Type Description

Enum EntryType

gspkit.api.gameserver.v1.ListFilesResponse.FileEntry.EntryType

Value Number Description
ENTRY_TYPE_UNSPECIFIED 0
ENTRY_TYPE_FILE 1
ENTRY_TYPE_DIRECTORY 2

Enum Status

gspkit.api.gameserver.v1.WatchTransactionResponse.Status

Value Number Description
STATUS_UNSPECIFIED 0
STATUS_PENDING 1
STATUS_CONFIRMED 2
STATUS_FAILED 3

Message SecurityRequirement

gspkit.common.options.v1.SecurityRequirement

Field Type Description
method AuthMethod
scope AuthScope
PermissionFlag int32

Enum AuthMethod

gspkit.common.options.v1.AuthMethod

Value Number Description
AUTH_METHOD_UNSPECIFIED 0
AUTH_METHOD_NONE 1
AUTH_METHOD_JWT 2
AUTH_METHOD_MTLS 3
AUTH_METHOD_BOTH 4

Enum AuthScope

gspkit.common.options.v1.AuthScope

Value Number Description
AUTH_SCOPE_UNSPECIFIED 0 No auth required
AUTH_SCOPE_PUBLIC 1 No auth required
AUTH_SCOPE_AUTHENTICATED 2 User must be logged in
AUTH_SCOPE_ADMIN 3 Internal/Staff only

Service: GameServerService

RPC ListServers

Lists servers owned or granted access to by the authenticated user

RPC GetGameServerDetails

Get more detailed information about the server (status, query info, db/sftp credentials, ...)

RPC SendPowerAction

Start/Stop/Restart/Kill server

RPC GetServerUsage

Get current utilization

RPC GetServerSettings

Get current settings

RPC UpdateServerSettings

Partial patch (changed fields only) that are being written back

RPC SubscribeServerLogs

Live server log for the gameserver

RPC SendConsoleCommand

Send console command to the server

RPC SubscribeUsageMetrics

Subscribe live usage metrics (cpu/memory)

RPC ListFiles

Lists files in dir (type=file/dir, name, size (file only), modified timestamp)

RPC GetFileContent

Gets a file's content (text-based files only)

RPC GetDownloadUrl

Returns a presigned direct download URL for this file (file only, dir does not work)

RPC GetUploadUrl

Returns a presigned direct download URL for this file (file only, dir does not work)

RPC WriteFile

Write file (text-based only or upload as well? not sure if putting bytes here is safe enough)

RPC DeleteFile

Deletes a file / directory

RPC MoveFile

Renames a file / directory

RPC CreateBackup

Creates a backup

RPC ListBackups

Lists all backups

RPC DeleteBackup

Deletes a backup

RPC RestoreBackup

Restores a backup (checkbox for "wipe first"?)

RPC InstallGame

Creates a backup and installs a different / same game

RPC UninstallGame

Deletes an archived game installation from the server

RPC ListDatabases

Lists databases for the server

RPC CreateDatabase

Creates a new database

RPC DeleteDatabase

Deletes a database

RPC ResetDatabasePassword

Resets database password

RPC ListSchedules

Lists scheduled tasks

RPC UpdateSchedule

Creates/Updates a scheduled task

RPC DeleteSchedule

Deletes a scheduled task

RPC ListScheduleTemplates

Lists schedule templates for a server

RPC ListGames

Lists all available games for ordering

RPC OrderServer

Orders a new gameserver instance

RPC CreateTransaction

Create a payment transaction for an order

RPC WatchTransaction

Monitor transaction status

RPC ListServerUsers

Lists all users who have access to this server

RPC AddServerUser

Adds a user to the server by identifier (email, username, or steamid)

RPC UpdateServerUserPermissions

Updates permissions for a user on the server

RPC RemoveServerUser

Removes a user from the server

Service: PaymentService

RPC GetPricing

Get global pricing for slots and memory

RPC CreateTransaction

Create a payment transaction for an order

RPC WatchTransaction

Monitor transaction status

Message CreateTransactionRequest

gspkit.api.payment.v1.CreateTransactionRequest

Field Type Description
game_id string
slots int32
memory_upgrade_mb int32
payment_method string

Message CreateTransactionResponse

gspkit.api.payment.v1.CreateTransactionResponse

Field Type Description
transaction_id string
amount double
payment_url string
steam_order_id string

Message GetPricingRequest

gspkit.api.payment.v1.GetPricingRequest

Field Type Description

Message GetPricingResponse

gspkit.api.payment.v1.GetPricingResponse

Field Type Description
price_per_slot double
price_per_gb_memory double

Message WatchTransactionRequest

gspkit.api.payment.v1.WatchTransactionRequest

Field Type Description
transaction_id string

Message WatchTransactionResponse

gspkit.api.payment.v1.WatchTransactionResponse

Field Type Description
status WatchTransactionResponse.Status
message string

Enum Status

gspkit.api.payment.v1.WatchTransactionResponse.Status

Value Number Description
STATUS_UNSPECIFIED 0
STATUS_PENDING 1
STATUS_CONFIRMED 2
STATUS_FAILED 3

Message AuthenticateSteamRequest

gspkit.api.user.v1.AuthenticateSteamRequest

Field Type Description
ticket string Hex encoded auth session ticket

Message AuthenticateSteamResponse

gspkit.api.user.v1.AuthenticateSteamResponse

Field Type Description
access_token string
refresh_token string
expires_in int32
needs_profile_completion bool True if user needs to complete their profile
suggested_username string Suggested username (from Steam persona name)
steam_profile_url string Steam profile URL
steam_id string Steam ID for profile completion

Message CompleteProfileRequest

gspkit.api.user.v1.CompleteProfileRequest

Field Type Description
steam_ticket string Steam auth ticket (hex encoded)
username string Chosen username
email string Email address
first_name string First name
last_name string Last name

Message CompleteProfileResponse

gspkit.api.user.v1.CompleteProfileResponse

Field Type Description
message string
access_token string Access token for the newly created user
refresh_token string
expires_in int32

Message GetProfileRequest

gspkit.api.user.v1.GetProfileRequest

Field Type Description
user_id string

Message GetProfileResponse

gspkit.api.user.v1.GetProfileResponse

Field Type Description
email string
preferred_region gspkit.common.gameserver.v1.Region

Message GetSteamProfileRequest

gspkit.api.user.v1.GetSteamProfileRequest

Field Type Description
steam_id string

Message GetSteamProfileResponse

gspkit.api.user.v1.GetSteamProfileResponse

Field Type Description
persona_name string
avatar_url string

Enum Permission

gspkit.common.permission.v1.Permission

Value Number Description
PERMISSION_UNSPECIFIED 0
PERMISSION_POWER_READ 1 --- POWER (1-9) --- service:power:read
PERMISSION_POWER_WRITE 2 service:power:write
PERMISSION_CONSOLE_READ 10 --- INTERACTION (10-19) --- service:console:read
PERMISSION_CONSOLE_WRITE 11 service:console:write
PERMISSION_FILES_LIST 20 --- FILES (20-29) --- service:files:list
PERMISSION_FILES_READ 21 service:files:read
PERMISSION_FILES_WRITE 22 service:files:write
PERMISSION_FILES_DELETE 23 service:files:delete
PERMISSION_BACKUP_LIST 30 --- DATA / BACKUPS (30-39) --- service:backup:list
PERMISSION_BACKUP_READ 31 service:backup:read
PERMISSION_BACKUP_WRITE 32 service:backup:write
PERMISSION_BACKUP_DELETE 33 service:backup:delete
PERMISSION_BACKUP_RESTORE 34 service:backup:restore
PERMISSION_SHARE_LIST 40 --- SHARING (40-49) --- service:share:read
PERMISSION_SHARE_READ 41 service:share:write
PERMISSION_SHARE_WRITE 42 service:share:write
PERMISSION_APPLICATION_READ 50 --- APPLICATION (50-59) --- service:application:read
PERMISSION_APPLICATION_WRITE 51 service:application:write
PERMISSION_SETTINGS_READ 60 --- SETTINGS (60-63) --- service:settings:read
PERMISSION_SETTINGS_WRITE 61 service:settings:write
PERMISSION_DATABASE_LIST 70 --- DATABASES (70-79) ---
PERMISSION_DATABASE_READ 72
PERMISSION_DATABASE_WRITE 73
PERMISSION_DATABASE_DELETE 74
PERMISSION_SCHEDULE_LIST 80 --- SCHEDULES (80-89) ---
PERMISSION_SCHEDULE_READ 81
PERMISSION_SCHEDULE_WRITE 82
PERMISSION_SCHEDULE_DELETE 83