Class GameServerApi

GameServerApi - object-oriented interface

Export

GameServerApi

Hierarchy

BaseAPI
- GameServerApi

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, any>>
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, any>>
Deprecated
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16746

gameServerControllerCreate

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

gameServerControllerExecuteCommand

gameServerControllerExecuteCommand(
    id: string,
    commandExecuteInputDTO?: CommandExecuteInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CommandExecuteDTOAPI, any>>
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, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16780

gameServerControllerGetImport

gameServerControllerGetImport(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ImportStatusOutputDTOAPI, any>>
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, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16798

gameServerControllerGetMapInfo

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

gameServerControllerGetMapTile

gameServerControllerGetMapTile(
    id: string,
    x: string,
    y: string,
    z: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
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, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16829

gameServerControllerGetOne

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

gameServerControllerGetPlayers

gameServerControllerGetPlayers(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
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, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16857

gameServerControllerGetTypes

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

gameServerControllerGiveItem

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

gameServerControllerImportFromCSMM

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

gameServerControllerKickPlayer

gameServerControllerKickPlayer(
    gameServerId: string,
    playerId: string,
    kickPlayerInputDTO?: KickPlayerInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput, any>>
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, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16920

gameServerControllerListBans

gameServerControllerListBans(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BanPlayerOutputDTO, any>>
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, any>>
Deprecated
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16940

gameServerControllerRemove

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

gameServerControllerSearch

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

gameServerControllerSendMessage

gameServerControllerSendMessage(
    id: string,
    messageSendInputDTO?: MessageSendInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput, any>>
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, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:16986

gameServerControllerShutdown

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

gameServerControllerTeleportPlayer

gameServerControllerTeleportPlayer(
    gameServerId: string,
    playerId: string,
    teleportPlayerInputDTO?: TeleportPlayerInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput, any>>
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, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:17020

gameServerControllerTestReachability

gameServerControllerTestReachability(
gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GameServerTestReachabilityDTOAPI, any>>
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, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:17039

gameServerControllerTestReachabilityForId

gameServerControllerTestReachabilityForId(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GameServerTestReachabilityDTOAPI, any>>
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, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:17056

gameServerControllerUnbanPlayer

gameServerControllerUnbanPlayer(
    gameServerId: string,
    playerId: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput, any>>
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, any>>
Deprecated
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:17072

gameServerControllerUpdate

gameServerControllerUpdate(
    id: string,
    gameServerUpdateDTO?: GameServerUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GameServerOutputDTOAPI, any>>
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, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:17087

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>>

Deprecated

Throws

Memberof

gameServerControllerCreate

Parameters

Returns Promise<AxiosResponse<GameServerOutputDTOAPI, any>>

Throws

Memberof

gameServerControllerExecuteCommand

Parameters

Returns Promise<AxiosResponse<CommandExecuteDTOAPI, any>>

Throws

Memberof

gameServerControllerGetImport

Parameters

Returns Promise<AxiosResponse<ImportStatusOutputDTOAPI, any>>

Throws

Memberof

gameServerControllerGetMapInfo

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

gameServerControllerGetMapTile

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

gameServerControllerGetOne

Parameters

Returns Promise<AxiosResponse<GameServerOutputDTOAPI, any>>

Throws

Memberof

gameServerControllerGetPlayers

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>

Throws

Memberof

gameServerControllerGetTypes

Parameters

Returns Promise<AxiosResponse<GameServerTypesOutputDTOAPI, any>>

Throws

Memberof

gameServerControllerGiveItem

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

gameServerControllerImportFromCSMM

Parameters

Returns Promise<AxiosResponse<ImportOutputDTOAPI, any>>

Throws

Memberof

gameServerControllerKickPlayer

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Throws

Memberof

gameServerControllerListBans

Parameters

Returns Promise<AxiosResponse<BanPlayerOutputDTO, any>>

`Protected`axios

`Protected`basePath

`Protected`configuration