Getting Started

Installation

npm install crowdstrike-falcon

Authentication

FalconJS handles OAuth2 automatically through middleware. Provide your credentials and cloud region when constructing the client.

import FalconClient from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

Supported Clouds

Cloud	Value
US-1	us-1
US-2	us-2
EU-1	eu-1
US-GOV-1	us-gov-1

Quick Start

import FalconClient from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const hosts = await client.hosts.queryDevicesByFilter({
  filter: "hostname:*'search-term'*",
  limit: 10,
});
console.log(hosts);

Key Features

• TypeScript-first — All request and response models include complete type definitions
• 120+ API services — Covers detections, hosts, intelligence, spotlight, real-time response, and more
• Built-in OAuth2 — Automatic token management through middleware

Error Handling

import { FalconErrorExplain } from "crowdstrike-falcon";

await client.sensorDownload
  .getSensorInstallersCCIDByQuery()
  .catch(async (err) => {
    console.error("Error: " + (await FalconErrorExplain(err)));
  })
  .then((value) => console.log("CCID:", value));

Resources

• FalconJS on GitHub
• npm Package
• Node.js Examples
• Browser Examples

Page Updated: v0.6.0