Skip to content

README.md

Latest commit

 

History

History
101 lines (64 loc) · 3.95 KB

README.md

File metadata and controls

101 lines (64 loc) · 3.95 KB
Raw

CrowdStrike Falcon

$SAMPLE_NAME sample Foundry app

The $SAMPLE_NAME sample Foundry app is a community-driven, open source project which serves as an example of an app which can be built using CrowdStrike's Foundry ecosystem. $REPOSITORY_NAME is an open source project, not a CrowdStrike product. As such, it carries no formal support, expressed or implied.

This app is one of several App Templates included in Foundry that you can use to jumpstart your development. It comes complete with a set of preconfigured capabilities aligned to its business purpose. Deploy this app from the Templates page with a single click in the Foundry UI, or create an app from this template using the CLI.

Important

To view documentation and deploy this sample app, you need access to the Falcon console.

Description

A description of this app's use case and what it does.

Prerequisites

  • The Foundry CLI (instructions below).
  • Delete or add tools below as required. These are from other samples.
  • Python 3.13+ (needed if modifying the app's functions). See Python For Beginners for installation instructions.
  • Go v1.25+ (needed if modifying the app's functions). See https://go.dev/learn for installation instructions.
  • Yarn (needed if modifying the app's UI). See https://yarnpkg.com/getting-started for installation instructions.

Install the Foundry CLI

You can install the Foundry CLI with Scoop on Windows or Homebrew on Linux/macOS.

Windows:

Install Scoop. Then, add the Foundry CLI bucket and install the Foundry CLI.

scoop bucket add foundry https://github.com/crowdstrike/scoop-foundry-cli.git
scoop install foundry

Or, you can download the latest Windows zip file, expand it, and add the install directory to your PATH environment variable.

Linux and macOS:

Install Homebrew. Then, add the Foundry CLI repository to the list of formulae that Homebrew uses and install the CLI:

brew tap crowdstrike/foundry-cli
brew install crowdstrike/foundry-cli/foundry

Run foundry version to verify it's installed correctly.

Getting Started

Clone this sample to your local system, or download as a zip file and import it into Foundry.

git clone https://github.com/CrowdStrike/$REPOSITORY_NAME
cd $REPOSITORY_NAME

Log in to Foundry:

foundry login

Select the following permissions:

  • Create and run RTR scripts
  • Create, execute and test workflow templates
  • Create, run and view API integrations
  • Create, edit, delete, and list queries

Deploy the app:

foundry apps deploy

Tip

If you get an error that the name already exists, change the name to something unique to your CID in manifest.yml.

Once the deployment has finished, you can release the app:

foundry apps release

Next, go to Foundry > App catalog, find your app, and install it. Go to Fusion SOAR > Workflows to see the scheduled workflow from this app.

About this sample app

Describe your app and its components.

Foundry resources


WE STOP BREACHES