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<JobStatusOutputDTOAPI>;
    gameServerControllerGetJob(
        type: string,
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<JobStatusOutputDTOAPI>;
    gameServerControllerGetMapInfo(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<MapInfoOutputDTOAPI>;
    gameServerControllerGetMapTile(
        id: string,
        x: string,
        y: string,
        z: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    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>;
    gameServerControllerKickPlayer(
        gameServerId: string,
        playerId: string,
        kickPlayerInputDTO?: KickPlayerInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>;
    gameServerControllerListBans(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BanPlayerOutputDTO>;
    gameServerControllerRegenerateRegistrationToken(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>;
    gameServerControllerRemove(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>;
    gameServerControllerResetCurrency(
        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>;
    gameServerControllerTriggerJob(
        type: string,
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<JobStatusOutputDTOAPI>;
    gameServerControllerUnbanPlayer(
        gameServerId: string,
        playerId: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>;
    gameServerControllerUpdate(
        id: string,
        gameServerUpdateDTO?: GameServerUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GameServerOutputDTOAPI>;
}

• gameServerControllerBanPlayer: function

  • gameServerControllerBanPlayer(
        gameServerId: string,
        playerId: string,
        banPlayerInputDTO?: BanPlayerInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<APIOutput>

    Deprecated

    Throws

• gameServerControllerCreate: function

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

    Create a gameserver Required permissions: MANAGE_GAMESERVERS
    OperationId: GameServerControllerCreate

    Parameters

    • OptionalgameServerCreateDTO: GameServerCreateDTO

      GameServerCreateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GameServerOutputDTOAPI>

    Throws

• gameServerControllerExecuteCommand: function

  • gameServerControllerExecuteCommand(
        id: string,
        commandExecuteInputDTO?: CommandExecuteInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<CommandExecuteDTOAPI>

    Throws

• gameServerControllerGetImport: function

  • gameServerControllerGetImport(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<JobStatusOutputDTOAPI>

    Fetch status of an import from CSMM Required permissions: MANAGE_GAMESERVERS
    OperationId: GameServerControllerGetImport

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<JobStatusOutputDTOAPI>

    Deprecated

    Throws

• gameServerControllerGetJob: function

  • gameServerControllerGetJob(
        type: string,
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<JobStatusOutputDTOAPI>

    Fetch a job status Required permissions: MANAGE_GAMESERVERS
    OperationId: GameServerControllerGetJob

    Parameters

    • type: string
    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<JobStatusOutputDTOAPI>

    Throws

• gameServerControllerGetMapInfo: function

  • gameServerControllerGetMapInfo(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<MapInfoOutputDTOAPI>

    Get map metadata
    OperationId: GameServerControllerGetMapInfo

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<MapInfoOutputDTOAPI>

    Throws

• gameServerControllerGetMapTile: function

  • gameServerControllerGetMapTile(
        id: string,
        x: string,
        y: string,
        z: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Get a map tile
    OperationId: GameServerControllerGetMapTile

    Parameters

    • id: string
    • x: string
    • y: string
    • z: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• gameServerControllerGetOne: function

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

    Fetch a gameserver by id
    OperationId: GameServerControllerGetOne

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GameServerOutputDTOAPI>

    Throws

• gameServerControllerGetPlayers: function

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

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

    Deprecated

    Throws

• gameServerControllerGetTypes: function

  • gameServerControllerGetTypes(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GameServerTypesOutputDTOAPI>

    Fetch gameserver types (7dtd, Rust, ...)
    OperationId: GameServerControllerGetTypes

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GameServerTypesOutputDTOAPI>

    Throws

• gameServerControllerGiveItem: function

  • gameServerControllerGiveItem(
        gameServerId: string,
        playerId: string,
        giveItemInputDTO?: GiveItemInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

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

    Throws

• gameServerControllerImportFromCSMM: function

  • gameServerControllerImportFromCSMM(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ImportOutputDTOAPI>

    Import a gameserver from CSMM. Required permissions: MANAGE_GAMESERVERS
    OperationId: GameServerControllerImportFromCSMM

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ImportOutputDTOAPI>

    Throws

• gameServerControllerKickPlayer: function

  • gameServerControllerKickPlayer(
        gameServerId: string,
        playerId: string,
        kickPlayerInputDTO?: KickPlayerInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<APIOutput>

    Throws

• gameServerControllerListBans: function

  • gameServerControllerListBans(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<BanPlayerOutputDTO>

    Deprecated

    Throws

• gameServerControllerRegenerateRegistrationToken: function

  • gameServerControllerRegenerateRegistrationToken(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>

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

    Throws

• gameServerControllerRemove: function

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

    Delete a gameserver Required permissions: MANAGE_GAMESERVERS
    OperationId: GameServerControllerRemove

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• gameServerControllerResetCurrency: function

  • gameServerControllerResetCurrency(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>

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

    Throws

• gameServerControllerSearch: function

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

    Fetch gameservers
    OperationId: GameServerControllerSearch

    Parameters

    • OptionalgameServerSearchInputDTO: GameServerSearchInputDTO

      GameServerSearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GameServerOutputArrayDTOAPI>

    Throws

• gameServerControllerSendMessage: function

  • gameServerControllerSendMessage(
        id: string,
        messageSendInputDTO?: MessageSendInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<APIOutput>

    Throws

• gameServerControllerShutdown: function

  • gameServerControllerShutdown(
        id: string,
        options?: RawAxiosRequestConfig,
    ): 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
    OperationId: GameServerControllerShutdown

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• gameServerControllerTeleportPlayer: function

  • gameServerControllerTeleportPlayer(
        gameServerId: string,
        playerId: string,
        teleportPlayerInputDTO?: TeleportPlayerInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<APIOutput>

    Throws

• gameServerControllerTestReachability: function

  • gameServerControllerTestReachability(
        gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<GameServerTestReachabilityDTOAPI>

    Throws

• gameServerControllerTestReachabilityForId: function

  • gameServerControllerTestReachabilityForId(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<GameServerTestReachabilityDTOAPI>

    Throws

• gameServerControllerTriggerJob: function

  • gameServerControllerTriggerJob(
        type: string,
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<JobStatusOutputDTOAPI>

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

    Throws

• gameServerControllerUnbanPlayer: function

  • gameServerControllerUnbanPlayer(
        gameServerId: string,
        playerId: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<APIOutput>

    Deprecated

    Throws

• gameServerControllerUpdate: function

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

    Update a gameserver Required permissions: MANAGE_GAMESERVERS
    OperationId: GameServerControllerUpdate

    Parameters

    • id: string
    • OptionalgameServerUpdateDTO: GameServerUpdateDTO

      GameServerUpdateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GameServerOutputDTOAPI>

    Throws