Class CFToolsClient

constructor

• new CFToolsClient(clientAuth, options?): CFToolsClient

• Parameters

  • clientAuth: ClientAuthenticationData

    The tokens/data used to authenticate with the CFTools Data API.
  • Optionaloptions: ClientOptions

    Additional options to configure the client.

  Returns CFToolsClient

authProvider

cacheConfiguration

cacheManager

cachingEnabled

logger

requestClient

useAccountCreationAPI

authenticate

• authenticate(): Promise<ClientAuthentication>

• Authenticates with the CFTools Data API and returns the authentication token.

  Returns Promise<ClientAuthentication>

  The client authentication token.

  See

  for more information.

batchPostGameLabsAction

• batchPostGameLabsAction(options): Promise<void>

• Perform multiple GameLabs actions in a single request. The GameLabs mod is required to be installed on the server for these actions to work. This counts for any GameLabs action, including teleporting players, spawning items, and more.

  Parameters

  • options: BatchPostGameLabsActionOptions

    The options to batch post GameLabs actions with.

  Returns Promise<void>

  Throws

  Thrown if the batch actions have less than one action.

  Throws

  Thrown if the batch actions have more than ten actions.

  See

  • for more information.
  • https://steamcommunity.com/sharedfiles/filedetails/?id=2464526692 for the GameLabs mod.

changeWorldTime

• changeWorldTime(options): Promise<void>

• Set the current time of the world on the server.

  The hour parameter is the hour of the day to set the world time to. The minute parameter is the minute of the hour to set the world time to.

  The hour must be between 0 and 24, and the minute must be between 0 and 60.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: ChangeWorldTimeOptions

    The options to change the world time with.

  Returns Promise<void>

  Throws

  Thrown if the world time hour or minute is out of bounds.

  See

  postGameLabsAction for more information.

changeWorldWeather

• changeWorldWeather(options): Promise<void>

• Set the current weather of the world on the server.

  • The fogDensity parameter is a float between 0 and 1, representing the fog density.
  • The overcast parameter is a float between 0 and 1, representing the overcast.
  • The rainIntensity parameter is a float between 0 and 1, representing the rain intensity.
  • The windIntensity parameter is an integer greater than 0, representing the wind intensity.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: ChangeWorldWeatherOptions

    The options to change the world weather with.

  Returns Promise<void>

  Throws

  Thrown if the world weather options are out of bounds.

  See

  postGameLabsAction for more information.

clearTerritory

• clearTerritory(options): Promise<void>

• Clear the territory flag of a territory that is currently spawned on the server.

  The identifier parameter is the entity ID of the territory flag to clear.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: IdentifierActionOptionsNoParams

    The options to clear a territory flag with.

  Returns Promise<void>

  Throws

  Thrown if the territory flag is not found.

  See

  postGameLabsAction for more information.

createBan

• createBan(options): Promise<void>

• Creates a ban on a banlist. The identifier parameter can be a CFTools ID or an IPv4 address. If the identifier parameter is an AnyPlayerId, it will be resolved to a CFTools ID before being used in the request.

  Parameters

  • options: CreateBanOptions

    The options to create a ban with.

  Returns Promise<void>

  Throws

  Thrown if the ban reason exceeds 128 characters.

  See

  for more information.

deleteBan

• deleteBan(options): Promise<void>

• Deletes a ban from a banlist.

  Parameters

  • options: DeleteBanOptions

    The options to delete a ban with.

  Returns Promise<void>

  Throws

  Thrown if the ban being deleted does not exist.

  Throws

  Thrown if the ban ID is not provided.

  See

  for more information.

deleteObject

• deleteObject(options): Promise<void>

• Delete an object that is currently spawned on the server.

  The identifier parameter is the entity ID of the object to delete.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: IdentifierActionOptionsNoParams

    The options to delete an object with.

  Returns Promise<void>

  Throws

  Thrown if the object is not found.

  See

  postGameLabsAction for more information.

deletePriorityQueue

• deletePriorityQueue(options): Promise<void>

• Deletes a player from the priority queue list/bucket.

  The playerId parameter can be a CFTools ID or a dynamic player ID. If the playerId parameter is a dynamic player ID, it will be resolved to a CFTools ID before being used in the request.

  Parameters

  • options: DeletePriorityQueueOptions

    The options to delete from the priority queue with.

  Returns Promise<void>

  See

  • getPriorityQueue for more information on getting the priority queue.
  • postPriorityQueue for more information on posting to the priority queue.
  • for more information on the CFTools API endpoint.

  Throws

  Thrown if the player is not found in the priority queue.

  Throws

  Thrown if the player is not found in the priority queue.

deleteVehicle

• deleteVehicle(options): Promise<void>

• Delete a vehicle that is currently spawned on the server.

  The identifier parameter is the entity ID of the vehicle to delete.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: IdentifierActionOptionsNoParams

    The options to delete a vehicle with.

  Returns Promise<void>

  Throws

  Thrown if the vehicle is not found.

  See

  postGameLabsAction for more information.

deleteWhitelist

• deleteWhitelist(options): Promise<void>

• Removes a player from the whitelist.

  The playerId parameter can be a CFTools ID or a dynamic player ID. If the playerId parameter is a dynamic player ID, it will be resolved to a CFTools ID before being used in the request.

  Parameters

  • options: DeleteWhitelistOptions

    The options to delete from the whitelist with.

  Returns Promise<void>

  Throws

  Thrown if the player is not found in the whitelist.

  Throws

  Thrown if the player is not found in the whitelist.

  See

  • getWhitelist for more information on getting the whitelist.
  • postWhitelist for more information on posting to the whitelist.
  • for more information.

explodePlayer

• explodePlayer(options): Promise<void>

• Explode a player that is currently connected to the server.

  The target parameter can be a CFTools ID, a dynamic player ID, or a session id. If the target parameter is a dynamic player ID, it will be resolved to a session id
  before being used in the request.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: TargetActionOptionsNoParams

    The options to explode a player with.

  Returns Promise<void>

  Throws

  Thrown if the player being exploded is not online.

  See

  postGameLabsAction for more information.

explodeVehicle

• explodeVehicle(options): Promise<void>

• Explode a vehicle that is currently spawned on the server.

  The identifier parameter is the entity ID of the vehicle to explode.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: IdentifierActionOptionsNoParams

    The options to explode

  Returns Promise<void>

  Throws

  Thrown if the vehicle is not found.

  See

  postGameLabsAction for more information.

gameLabsActions

• gameLabsActions(serverApiId?): Promise<{
      actionCode: string;
      actionContext: string;
      actionContextFilter: string[];
      actionName: string;
      parameters: undefined | {};
      referenceKey: string;
  }[]>

• Fetches all currently available GameLabs actions. This list will be empty if the GameLabs mod is not installed on the server.

  Parameters

  • OptionalserverApiId: string

    The server API ID to fetch GameLabs actions for.

  Returns Promise<{
      actionCode: string;
      actionContext: string;
      actionContextFilter: string[];
      actionName: string;
      parameters: undefined | {};
      referenceKey: string;
  }[]>

  The GameLabs actions.

  Throws

  Thrown if the server is not found.

  Throws

  Thrown if the server API ID is not provided.

  See

  • for more information.
  • https://steamcommunity.com/sharedfiles/filedetails/?id=2464526692 for the GameLabs mod.

gameLabsEntityEvents

• gameLabsEntityEvents(serverApiId?): Promise<{
      className: string;
      id: string;
      position: [number, number];
  }[]>

• Fetches all dynamic entity events from the GameLabs mod. This list will be empty if the GameLabs mod is not installed on the server.

  Parameters

  • OptionalserverApiId: string

    The server API ID to fetch GameLabs entity events for.

  Returns Promise<{
      className: string;
      id: string;
      position: [number, number];
  }[]>

  The GameLabs entity events.

  Throws

  Thrown if the server is not found.

  Throws

  Thrown if the server API ID is not provided.

  See

  • for more information.
  • https://steamcommunity.com/sharedfiles/filedetails/?id=2464526692 for the GameLabs mod.

gameLabsEntityVehicles

• gameLabsEntityVehicles(serverApiId?): Promise<{
      className: string;
      health: number;
      id: string;
      position: [number, number];
      speed: number;
  }[]>

• Fetches all dynamic entity vehicles from the GameLabs mod. This list will be empty if the GameLabs mod is not installed on the server.

  Parameters

  • OptionalserverApiId: string

    The server API ID to fetch GameLabs entity vehicles for.

  Returns Promise<{
      className: string;
      health: number;
      id: string;
      position: [number, number];
      speed: number;
  }[]>

  The GameLabs entity vehicles.

  Throws

  Thrown if the server is not found.

  Throws

  Thrown if the server API ID is not provided.

  See

  • for more information.
  • https://steamcommunity.com/sharedfiles/filedetails/?id=2464526692 for the GameLabs mod.

gameServerDetails

• gameServerDetails(options): Promise<Omit<{
      attributes: {
          description: string;
          dlc: boolean;
          dlcs: {
              livonia: boolean;
              sakhal: boolean;
          };
          experimental: boolean;
          hive: string;
          modded: boolean;
          official: boolean;
          shard: string;
          whitelist: boolean;
      };
      environment: {
          perspectives: {
              1Rd: boolean;
              3Rd: boolean;
          };
          time: string;
          timeAcceleration: {
              general: number;
              night: number;
          };
      };
      game: DayZ;
      geolocation: {
          available: boolean;
          city: {
              name: string;
              region: string;
          };
          continent: string;
          country: {
              code: string;
              name: string;
          };
          timezone: string;
      };
      host: {
          address: string;
          gamePort: number;
          os: string;
          queryPort: number;
      };
      map: string;
      mods: {
          fileId: string;
          name: string;
      }[];
      name: string;
      object: {
          createdAt: string;
          error: GameServerQueryError;
          updatedAt: string;
      };
      offline: boolean;
      online: boolean;
      publisher: {
          monetization: boolean;
      };
      rank: number;
      rating: string;
      security: {
          battleye: boolean;
          password: boolean;
          vac: boolean;
      };
      signatures: string[];
      status: {
          bots: boolean;
          players: number;
          queue: {
              active: boolean;
              size: number;
          };
          slots: number;
      };
      version: string;
  }, "object"> & {
      object: Omit<{
          createdAt: string;
          error: GameServerQueryError;
          updatedAt: string;
      }, "createdAt" | "updatedAt"> & {
          createdAt: Date;
          updatedAt: Date;
      };
  }>

• Fetch game-server details from the CFTools Data API. This references game-server entities, and is NOT the scope which allows you to retrieve information about CFCloud instances.

  Parameters

  • options: string | ResolveServerIdOptions

    The options to fetch game-server details with.

  Returns Promise<Omit<{
      attributes: {
          description: string;
          dlc: boolean;
          dlcs: {
              livonia: boolean;
              sakhal: boolean;
          };
          experimental: boolean;
          hive: string;
          modded: boolean;
          official: boolean;
          shard: string;
          whitelist: boolean;
      };
      environment: {
          perspectives: {
              1Rd: boolean;
              3Rd: boolean;
          };
          time: string;
          timeAcceleration: {
              general: number;
              night: number;
          };
      };
      game: DayZ;
      geolocation: {
          available: boolean;
          city: {
              name: string;
              region: string;
          };
          continent: string;
          country: {
              code: string;
              name: string;
          };
          timezone: string;
      };
      host: {
          address: string;
          gamePort: number;
          os: string;
          queryPort: number;
      };
      map: string;
      mods: {
          fileId: string;
          name: string;
      }[];
      name: string;
      object: {
          createdAt: string;
          error: GameServerQueryError;
          updatedAt: string;
      };
      offline: boolean;
      online: boolean;
      publisher: {
          monetization: boolean;
      };
      rank: number;
      rating: string;
      security: {
          battleye: boolean;
          password: boolean;
          vac: boolean;
      };
      signatures: string[];
      status: {
          bots: boolean;
          players: number;
          queue: {
              active: boolean;
              size: number;
          };
          slots: number;
      };
      version: string;
  }, "object"> & {
      object: Omit<{
          createdAt: string;
          error: GameServerQueryError;
          updatedAt: string;
      }, "createdAt" | "updatedAt"> & {
          createdAt: Date;
          updatedAt: Date;
      };
  }>

  The game-server details.

  See

  for more information.

getAppGrants

• getAppGrants(): Promise<{
      banlist: ClientBanListGrantResponse[];
      server: ClientServerGrantResponse[];
  }>

• Resolves the current client grants. A grant represents a resource (server or banlist) that the client has access to. The client grants are used to determine what actions the client can perform.

  Returns Promise<{
      banlist: ClientBanListGrantResponse[];
      server: ClientServerGrantResponse[];
  }>

  The current client grants.

  See

  for more information.

getPlayerStats

• getPlayerStats(options): Promise<{
      identities: {
          battleye: {
              guid: string;
          };
          bohemiainteractive: {
              uid: string;
          };
          steam: {
              steam64: string;
          };
      };
      values: {
          clearedAt: Date;
          createdAt: Date;
          game: {
              dayz: undefined | {
                  deaths: number;
                  distanceTraveled: number;
                  environmentDeaths: number;
                  hits: number;
                  kdratio: number;
                  kills: {
                      animals: number;
                      infected: number;
                      players: number;
                  };
                  longestKill: number;
                  longestShot: number;
                  shots: {
                      fired: number;
                      hit: number;
                      hitAnimals: number;
                      hitInfected: number;
                      hitPlayers: number;
                      hitVehicles: number;
                  };
                  suicides: number;
                  weapons: {};
                  zones: {
                      : number;
                      brain: number;
                      head: number;
                      leftarm: number;
                      leftfoot: number;
                      lefthand: number;
                      leftleg: number;
                      rightarm: number;
                      rightfoot: number;
                      righthand: number;
                      rightleg: number;
                      torso: number;
                  };
              };
          };
          omega: {
              nameHistory: string[];
              playtime: number;
              sessions: number;
          };
          updatedAt: Date;
      };
  }>

• Fetches the player statistics for a specific game-server.

  Parameters

  • options: GetPlayerStatsOptions

    The options to fetch the player statistics with.

  Returns Promise<{
      identities: {
          battleye: {
              guid: string;
          };
          bohemiainteractive: {
              uid: string;
          };
          steam: {
              steam64: string;
          };
      };
      values: {
          clearedAt: Date;
          createdAt: Date;
          game: {
              dayz: undefined | {
                  deaths: number;
                  distanceTraveled: number;
                  environmentDeaths: number;
                  hits: number;
                  kdratio: number;
                  kills: {
                      animals: number;
                      infected: number;
                      players: number;
                  };
                  longestKill: number;
                  longestShot: number;
                  shots: {
                      fired: number;
                      hit: number;
                      hitAnimals: number;
                      hitInfected: number;
                      hitPlayers: number;
                      hitVehicles: number;
                  };
                  suicides: number;
                  weapons: {};
                  zones: {
                      : number;
                      brain: number;
                      head: number;
                      leftarm: number;
                      leftfoot: number;
                      lefthand: number;
                      leftleg: number;
                      rightarm: number;
                      rightfoot: number;
                      righthand: number;
                      rightleg: number;
                      torso: number;
                  };
              };
          };
          omega: {
              nameHistory: string[];
              playtime: number;
              sessions: number;
          };
          updatedAt: Date;
      };
  }>

  The player statistics for the game-server.

  Throws

  Thrown if the server identifier is invalid.

  See

  for more information.

getPriorityQueue

• getPriorityQueue(options): Promise<{
      createdAt: Date;
      creator: {
          cftoolsId: string;
      };
      links: {
          href: string;
          method: string;
          relationship: string;
      };
      meta: {
          comment: string;
          expiration: null | Date;
          fromApi: boolean;
      };
      updatedAt: Date;
      user: {
          cftoolsId: string;
      };
      uuid: string;
  }[]>

• Queries the priority queue list/bucket for a specific player.

  The playerId parameter can be a CFTools ID or a dynamic player ID. If the playerId parameter is a dynamic player ID, it will be resolved to a CFTools ID before being used in the request.

  The comment parameter is an optional comment to filter the priority queue list with.

  Parameters

  • options: GetPriorityQueueOptions

    The options to get the priority queue with.

  Returns Promise<{
      createdAt: Date;
      creator: {
          cftoolsId: string;
      };
      links: {
          href: string;
          method: string;
          relationship: string;
      };
      meta: {
          comment: string;
          expiration: null | Date;
          fromApi: boolean;
      };
      updatedAt: Date;
      user: {
          cftoolsId: string;
      };
      uuid: string;
  }[]>

  The priority queue list/bucket for the player.

  Throws

  Thrown if the player is not found in the priority queue bucket/list.

  See

  • postPriorityQueue for more information on posting to the priority queue.
  • deletePriorityQueue for more information on deleting from the priority queue.
  • for more information on the CFTools API endpoint.

getSessionByPlayerId

• getSessionByPlayerId(options): Promise<null | ClientPlayerSession>

• Fetches a session by a player ID. This can be a CFTools ID or a dynamic player ID. If the player ID is a dynamic player ID, it will be resolved to a CFTools ID before being used in the request.

  Parameters

  • options: GetSessionByCFToolsIdOptions

    The options to fetch a session by player ID with.

  Returns Promise<null | ClientPlayerSession>

  The player session.

  Throws

  Thrown if the player session is not found.

  Throws

  Thrown if the server API ID is not provided.

  See

  for more information.

getWhitelist

• getWhitelist(options): Promise<{
      createdAt: Date;
      creator: {
          cftoolsId: string;
      };
      links: {
          href: string;
          method: string;
          relationship: string;
      }[];
      meta: {
          comment: string;
          expiration: null | Date;
          fromApi: boolean;
      };
      updatedAt: Date;
      user: {
          cftoolsId: string;
      };
      uuid: string;
  }[]>

• Queries the whitelist for a specific player.

  The playerId parameter can be a CFTools ID or a dynamic player ID. If the playerId parameter is a dynamic player ID, it will be resolved to a CFTools ID before being used in the request.

  The comment parameter is an optional comment to filter the whitelist with.

  Parameters

  • options: GetWhitelistOptions

    The options to get the whitelist with.

  Returns Promise<{
      createdAt: Date;
      creator: {
          cftoolsId: string;
      };
      links: {
          href: string;
          method: string;
          relationship: string;
      }[];
      meta: {
          comment: string;
          expiration: null | Date;
          fromApi: boolean;
      };
      updatedAt: Date;
      user: {
          cftoolsId: string;
      };
      uuid: string;
  }[]>

  The whitelist for the player.

  Throws

  Thrown if the server identifier is invalid.

  See

  • postWhitelist for more information on posting to the whitelist.
  • deleteWhitelist for more information on deleting from the whitelist.
  • for more information.

grantURL

• grantURL(): string

• Returns string

  The URL to grant access to the CFTools Data API.

healPlayer

• healPlayer(options): Promise<void>

• Heal a player to full health.

  The target parameter can be a CFTools ID, a dynamic player ID, or a session id. If the target parameter is a dynamic player ID, it will be resolved to a session id before being used in the request.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: TargetActionOptionsNoParams

    The options to heal a player with.

  Returns Promise<void>

  Throws

  Thrown if the player being healed is not online.

  See

  postGameLabsAction for more information.

kickPlayer

• kickPlayer(options): Promise<void>

• Kicks a player that is currently connected to the server. The id parameter can be a CFTools ID, a dynamic player ID, or a session id. If the id parameter is a dynamic player ID, it will be resolved to a CFTools ID before being used in the request.

  Parameters

  • options: KickOptions

    The options to kick a player with.

  Returns Promise<void>

  Throws

  Thrown if the player being kicked is not found.

  Throws

  Thrown if the kick reason exceeds 128 characters.

  See

  for more information.

killPlayer

• killPlayer(options): Promise<void>

• Kill a player that is currently connected to the server.

  The target parameter can be a CFTools ID, a dynamic player ID, or a session id. If the target parameter is a dynamic player ID, it will be resolved to a session id before being used in the request.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: TargetActionOptionsNoParams

    The options to kill a player with.

  Returns Promise<void>

  Throws

  Thrown if the player being killed is not online.

  See

  postGameLabsAction for more information.

killVehicleEngine

• killVehicleEngine(options): Promise<void>

• Kills the engine of a vehicle that is currently spawned on the server.

  The identifier parameter is the entity ID of the vehicle to kill the engine of.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: IdentifierActionOptionsNoParams

    The options to kill the vehicle engine with.

  Returns Promise<void>

  Throws

  Thrown if the vehicle is not found.

  See

  postGameLabsAction for more information.

lbMutePlayer

• lbMutePlayer(options): Promise<void>

• This action will mute a player that is currently connected to the server.

  The target parameter can be a CFTools ID, a dynamic player ID, or a session id. If the target parameter is a dynamic player ID, it will be resolved to a session id before being used in the request.

  The durationInMinutes parameter is the amount of time in minutes to mute the player for.

  The mod GameLabs is required to be installed on the server for this action to work.

  The mod Advanced Groups is required to be installed on the server for this action to work.

  Parameters

  • options: LBMutePlayerOptions

    The options to mute a player with.

  Returns Promise<void>

  Throws

  Thrown if the player who is being muted is not online.

  See

  • postGameLabsAction for more information.
  • lbUnmutePlayer for more information on unmuting a player.

lbUnmutePlayer

• lbUnmutePlayer(options): Promise<void>

• This action will unmute a player that is currently connected to the server.

  The target parameter can be a CFTools ID, a dynamic player ID, or a session id. If the target parameter is a dynamic player ID, it will be resolved to a session id before being used in the request.

  The mod GameLabs is required to be installed on the server for this action to work.

  The mod Advanced Groups is required to be installed on the server for this action to work.

  Parameters

  • options: TargetActionOptionsNoParams

    The options to unmute a player with.

  Returns Promise<void>

  Throws

  Thrown if the player who is being unmuted is not online.

  See

  • postGameLabsAction for more information.
  • lbMutePlayer for more information on muting a player.

leaderboard

• leaderboard(options): Promise<{
      cftoolsId: string;
      deaths: number;
      environmentDeaths: number;
      hits: number;
      kdratio: number;
      kills: number;
      latestName: string;
      longestKill: number;
      longestShot: number;
      playtime: number;
      rank: number;
      suicides: number;
  }[]>

• Fetches the leaderboard for a specific game-server.

  Parameters

  • options: LeaderboardOptions

    The options to fetch the leaderboard with.

  Returns Promise<{
      cftoolsId: string;
      deaths: number;
      environmentDeaths: number;
      hits: number;
      kdratio: number;
      kills: number;
      latestName: string;
      longestKill: number;
      longestShot: number;
      playtime: number;
      rank: number;
      suicides: number;
  }[]>

  The leaderboard for the game-server.

  Throws

  Thrown if the server identifier is invalid.

  Throws

  Thrown if the leaderboard type is invalid.

  Throws

  Thrown if the leaderboard limit is invalid.

  Throws

  Thrown if the leaderboard limit is too low.

  Throws

  Thrown if the leaderboard limit is too high.

  See

  for more information.

listBans

• listBans(options): Promise<(Omit<{
      createdAt: string;
      expiresAt: null | string;
      id: string;
      identifier: string;
      links: {
          href: string;
          method: "DELETE";
          relationship: "delete";
      }[];
      reason: string;
      status: BanStatus;
      updatedAt: string;
  }, "createdAt" | "updatedAt" | "expiresAt"> & {
      createdAt: Date;
      expiresAt: null | Date;
      updatedAt: Date;
  })[]>

• Fetches bans from a banlist. The filter parameter can be a comment, CFTools ID or an IPv4 address. If the filter parameter is a string, it will be ignored in the request. If the filter parameter is an AnyPlayerId, it will be resolved to a CFTools ID before being used in the request.

  Parameters

  • options: ListBansOptions

    The options to list bans with.

  Returns Promise<(Omit<{
      createdAt: string;
      expiresAt: null | string;
      id: string;
      identifier: string;
      links: {
          href: string;
          method: "DELETE";
          relationship: "delete";
      }[];
      reason: string;
      status: BanStatus;
      updatedAt: string;
  }, "createdAt" | "updatedAt" | "expiresAt"> & {
      createdAt: Date;
      expiresAt: null | Date;
      updatedAt: Date;
  })[]>

  The list of bans.

  See

  for more information.

lookupUser

• lookupUser(id, useAccountCreationAPI?): Promise<{
      cftoolsId: string;
      notice?: string;
  }>

• Resolves a string or AnyPlayerId to a CFTools ID.

  Parameters

  • id: string | AnyPlayerId

    The ID to lookup.
  • useAccountCreationAPI: boolean = ...

    Whether the Account Creation API should be used.

    See

    ClientOptions.useAccountCreationAPI

  Returns Promise<{
      cftoolsId: string;
      notice?: string;
  }>

  The resolved CFTools ID.

  See

  for more information.

messagePrivate

• messagePrivate(options): Promise<void>

• Privately messages a player that is currently connected to the server. The id parameter can be a CFTools ID, a dynamic player ID, or a session id. If the id parameter is a dynamic player ID, it will be resolved to a CFTools ID before being used in the request.

  Parameters

  • options: MessagePrivateOptions

    The options to message a player with.

  Returns Promise<void>

  Throws

  Thrown if the player being messaged is not found.

  Throws

  Thrown if the private message content exceeds 256 characters.

  See

  for more information.

messageServer

• messageServer(options): Promise<void>

• Broadcast a message to all players currently connected to the server.

  Parameters

  • options: MessageServerOptions

    The options to message all players with.

  Returns Promise<void>

  Throws

  Thrown if the server message content exceeds 256 characters.

  See

  for more information.

playerList

• playerList(serverApiId?): Promise<ClientPlayerSession[]>

• Fetches the player list from the CFTools Data API. This list consists of all players currently connected to the server.

  Parameters

  • OptionalserverApiId: string

    The server API ID to fetch the player list for.

  Returns Promise<ClientPlayerSession[]>

  The player list.

  Throws

  Thrown if the server is not found.

  Throws

  Thrown if the server API ID is not provided.

  See

  for more information.

postGameLabsAction

• postGameLabsAction(options): Promise<void>

• Perform a specified GameLabs action. The GameLabs mod is required to be installed on the server for these actions to work. This counts for any GameLabs action, including teleporting players, spawning items, and more.

  Parameters

  • options: PostGameLabsActionOptions

    The options to post a GameLabs action with.

  Returns Promise<void>

  Throws

  Thrown if the player on which the action is performed is not online.

  See

  for more information.

postPriorityQueue

• postPriorityQueue(options): Promise<void>

• Posts a player to the priority queue list/bucket.

  The playerId parameter can be a CFTools ID or a dynamic player ID. If the playerId parameter is a dynamic player ID, it will be resolved to a CFTools ID before being used in the request.

  • The expiresAt parameter is an optional date to expire the player from the priority queue, if not provided the player will be in the priority queue indefinitely/permanent.
  • The comment parameter is a required comment to add to the priority queue entry.

  Parameters

  • options: PostPriorityQueueOptions

    The options to post to the priority queue with.

  Returns Promise<void>

  Throws

  Thrown if the player is already in the priority queue.

  See

  • getPriorityQueue for more information on getting the priority queue.
  • deletePriorityQueue for more information on deleting from the priority queue.
  • for more information on the CFTools API endpoint.

postWhitelist

• postWhitelist(options): Promise<void>

• Posts a player to the whitelist.

  The playerId parameter can be a CFTools ID or a dynamic player ID. If the playerId parameter is a dynamic player ID, it will be resolved to a CFTools ID before being used in the request.

  • The expiresAt parameter is an optional date to expire the player from the whitelist, if not provided the player will be in the whitelist indefinitely/permanent.
  • The comment parameter is a required comment to add to the whitelist entry.

  Parameters

  • options: PostWhitelistOptions

    The options to post to the whitelist with.

  Returns Promise<void>

  Throws

  Thrown if the player is already in the whitelist.

  See

  • getWhitelist for more information on getting the whitelist.
  • deleteWhitelist for more information on deleting from the whitelist.
  • for more information.

rconCommand

• rconCommand(options): Promise<void>

• Issue an RCon command to the server.

  Parameters

  • options: RawRConCommandOptions

    The options to issue an RCon command with.

  Returns Promise<void>

  Throws

  Thrown if the RCon command exceeds 256 characters.

  See

  • for more information.
  • https://www.4netplayers.com/en/wiki/dayz/admin-commands/ for a list of admin commands.

refuelVehicle

• refuelVehicle(options): Promise<void>

• Refuel a vehicle that is currently spawned on the server.

  The identifier parameter is the entity ID of the vehicle to refuel.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: IdentifierActionOptionsNoParams

    The options to refuel a vehicle with.

  Returns Promise<void>

  Throws

  Thrown if the vehicle is not found.

  See

  postGameLabsAction for more information.

repairVehicle

• repairVehicle(options): Promise<void>

• Repair a vehicle that is currently spawned on the server.

  The identifier parameter is the entity ID of the vehicle to repair.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: IdentifierActionOptionsNoParams

    The options to repair a vehicle with.

  Returns Promise<void>

  Throws

  Thrown if the vehicle is not found.

  See

  postGameLabsAction for more information.

resetPlayerStats

• resetPlayerStats(options): Promise<void>

• Resets the player statistics for a specific game-server.

  Parameters

  • options: DeletePlayerStatsOptions

    The options to reset the player statistics with.

  Returns Promise<void>

  Throws

  Thrown if the server identifier is invalid.

  Throws

  Thrown if the player is not found.

  See

  for more information.

resolveDynamicPlayerId

• resolveDynamicPlayerId(options): Promise<string>

• Resolves the dynamic player ID to a CFTools ID. This id can be a string, or AnyPlayerId.

  Parameters

  • options: {
        playerId: string | AnyPlayerId;
    }

    The options to resolve the dynamic player ID from.

    • playerId: string | AnyPlayerId

  Returns Promise<string>

  The resolved CFTools ID.

resolvePlayerReferenceKey

• resolvePlayerReferenceKey(options): Promise<null | string>

• Resolves target input to a steam64, used in GameLabs actions (referenceKey). target can be multiple different things, please see GameLabsActionTarget.

  Parameters

  • options: {
        serverApiId?: string;
        target: GameLabsActionTarget;
    }

    The options to resolve the player reference key from.

    • OptionalserverApiId?: string

    • target: GameLabsActionTarget

  Returns Promise<null | string>

  The resolved player reference key.

resolveServerId

• resolveServerId(options): string

• Resolves the server ID from the provided options.

  Parameters

  • options: string | ResolveServerIdOptions

    The options to resolve the server ID from.

  Returns string

  The resolved server ID.

serverInfo

• serverInfo(serverApiId?): Promise<{
      connection: Omit<{
          peerVersion: string;
          prefilledCommands: boolean;
          protcolUsed: string;
          restricted: boolean;
      }, "protcolUsed"> & {
          protocolUsed: string;
      };
      gameserver: Omit<{
          game: DayZ;
          gameIntegration: {
              capabilities: string[];
              pollProtocol: string;
              status: boolean;
              updatedAt: null | string;
              version: null | string;
          };
          gameserverId: string;
          link: string;
          runtime: {
              gametime: undefined | string;
              restartSchedule: undefined | {
                  next: undefined | {
                      local: (...) | (...);
                      utc: (...) | (...);
                  };
              };
              uptime: undefined | number;
          };
      }, "gameIntegration"> & {
          gameIntegration: Omit<{
              capabilities: string[];
              pollProtocol: string;
              status: boolean;
              updatedAt: null | string;
              version: null | string;
          }, "updatedAt"> & {
              updatedAt: null | Date;
          };
      };
      links: {
          href: string;
          method: string;
          relationship: string;
      }[];
      object: Omit<{
          createdAt: string;
          nickname: string;
          resourceOwner: string;
          updatedAt: string;
      }, "createdAt" | "updatedAt"> & {
          createdAt: Date;
          updatedAt: Date;
      };
      worker: {
          clientId: string;
          state: "WorkerState.CONNECTED" | "WorkerState.DISCONNECTED";
      };
  }>

• Fetches server information from the CFTools Data API. This includes information about the server such as the name, description, and more.

  Parameters

  • OptionalserverApiId: string

    The server API ID to fetch information for.

  Returns Promise<{
      connection: Omit<{
          peerVersion: string;
          prefilledCommands: boolean;
          protcolUsed: string;
          restricted: boolean;
      }, "protcolUsed"> & {
          protocolUsed: string;
      };
      gameserver: Omit<{
          game: DayZ;
          gameIntegration: {
              capabilities: string[];
              pollProtocol: string;
              status: boolean;
              updatedAt: null | string;
              version: null | string;
          };
          gameserverId: string;
          link: string;
          runtime: {
              gametime: undefined | string;
              restartSchedule: undefined | {
                  next: undefined | {
                      local: (...) | (...);
                      utc: (...) | (...);
                  };
              };
              uptime: undefined | number;
          };
      }, "gameIntegration"> & {
          gameIntegration: Omit<{
              capabilities: string[];
              pollProtocol: string;
              status: boolean;
              updatedAt: null | string;
              version: null | string;
          }, "updatedAt"> & {
              updatedAt: null | Date;
          };
      };
      links: {
          href: string;
          method: string;
          relationship: string;
      }[];
      object: Omit<{
          createdAt: string;
          nickname: string;
          resourceOwner: string;
          updatedAt: string;
      }, "createdAt" | "updatedAt"> & {
          createdAt: Date;
          updatedAt: Date;
      };
      worker: {
          clientId: string;
          state: "WorkerState.CONNECTED" | "WorkerState.DISCONNECTED";
      };
  }>

  The server information.

  Throws

  Thrown if the server is not found.

  Throws

  Thrown if the server API ID is not provided.

  See

  for more information.

serverStatistics

• serverStatistics(serverApiId?): Promise<{
      aggregated: {
          playerIndividual: {
              daily: number[];
              monthly: number[];
              weekly: number[];
          };
          playerInflux: {
              daily: number[];
              monthly: number[];
              weekly: number[];
          };
          playerNewRetention: {
              daily: number[];
              monthly: number[];
              weekly: number[];
          };
          playerRetention: {
              monthly: number[];
              weekly: number[];
          };
          playtime: {
              daily: number[];
              monthly: number[];
              weekly: number[];
          };
          sessions: {
              daily: number[];
              monthly: number[];
              weekly: number[];
          };
          topCountries: string[];
      };
      general: {
          modComplexity: number;
          playtimeTotalSeconds: number;
          sessionsTotal: number;
      };
  }>

• Fetches server statistics from the CFTools Data API. This includes statistics about the server such as the player count, uptime, and more.

  Parameters

  • OptionalserverApiId: string

    The server API ID to fetch statistics for.

  Returns Promise<{
      aggregated: {
          playerIndividual: {
              daily: number[];
              monthly: number[];
              weekly: number[];
          };
          playerInflux: {
              daily: number[];
              monthly: number[];
              weekly: number[];
          };
          playerNewRetention: {
              daily: number[];
              monthly: number[];
              weekly: number[];
          };
          playerRetention: {
              monthly: number[];
              weekly: number[];
          };
          playtime: {
              daily: number[];
              monthly: number[];
              weekly: number[];
          };
          sessions: {
              daily: number[];
              monthly: number[];
              weekly: number[];
          };
          topCountries: string[];
      };
      general: {
          modComplexity: number;
          playtimeTotalSeconds: number;
          sessionsTotal: number;
      };
  }>

  The server statistics.

  Throws

  Thrown if the server is not found.

  Throws

  Thrown if the server API ID is not provided.

  See

  for more information.

setWorldWeatherSunny

• setWorldWeatherSunny(serverApiId?): Promise<void>

• Change the world weather to sunny/clear on the server.

  Parameters

  • OptionalserverApiId: string

    The server API ID to change the world weather on.

  Returns Promise<void>

  See

  • postGameLabsAction for more information on GameLabs actions.
  • changeWorldWeather for more information on the specific action to change the world weather.

spawnItemOnGround

• spawnItemOnGround(options): Promise<void>

• Spawn on item on a set of [x, y, z] coordinates on the ground.

  • The itemClassName parameter is the class name of the item to spawn.
  • The position parameter is an array of three numbers, representing the x, y, and z coordinates respectively.
  • The quantity parameter is the amount of items to spawn.
  • The stacked parameter is a boolean that determines if the items should be stacked.
  • The populateItem parameter is a boolean that determines if the item should be populated.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: SpawnItemOnGroundOptions

    The options to spawn an item on the ground with.

  Returns Promise<void>

  Throws

  Thrown if the item spawn position is not an array of three numbers.

  See

  postGameLabsAction for more information.

spawnItemOnPlayer

• spawnItemOnPlayer(options): Promise<void>

• Spawn an item on a player that is currently connected to the server.

  The target parameter can be a CFTools ID, a dynamic player ID, or a session id. If the target parameter is a dynamic player ID, it will be resolved to a session id before being used in the request.

  • The itemClassName parameter is the class name of the item to spawn.
  • The quantity parameter is the amount of items to spawn.
  • The stacked parameter is a boolean that determines if the items should be stacked.
  • The populateItem parameter is a boolean that determines if the item should be populated.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: SpawnItemOnPlayerOptions

    The options to spawn an item on a player with.

  Returns Promise<void>

  Throws

  Thrown if the player on which the item is spawned is not online.

  See

  postGameLabsAction for more information.

stripPlayer

• stripPlayer(options): Promise<void>

• Strip a player of all items that they currently have.

  The target parameter can be a CFTools ID, a dynamic player ID, or a session id. If the target parameter is a dynamic player ID, it will be resolved to a session id before being used in the request.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: TargetActionOptionsNoParams

    The options to strip a player with.

  Returns Promise<void>

  Throws

  Thrown if the player being stripped is not online.

  See

  postGameLabsAction for more information.

teleportPlayer

• teleportPlayer(options): Promise<void>

• Teleport a player to a specified position.

  The target parameter can be a CFTools ID, a dynamic player ID, or a session id. If the target parameter is a dynamic player ID, it will be resolved to a session id before being used in the request.

  The position parameter is an array of three numbers, representing the x, y, and z coordinates respectively.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: TeleportPlayerOptions

    The options to teleport a player with.

  Returns Promise<void>

  Throws

  Thrown if the player being teleported is not online.

  See

  postGameLabsAction for more information.

unstuckVehicle

• unstuckVehicle(options): Promise<void>

• Unstuck a vehicle that is currently spawned on the server. This action will move the vehicle by a couple of x, and z coordinates to get it unstuck.

  The identifier parameter is the entity ID of the vehicle to unstuck.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • options: IdentifierActionOptionsNoParams

    The options to unstuck a vehicle with.

  Returns Promise<void>

  Throws

  Thrown if the vehicle is not found.

  See

  postGameLabsAction for more information.

wipeWorldAI

• wipeWorldAI(serverApiId?): Promise<void>

• Wipe all AI from the world on the server. This deletes all AI entities from the world, including zombies, animals, and more.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • OptionalserverApiId: string

    The server API ID to wipe world AI on.

  Returns Promise<void>

  See

  postGameLabsAction for more information.

wipeWorldVehicles

• wipeWorldVehicles(serverApiId?): Promise<void>

• Wipe all vehicles from the world on the server. This deletes all vehicle entities from the world, including cars, boats, helicopters, and more.

  The mod GameLabs is required to be installed on the server for this action to work.

  Parameters

  • OptionalserverApiId: string

    The server API ID to wipe world vehicles on.

  Returns Promise<void>

  See

  postGameLabsAction for more information.