Function GameServerApiFactory

Returns {
    gameServerControllerBanPlayer(gameServerId: string, playerId: string, banPlayerInputDTO?: BanPlayerInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    gameServerControllerCreate(gameServerCreateDTO?: GameServerCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<GameServerOutputDTOAPI>;
    gameServerControllerExecuteCommand(id: string, commandExecuteInputDTO?: CommandExecuteInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<CommandExecuteDTOAPI>;
    gameServerControllerGetImport(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ImportStatusOutputDTOAPI>;
    gameServerControllerGetInstalledModules(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ModuleInstallationOutputArrayDTOAPI>;
    gameServerControllerGetModuleInstallation(gameServerId: string, moduleId: string, options?: RawAxiosRequestConfig): AxiosPromise<ModuleInstallationOutputDTOAPI>;
    gameServerControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GameServerOutputDTOAPI>;
    gameServerControllerGetPlayers(id: string, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
    gameServerControllerGetTypes(options?: RawAxiosRequestConfig): AxiosPromise<GameServerTypesOutputDTOAPI>;
    gameServerControllerGiveItem(gameServerId: string, playerId: string, giveItemInputDTO?: GiveItemInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    gameServerControllerImportFromCSMM(options?: RawAxiosRequestConfig): AxiosPromise<ImportOutputDTOAPI>;
    gameServerControllerInstallModule(gameServerId: string, moduleId: string, moduleInstallDTO?: ModuleInstallDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleInstallationOutputDTOAPI>;
    gameServerControllerKickPlayer(gameServerId: string, playerId: string, kickPlayerInputDTO?: KickPlayerInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    gameServerControllerListBans(id: string, options?: RawAxiosRequestConfig): AxiosPromise<BanPlayerOutputDTO>;
    gameServerControllerRemove(id: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    gameServerControllerSearch(gameServerSearchInputDTO?: GameServerSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<GameServerOutputArrayDTOAPI>;
    gameServerControllerSendMessage(id: string, messageSendInputDTO?: MessageSendInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    gameServerControllerShutdown(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    gameServerControllerTeleportPlayer(gameServerId: string, playerId: string, teleportPlayerInputDTO?: TeleportPlayerInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    gameServerControllerTestReachability(gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<GameServerTestReachabilityDTOAPI>;
    gameServerControllerTestReachabilityForId(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GameServerTestReachabilityDTOAPI>;
    gameServerControllerUnbanPlayer(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    gameServerControllerUninstallModule(gameServerId: string, moduleId: string, options?: RawAxiosRequestConfig): AxiosPromise<ModuleInstallationOutputDTOAPI>;
    gameServerControllerUpdate(id: string, gameServerUpdateDTO?: GameServerUpdateDTO, options?: RawAxiosRequestConfig): AxiosPromise<GameServerOutputDTOAPI>;
}

• gameServerControllerBanPlayer:function

  • gameServerControllerBanPlayer(gameServerId, playerId, banPlayerInputDTO?, options?): AxiosPromise<APIOutput>

  • 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 AxiosPromise<APIOutput>

    Summary

    Ban player

    Deprecated

    Throws

• gameServerControllerCreate:function

  • gameServerControllerCreate(gameServerCreateDTO?, options?): AxiosPromise<GameServerOutputDTOAPI>

  • Create a gameserver Required permissions: MANAGE_GAMESERVERS

    Parameters

    • OptionalgameServerCreateDTO: GameServerCreateDTO

      GameServerCreateDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GameServerOutputDTOAPI>

    Summary

    Create

    Throws

• gameServerControllerExecuteCommand:function

  • gameServerControllerExecuteCommand(id, commandExecuteInputDTO?, options?): AxiosPromise<CommandExecuteDTOAPI>

  • 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 AxiosPromise<CommandExecuteDTOAPI>

    Summary

    Execute command

    Throws

• gameServerControllerGetImport:function

  • gameServerControllerGetImport(id, options?): AxiosPromise<ImportStatusOutputDTOAPI>

  • Fetch status of an import from CSMM Required permissions: MANAGE_GAMESERVERS

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ImportStatusOutputDTOAPI>

    Summary

    Get import

    Throws

• gameServerControllerGetInstalledModules:function

  • gameServerControllerGetInstalledModules(id, options?): AxiosPromise<ModuleInstallationOutputArrayDTOAPI>

  • Get all module installations for a gameserver

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ModuleInstallationOutputArrayDTOAPI>

    Summary

    Get installed modules

    Throws

• gameServerControllerGetModuleInstallation:function

  • gameServerControllerGetModuleInstallation(gameServerId, moduleId, options?): AxiosPromise<ModuleInstallationOutputDTOAPI>

  • Get a module installation by id

    Parameters

    • gameServerId: string
    • moduleId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ModuleInstallationOutputDTOAPI>

    Summary

    Get module installation

    Throws

• gameServerControllerGetOne:function

  • gameServerControllerGetOne(id, options?): AxiosPromise<GameServerOutputDTOAPI>

  • Fetch a gameserver by id

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GameServerOutputDTOAPI>

    Summary

    Get one

    Throws

• gameServerControllerGetPlayers:function

  • gameServerControllerGetPlayers(id, options?): AxiosPromise<PlayerOnGameserverOutputDTOAPI>

  • 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 AxiosPromise<PlayerOnGameserverOutputDTOAPI>

    Summary

    Get players

    Throws

• gameServerControllerGetTypes:function

  • gameServerControllerGetTypes(options?): AxiosPromise<GameServerTypesOutputDTOAPI>

  • Fetch gameserver types (7dtd, Rust, ...)

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GameServerTypesOutputDTOAPI>

    Summary

    Get types

    Throws

• gameServerControllerGiveItem:function

  • gameServerControllerGiveItem(gameServerId, playerId, giveItemInputDTO?, options?): AxiosPromise<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

    Parameters

    • gameServerId: string
    • playerId: string
    • OptionalgiveItemInputDTO: GiveItemInputDTO

      GiveItemInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Give item

    Throws

• gameServerControllerImportFromCSMM:function

  • gameServerControllerImportFromCSMM(options?): AxiosPromise<ImportOutputDTOAPI>

  • Import a gameserver from CSMM. Required permissions: MANAGE_GAMESERVERS

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ImportOutputDTOAPI>

    Summary

    Import from csmm

    Throws

• gameServerControllerInstallModule:function

  • gameServerControllerInstallModule(gameServerId, moduleId, moduleInstallDTO?, options?): AxiosPromise<ModuleInstallationOutputDTOAPI>

  • 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 AxiosPromise<ModuleInstallationOutputDTOAPI>

    Summary

    Install module

    Throws

• gameServerControllerKickPlayer:function

  • gameServerControllerKickPlayer(gameServerId, playerId, kickPlayerInputDTO?, options?): AxiosPromise<APIOutput>

  • 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 AxiosPromise<APIOutput>

    Summary

    Kick player

    Throws

• gameServerControllerListBans:function

  • gameServerControllerListBans(id, options?): AxiosPromise<BanPlayerOutputDTO>

  • 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 AxiosPromise<BanPlayerOutputDTO>

    Summary

    List bans

    Deprecated

    Throws

• gameServerControllerRemove:function

  • gameServerControllerRemove(id, options?): AxiosPromise<APIOutput>

  • Delete a gameserver Required permissions: MANAGE_GAMESERVERS

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Summary

    Remove

    Throws

• gameServerControllerSearch:function

  • gameServerControllerSearch(gameServerSearchInputDTO?, options?): AxiosPromise<GameServerOutputArrayDTOAPI>

  • Fetch gameservers

    Parameters

    • OptionalgameServerSearchInputDTO: GameServerSearchInputDTO

      GameServerSearchInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GameServerOutputArrayDTOAPI>

    Summary

    Search

    Throws

• gameServerControllerSendMessage:function

  • gameServerControllerSendMessage(id, messageSendInputDTO?, options?): AxiosPromise<APIOutput>

  • 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 AxiosPromise<APIOutput>

    Summary

    Send message

    Throws

• gameServerControllerShutdown:function

  • gameServerControllerShutdown(id, options?): AxiosPromise<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

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Shutdown

    Throws

• gameServerControllerTeleportPlayer:function

  • gameServerControllerTeleportPlayer(gameServerId, playerId, teleportPlayerInputDTO?, options?): AxiosPromise<APIOutput>

  • 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 AxiosPromise<APIOutput>

    Summary

    Teleport player

    Throws

• gameServerControllerTestReachability:function

  • gameServerControllerTestReachability(gameServerTestReachabilityInputDTO?, options?): AxiosPromise<GameServerTestReachabilityDTOAPI>

  • 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 AxiosPromise<GameServerTestReachabilityDTOAPI>

    Summary

    Test reachability

    Throws

• gameServerControllerTestReachabilityForId:function

  • gameServerControllerTestReachabilityForId(id, options?): AxiosPromise<GameServerTestReachabilityDTOAPI>

  • 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 AxiosPromise<GameServerTestReachabilityDTOAPI>

    Summary

    Test reachability for id

    Throws

• gameServerControllerUnbanPlayer:function

  • gameServerControllerUnbanPlayer(gameServerId, playerId, options?): AxiosPromise<APIOutput>

  • 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 AxiosPromise<APIOutput>

    Summary

    Unban player

    Deprecated

    Throws

• gameServerControllerUninstallModule:function

  • gameServerControllerUninstallModule(gameServerId, moduleId, options?): AxiosPromise<ModuleInstallationOutputDTOAPI>

  • 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 AxiosPromise<ModuleInstallationOutputDTOAPI>

    Summary

    Uninstall module

    Throws

• gameServerControllerUpdate:function

  • gameServerControllerUpdate(id, gameServerUpdateDTO?, options?): AxiosPromise<GameServerOutputDTOAPI>

  • Update a gameserver Required permissions: MANAGE_GAMESERVERS

    Parameters

    • id: string
    • OptionalgameServerUpdateDTO: GameServerUpdateDTO

      GameServerUpdateDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GameServerOutputDTOAPI>

    Summary

    Update

    Throws