Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.3.2 dev #217

Merged
merged 6 commits into from
Sep 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,8 @@
/node_modules/
/specs/*
!/specs/transformation.*
/src/tests/*
/src/test.ts
typings
*.js
.DS_Store
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ npm install crowdstrike-falcon

## Exemplary use

With falconjs, there are two ways to call CrowdStrike API service collections. You can use the FalconClient object, which has always been available, or you can use the new Falcon object, which behaves like the API Harness, or UberClass, from FalconPy.

### FalconClient

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

Expand All @@ -37,6 +41,31 @@ await client.sensorDownload
console.log("my CCID: ", value);
});
```
## Falcon
when using request body properties:
```js
const body = { ids: ["123", "456", "789"]}
try {
detDetails = await falcon.command("GetDetectSummaries", body)
return detDetails
} catch (error) {
console.log(error)
return
}
```

when using query params:
```js
const params = { filter: "score:<=75"}
const args = {"getAssessmentsByScoreV1", params }
try {
ztaDetails = await falcon.command(args)
return ztaDetails
} catch(error) {
console.log(error)
return
}
```

## Documentation

Expand Down
Loading
Loading