Class GameServerApi

GameServerApi - object-oriented interface

Export

GameServerApi

Hierarchy

BaseAPI
- GameServerApi

Index

Constructors

constructor

Properties

axios basePath configuration

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: Configuration | undefined

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

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

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

gameServerControllerGetImport

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

gameServerControllerGetJob

gameServerControllerGetJob(
    type: string,
    id: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<JobStatusOutputDTOAPI, any>>
Fetch a job status Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerGetJob
Parameters
- type: string
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<JobStatusOutputDTOAPI, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:21792

gameServerControllerGetMapInfo

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

gameServerControllerGetMapTile

gameServerControllerGetMapTile(
    id: string,
    x: string,
    y: string,
    z: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Get a map tile
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:21823

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

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. Please use the Player on GameServer (PoG) search endpoint instead: POST /gameserver/player/search for more flexible filtering, sorting, and pagination options. Required permissions: READ_PLAYERS
OperationId: GameServerControllerGetPlayers
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Deprecated
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:21852

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

gameServerControllerGiveItem

gameServerControllerGiveItem(
    gameServerId: string,
    playerId: string,
    giveItemInputDTO?: GiveItemInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Give an item to a player. Accepts item UUID (preferred) or item code. 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:21881

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

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

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

gameServerControllerRegenerateRegistrationToken

gameServerControllerRegenerateRegistrationToken(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput, any>>
Regenerate the registration token for a gameserver. Careful, this will invalidate all existing connections. Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerRegenerateRegistrationToken
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:21948

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

gameServerControllerResetCurrency

gameServerControllerResetCurrency(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput, any>>
Resets all players' currency to 0 on the specified game server. This action is irreversible. Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerResetCurrency
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:21976

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

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

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

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

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

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

gameServerControllerTriggerJob

gameServerControllerTriggerJob(
    type: string,
    id: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<JobStatusOutputDTOAPI, any>>
Manually trigger a job, you can poll the status with the GET endpoint Required permissions: MANAGE_GAMESERVERS
OperationId: GameServerControllerTriggerJob
Parameters
- type: string
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<JobStatusOutputDTOAPI, any>>
Throws
Memberof
GameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22093

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

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

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<JobStatusOutputDTOAPI, any>>

Deprecated

Throws

Memberof

gameServerControllerGetJob

Parameters

Returns Promise<AxiosResponse<JobStatusOutputDTOAPI, any>>

Throws

Memberof

gameServerControllerGetMapInfo

Parameters

Returns Promise<AxiosResponse<MapInfoOutputDTOAPI, 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>>

Deprecated

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

`Protected`axios

`Protected`basePath

`Protected`configuration