Class GameServerApi

GameServerApi - object-oriented interface

Export

GameServerApi

Hierarchy

BaseAPI
- GameServerApi

Index

Constructors

constructor

Properties

axios basePath configuration

Constructors

constructor

new GameServerApi(configuration?, basePath?, axios?): GameServerApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns GameServerApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

gameServerControllerBanPlayer

gameServerControllerBanPlayer(gameServerId, playerId, banPlayerInputDTO?, options?): Promise<AxiosResponse<APIOutput, any>>
Ban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
Parameters
- gameServerId: string
- playerId: string
- OptionalbanPlayerInputDTO: BanPlayerInputDTO
  BanPlayerInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Ban player

Deprecated
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:15869

gameServerControllerCreate

gameServerControllerCreate(gameServerCreateDTO?, options?): Promise<AxiosResponse<GameServerOutputDTOAPI, any>>
Create a gameserver Required permissions: MANAGE_GAMESERVERS
Parameters
- OptionalgameServerCreateDTO: GameServerCreateDTO
  GameServerCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerOutputDTOAPI, any>>
Summary
Create

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:15888

gameServerControllerExecuteCommand

gameServerControllerExecuteCommand(id, commandExecuteInputDTO?, options?): Promise<AxiosResponse<CommandExecuteDTOAPI, any>>
Execute a raw command on a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
Parameters
- id: string
- OptionalcommandExecuteInputDTO: CommandExecuteInputDTO
  CommandExecuteInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandExecuteDTOAPI, any>>
Summary
Execute command

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:15903

gameServerControllerGetImport

gameServerControllerGetImport(id, options?): Promise<AxiosResponse<ImportStatusOutputDTOAPI, any>>
Fetch status of an import from CSMM Required permissions: MANAGE_GAMESERVERS
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ImportStatusOutputDTOAPI, any>>
Summary
Get import

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:15921

gameServerControllerGetInstalledModules

gameServerControllerGetInstalledModules(id, options?): Promise<AxiosResponse<ModuleInstallationOutputArrayDTOAPI, any>>
Get all module installations for a gameserver
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleInstallationOutputArrayDTOAPI, any>>
Summary
Get installed modules

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:15935

gameServerControllerGetModuleInstallation

gameServerControllerGetModuleInstallation(gameServerId, moduleId, options?): Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>
Get a module installation by id
Parameters
- gameServerId: string
- moduleId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>
Summary
Get module installation

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:15950

gameServerControllerGetOne

gameServerControllerGetOne(id, options?): Promise<AxiosResponse<GameServerOutputDTOAPI, any>>
Fetch a gameserver by id
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerOutputDTOAPI, any>>
Summary
Get one

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:15968

gameServerControllerGetPlayers

gameServerControllerGetPlayers(id, options?): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Fetch a list of players on a gameserver. Requires gameserver to be online and reachable. Required permissions: READ_PLAYERS
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Summary
Get players

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:15982

gameServerControllerGetTypes

gameServerControllerGetTypes(options?): Promise<AxiosResponse<GameServerTypesOutputDTOAPI, any>>
Fetch gameserver types (7dtd, Rust, ...)
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerTypesOutputDTOAPI, any>>
Summary
Get types

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:15995

gameServerControllerGiveItem

gameServerControllerGiveItem(gameServerId, playerId, giveItemInputDTO?, options?): Promise<AxiosResponse<void, any>>
Give an item to a player. Requires gameserver to be online and reachable. Depending on the underlying game implementation, it's possible that the item is dropped on the ground instead of placed directly in the player's inventory. Required permissions: MANAGE_GAMESERVERS
Parameters
- gameServerId: string
- playerId: string
- OptionalgiveItemInputDTO: GiveItemInputDTO
  GiveItemInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Give item

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16011

gameServerControllerImportFromCSMM

gameServerControllerImportFromCSMM(options?): Promise<AxiosResponse<ImportOutputDTOAPI, any>>
Import a gameserver from CSMM. Required permissions: MANAGE_GAMESERVERS
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ImportOutputDTOAPI, any>>
Summary
Import from csmm

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16029

gameServerControllerInstallModule

gameServerControllerInstallModule(gameServerId, moduleId, moduleInstallDTO?, options?): Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>
Install a module on a gameserver. If the module is already installed, it will be updated. Required permissions: MANAGE_GAMESERVERS
Parameters
- gameServerId: string
- moduleId: string
- OptionalmoduleInstallDTO: ModuleInstallDTO
  ModuleInstallDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>
Summary
Install module

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16045

gameServerControllerKickPlayer

gameServerControllerKickPlayer(gameServerId, playerId, kickPlayerInputDTO?, options?): Promise<AxiosResponse<APIOutput, any>>
Kick a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
Parameters
- gameServerId: string
- playerId: string
- OptionalkickPlayerInputDTO: KickPlayerInputDTO
  KickPlayerInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Kick player

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16066

gameServerControllerListBans

gameServerControllerListBans(id, options?): Promise<AxiosResponse<BanPlayerOutputDTO, any>>
List bans for a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BanPlayerOutputDTO, any>>
Summary
List bans

Deprecated
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16086

gameServerControllerRemove

gameServerControllerRemove(id, options?): Promise<AxiosResponse<APIOutput, any>>
Delete a gameserver Required permissions: MANAGE_GAMESERVERS
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Remove

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16100

gameServerControllerSearch

gameServerControllerSearch(gameServerSearchInputDTO?, options?): Promise<AxiosResponse<GameServerOutputArrayDTOAPI, any>>
Fetch gameservers
Parameters
- OptionalgameServerSearchInputDTO: GameServerSearchInputDTO
  GameServerSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16114

gameServerControllerSendMessage

gameServerControllerSendMessage(id, messageSendInputDTO?, options?): Promise<AxiosResponse<APIOutput, any>>
Send a message in gameserver chat. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
Parameters
- id: string
- OptionalmessageSendInputDTO: MessageSendInputDTO
  MessageSendInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Send message

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16132

gameServerControllerShutdown

gameServerControllerShutdown(id, options?): Promise<AxiosResponse<void, any>>
Shuts down the gameserver. This is a 'soft' shutdown, meaning the gameserver will be stopped gracefully. If the gameserver is not reachable, this will have no effect. Note that most hosting providers will automatically restart the gameserver after a shutdown, which makes this operation act as a 'restart' instead. Required permissions: MANAGE_GAMESERVERS
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Shutdown

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16150

gameServerControllerTeleportPlayer

gameServerControllerTeleportPlayer(gameServerId, playerId, teleportPlayerInputDTO?, options?): Promise<AxiosResponse<APIOutput, any>>
Teleport a player to a location. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
Parameters
- gameServerId: string
- playerId: string
- OptionalteleportPlayerInputDTO: TeleportPlayerInputDTO
  TeleportPlayerInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Teleport player

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16166

gameServerControllerTestReachability

gameServerControllerTestReachability(gameServerTestReachabilityInputDTO?, options?): Promise<AxiosResponse<GameServerTestReachabilityDTOAPI, any>>
Test if Takaro can connect to a gameserver. Will do a thorough check and report details.
Parameters
- OptionalgameServerTestReachabilityInputDTO: GameServerTestReachabilityInputDTO
  GameServerTestReachabilityInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerTestReachabilityDTOAPI, any>>
Summary
Test reachability

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16185

gameServerControllerTestReachabilityForId

gameServerControllerTestReachabilityForId(id, options?): Promise<AxiosResponse<GameServerTestReachabilityDTOAPI, any>>
Test if Takaro can connect to a gameserver. Will do a thorough check and report details.
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerTestReachabilityDTOAPI, any>>
Summary
Test reachability for id

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16202

gameServerControllerUnbanPlayer

gameServerControllerUnbanPlayer(gameServerId, playerId, options?): Promise<AxiosResponse<APIOutput, any>>
Unban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
Parameters
- gameServerId: string
- playerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Unban player

Deprecated
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16218

gameServerControllerUninstallModule

gameServerControllerUninstallModule(gameServerId, moduleId, options?): Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>
Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: MANAGE_GAMESERVERS
Parameters
- gameServerId: string
- moduleId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>
Summary
Uninstall module

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16233

gameServerControllerUpdate

gameServerControllerUpdate(id, gameServerUpdateDTO?, options?): Promise<AxiosResponse<GameServerOutputDTOAPI, any>>
Update a gameserver Required permissions: MANAGE_GAMESERVERS
Parameters
- id: string
- OptionalgameServerUpdateDTO: GameServerUpdateDTO
  GameServerUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerOutputDTOAPI, any>>
Summary
Update

Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16248

Class GameServerApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GameServerApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

gameServerControllerBanPlayer

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Deprecated

Throws

Memberof

gameServerControllerCreate

Parameters

Returns Promise<AxiosResponse<GameServerOutputDTOAPI, any>>

Summary

Throws

Memberof

gameServerControllerExecuteCommand

Parameters

Returns Promise<AxiosResponse<CommandExecuteDTOAPI, any>>

Summary

Throws

Memberof

gameServerControllerGetImport

Parameters

Returns Promise<AxiosResponse<ImportStatusOutputDTOAPI, any>>

Summary

Throws

Memberof

gameServerControllerGetInstalledModules

Parameters

Returns Promise<AxiosResponse<ModuleInstallationOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

gameServerControllerGetModuleInstallation

Parameters

Returns Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>

Summary

Throws

Memberof

gameServerControllerGetOne

Parameters

Returns Promise<AxiosResponse<GameServerOutputDTOAPI, any>>

Summary

Throws

Memberof

gameServerControllerGetPlayers

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>

Summary

Throws

Memberof

gameServerControllerGetTypes

Parameters

Returns Promise<AxiosResponse<GameServerTypesOutputDTOAPI, any>>

Summary

Throws

Memberof

gameServerControllerGiveItem

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

gameServerControllerImportFromCSMM

Parameters

Returns Promise<AxiosResponse<ImportOutputDTOAPI, any>>

`Protected`axios

`Protected`basePath

`Protected`configuration