Class GameServerApi

GameServerApi - object-oriented interface

Export

GameServerApi

Hierarchy

BaseAPI
- GameServerApi

Index

Constructors

constructor

Properties

axios basePath configuration

Methods

Constructors

constructor

new GameServerApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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: string,
    playerId: string,
    banPlayerInputDTO?: BanPlayerInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Ban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerBanPlayer
Parameters
- gameServerId: string
- playerId: string
- OptionalbanPlayerInputDTO: BanPlayerInputDTO
  BanPlayerInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Deprecated
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16189

gameServerControllerCreate

gameServerControllerCreate(
gameServerCreateDTO?: GameServerCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GameServerOutputDTOAPI>>
Create a gameserver Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerCreate
Parameters
- OptionalgameServerCreateDTO: GameServerCreateDTO
  GameServerCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerOutputDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16208

gameServerControllerExecuteCommand

gameServerControllerExecuteCommand(
    id: string,
    commandExecuteInputDTO?: CommandExecuteInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CommandExecuteDTOAPI>>
Execute a raw command on a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerExecuteCommand
Parameters
- id: string
- OptionalcommandExecuteInputDTO: CommandExecuteInputDTO
  CommandExecuteInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandExecuteDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16223

gameServerControllerGetImport

gameServerControllerGetImport(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ImportStatusOutputDTOAPI>>
Fetch status of an import from CSMM Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerGetImport
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ImportStatusOutputDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16241

gameServerControllerGetInstalledModules

gameServerControllerGetInstalledModules(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleInstallationOutputArrayDTOAPI>>
Get all module installations for a gameserver
OperationId: GameServerControllerGetInstalledModules
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleInstallationOutputArrayDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16255

gameServerControllerGetMapInfo

gameServerControllerGetMapInfo(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Get map metadata for Leaflet
OperationId: GameServerControllerGetMapInfo
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16269

gameServerControllerGetMapTile

gameServerControllerGetMapTile(
    id: string,
    x: string,
    y: string,
    z: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Get a map tile for Leaflet
OperationId: GameServerControllerGetMapTile
Parameters
- id: string
- x: string
- y: string
- z: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16286

gameServerControllerGetModuleInstallation

gameServerControllerGetModuleInstallation(
    gameServerId: string,
    moduleId: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleInstallationOutputDTOAPI>>
Get a module installation by id
OperationId: GameServerControllerGetModuleInstallation
Parameters
- gameServerId: string
- moduleId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleInstallationOutputDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16301

gameServerControllerGetOne

gameServerControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GameServerOutputDTOAPI>>
Fetch a gameserver by id
OperationId: GameServerControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerOutputDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16319

gameServerControllerGetPlayers

gameServerControllerGetPlayers(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI>>
Fetch a list of players on a gameserver. Requires gameserver to be online and reachable. Required permissions: READ_PLAYERS
OperationId: GameServerControllerGetPlayers
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16333

gameServerControllerGetTypes

gameServerControllerGetTypes(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GameServerTypesOutputDTOAPI>>
Fetch gameserver types (7dtd, Rust, ...)
OperationId: GameServerControllerGetTypes
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerTypesOutputDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16346

gameServerControllerGiveItem

gameServerControllerGiveItem(
    gameServerId: string,
    playerId: string,
    giveItemInputDTO?: GiveItemInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
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
OperationId: GameServerControllerGiveItem
Parameters
- gameServerId: string
- playerId: string
- OptionalgiveItemInputDTO: GiveItemInputDTO
  GiveItemInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16362

gameServerControllerImportFromCSMM

gameServerControllerImportFromCSMM(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ImportOutputDTOAPI>>
Import a gameserver from CSMM. Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerImportFromCSMM
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ImportOutputDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16380

gameServerControllerInstallModule

gameServerControllerInstallModule(
    gameServerId: string,
    moduleId: string,
    moduleInstallDTO?: ModuleInstallDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleInstallationOutputDTOAPI>>
Install a module on a gameserver. If the module is already installed, it will be updated. Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerInstallModule
Parameters
- gameServerId: string
- moduleId: string
- OptionalmoduleInstallDTO: ModuleInstallDTO
  ModuleInstallDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleInstallationOutputDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16396

gameServerControllerKickPlayer

gameServerControllerKickPlayer(
    gameServerId: string,
    playerId: string,
    kickPlayerInputDTO?: KickPlayerInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Kick a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerKickPlayer
Parameters
- gameServerId: string
- playerId: string
- OptionalkickPlayerInputDTO: KickPlayerInputDTO
  KickPlayerInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16417

gameServerControllerListBans

gameServerControllerListBans(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BanPlayerOutputDTO>>
List bans for a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerListBans
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BanPlayerOutputDTO>>
Deprecated
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16437

gameServerControllerRemove

gameServerControllerRemove(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Delete a gameserver Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerRemove
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16451

gameServerControllerSearch

gameServerControllerSearch(
gameServerSearchInputDTO?: GameServerSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GameServerOutputArrayDTOAPI>>
Fetch gameservers
OperationId: GameServerControllerSearch
Parameters
- OptionalgameServerSearchInputDTO: GameServerSearchInputDTO
  GameServerSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerOutputArrayDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16465

gameServerControllerSendMessage

gameServerControllerSendMessage(
    id: string,
    messageSendInputDTO?: MessageSendInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Send a message in gameserver chat. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerSendMessage
Parameters
- id: string
- OptionalmessageSendInputDTO: MessageSendInputDTO
  MessageSendInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16483

gameServerControllerShutdown

gameServerControllerShutdown(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
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
OperationId: GameServerControllerShutdown
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16501

gameServerControllerTeleportPlayer

gameServerControllerTeleportPlayer(
    gameServerId: string,
    playerId: string,
    teleportPlayerInputDTO?: TeleportPlayerInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Teleport a player to a location. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerTeleportPlayer
Parameters
- gameServerId: string
- playerId: string
- OptionalteleportPlayerInputDTO: TeleportPlayerInputDTO
  TeleportPlayerInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16517

gameServerControllerTestReachability

gameServerControllerTestReachability(
gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GameServerTestReachabilityDTOAPI>>
Test if Takaro can connect to a gameserver. Will do a thorough check and report details.
OperationId: GameServerControllerTestReachability
Parameters
- OptionalgameServerTestReachabilityInputDTO: GameServerTestReachabilityInputDTO
  GameServerTestReachabilityInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerTestReachabilityDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16536

gameServerControllerTestReachabilityForId

gameServerControllerTestReachabilityForId(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GameServerTestReachabilityDTOAPI>>
Test if Takaro can connect to a gameserver. Will do a thorough check and report details.
OperationId: GameServerControllerTestReachabilityForId
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerTestReachabilityDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16553

gameServerControllerUnbanPlayer

gameServerControllerUnbanPlayer(
    gameServerId: string,
    playerId: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Unban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerUnbanPlayer
Parameters
- gameServerId: string
- playerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Deprecated
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16569

gameServerControllerUninstallModule

gameServerControllerUninstallModule(
    gameServerId: string,
    moduleId: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleInstallationOutputDTOAPI>>
Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerUninstallModule
Parameters
- gameServerId: string
- moduleId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleInstallationOutputDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16584

gameServerControllerUpdate

gameServerControllerUpdate(
    id: string,
    gameServerUpdateDTO?: GameServerUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GameServerOutputDTOAPI>>
Update a gameserver Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerUpdate
Parameters
- id: string
- OptionalgameServerUpdateDTO: GameServerUpdateDTO
  GameServerUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GameServerOutputDTOAPI>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16599

Class GameServerApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GameServerApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

gameServerControllerBanPlayer

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Deprecated

Throws

Memberof

gameServerControllerCreate

Parameters

Returns Promise<AxiosResponse<GameServerOutputDTOAPI>>

Throws

Memberof

gameServerControllerExecuteCommand

Parameters

Returns Promise<AxiosResponse<CommandExecuteDTOAPI>>

Throws

Memberof

gameServerControllerGetImport

Parameters

Returns Promise<AxiosResponse<ImportStatusOutputDTOAPI>>

Throws

Memberof

gameServerControllerGetInstalledModules

Parameters

Returns Promise<AxiosResponse<ModuleInstallationOutputArrayDTOAPI>>

Throws

Memberof

gameServerControllerGetMapInfo

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

gameServerControllerGetMapTile

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

gameServerControllerGetModuleInstallation

Parameters

Returns Promise<AxiosResponse<ModuleInstallationOutputDTOAPI>>

Throws

Memberof

gameServerControllerGetOne

Parameters

Returns Promise<AxiosResponse<GameServerOutputDTOAPI>>

Throws

Memberof

gameServerControllerGetPlayers

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI>>

Throws

Memberof

gameServerControllerGetTypes

Parameters

Returns Promise<AxiosResponse<GameServerTypesOutputDTOAPI>>

Throws

Memberof

gameServerControllerGiveItem

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

gameServerControllerImportFromCSMM

Parameters

Returns Promise<AxiosResponse<ImportOutputDTOAPI>>

`Protected`axios

`Protected`basePath

`Protected`configuration