Skip to content

Repository files navigation

FalconJS

Version Build License

NPM

TypeScript SDK for the CrowdStrike Falcon API.

Experimental

falconjs is an open source project, not a CrowdStrike product. It carries no formal support, expressed or implied.

Installation

npm install crowdstrike-falcon

Features

  • TypeScript-first — fully typed request and response models
  • 120+ API services — detections, hosts, intel, spotlight, real-time response, and more
  • OAuth2 built-in — automatic token management via middleware

Quick Start

import { FalconClient, FalconErrorExplain } from "crowdstrike-falcon";

const client = new FalconClient({
    cloud: "us-1",
    clientId: "your-client-id",
    clientSecret: "your-client-secret",
    // Optional: identifies your integration while preserving the FalconJS version.
    userAgentOverride: "example-integration/1.0.0",
});

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

When userAgentOverride is set, FalconJS sends it before its own identifier. The example above produces example-integration/1.0.0 falconjs/0.7.0.

Documentation

About

CrowdStrike Falcon API JS library for the browser and Node

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

24 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages