Takaro - v0.4.9
    Preparing search index...

    Function GameServerApiAxiosParamCreator

    • GameServerApi - axios parameter creator

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          gameServerControllerBanPlayer: (
              gameServerId: string,
              playerId: string,
              banPlayerInputDTO?: BanPlayerInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerCreate: (
              gameServerCreateDTO?: GameServerCreateDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerExecuteCommand: (
              id: string,
              commandExecuteInputDTO?: CommandExecuteInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerGetImport: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerGetJob: (
              type: string,
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerGetMapInfo: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerGetMapTile: (
              id: string,
              x: string,
              y: string,
              z: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerGetOne: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerGetPlayers: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerGetTypes: (
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerGiveItem: (
              gameServerId: string,
              playerId: string,
              giveItemInputDTO?: GiveItemInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerImportFromCSMM: (
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerKickPlayer: (
              gameServerId: string,
              playerId: string,
              kickPlayerInputDTO?: KickPlayerInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerListBans: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerRegenerateRegistrationToken: (
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerRemove: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerResetCurrency: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerSearch: (
              gameServerSearchInputDTO?: GameServerSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerSendMessage: (
              id: string,
              messageSendInputDTO?: MessageSendInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerShutdown: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerTeleportPlayer: (
              gameServerId: string,
              playerId: string,
              teleportPlayerInputDTO?: TeleportPlayerInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerTestReachability: (
              gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerTestReachabilityForId: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerTriggerJob: (
              type: string,
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerUnbanPlayer: (
              gameServerId: string,
              playerId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          gameServerControllerUpdate: (
              id: string,
              gameServerUpdateDTO?: GameServerUpdateDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
      }

      • gameServerControllerBanPlayer: (
            gameServerId: string,
            playerId: string,
            banPlayerInputDTO?: BanPlayerInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Ban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerBanPlayer

      • gameServerControllerCreate: (
            gameServerCreateDTO?: GameServerCreateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Create a gameserver Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerCreate

      • gameServerControllerExecuteCommand: (
            id: string,
            commandExecuteInputDTO?: CommandExecuteInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Execute a raw command on a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerExecuteCommand

      • gameServerControllerGetImport: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

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

      • gameServerControllerGetJob: (
            type: string,
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Fetch a job status Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerGetJob

      • gameServerControllerGetMapInfo: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Get map metadata
        OperationId: GameServerControllerGetMapInfo

      • gameServerControllerGetMapTile: (
            id: string,
            x: string,
            y: string,
            z: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Get a map tile
        OperationId: GameServerControllerGetMapTile

      • gameServerControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Fetch a gameserver by id
        OperationId: GameServerControllerGetOne

      • gameServerControllerGetPlayers: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        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

      • gameServerControllerGetTypes: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>

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

      • gameServerControllerGiveItem: (
            gameServerId: string,
            playerId: string,
            giveItemInputDTO?: GiveItemInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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

      • gameServerControllerImportFromCSMM: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>

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

      • gameServerControllerKickPlayer: (
            gameServerId: string,
            playerId: string,
            kickPlayerInputDTO?: KickPlayerInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Kick a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerKickPlayer

      • gameServerControllerListBans: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        List bans for a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerListBans

      • gameServerControllerRegenerateRegistrationToken: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Regenerate the registration token for a gameserver. Careful, this will invalidate all existing connections. Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerRegenerateRegistrationToken

      • gameServerControllerRemove: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Delete a gameserver Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerRemove

      • gameServerControllerResetCurrency: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Resets all players' currency to 0 on the specified game server. This action is irreversible. Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerResetCurrency

      • gameServerControllerSearch: (
            gameServerSearchInputDTO?: GameServerSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Fetch gameservers
        OperationId: GameServerControllerSearch

      • gameServerControllerSendMessage: (
            id: string,
            messageSendInputDTO?: MessageSendInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Send a message in gameserver chat. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerSendMessage

      • gameServerControllerShutdown: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        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

      • gameServerControllerTeleportPlayer: (
            gameServerId: string,
            playerId: string,
            teleportPlayerInputDTO?: TeleportPlayerInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Teleport a player to a location. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerTeleportPlayer

      • gameServerControllerTestReachability: (
            gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Test if Takaro can connect to a gameserver. Will do a thorough check and report details.
        OperationId: GameServerControllerTestReachability

      • gameServerControllerTestReachabilityForId: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Test if Takaro can connect to a gameserver. Will do a thorough check and report details.
        OperationId: GameServerControllerTestReachabilityForId

      • gameServerControllerTriggerJob: (
            type: string,
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Manually trigger a job, you can poll the status with the GET endpoint Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerTriggerJob

      • gameServerControllerUnbanPlayer: (
            gameServerId: string,
            playerId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Unban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerUnbanPlayer

      • gameServerControllerUpdate: (
            id: string,
            gameServerUpdateDTO?: GameServerUpdateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Update a gameserver Required permissions: MANAGE_GAMESERVERS
        OperationId: GameServerControllerUpdate