Skip to content

Commit 4a8921d

Browse files
authored
Update NGSIEM start_search keyword guidance for FalconPy 1.6.5 (#85)
* Update NGSIEM start_search keyword guidance for FalconPy 1.6.5 * Revert inline comment edit to stay within skill size budget The two-line version note pushed functions-falcon-api to 5513 tokens, over the 5500 budget. The original one-liner defers to the keyword section below, which already carries the explanation.
1 parent 00b13e6 commit 4a8921d

2 files changed

Lines changed: 5 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/), and this
1313
- **Agent Plugins manifest** — A root `plugin.json` following the [Agent Plugins](https://agent-plugins.org) 1.0.0 spec, so any conforming client recognizes the repo as a plugin. It sits alongside the Claude and Codex manifests. CI validates it and `release.sh` bumps its version with the rest.
1414
- US-3 cloud region to the cloud-region documentation: added `us-3` to the `FOUNDRY_CLOUD_REGION` value lists (headless-operation reference, e2e-testing env var table) and the multi-cloud deployment section. Foundry CLI 2.0.2 added US-3 support; the base URL (`api.us-3.crowdstrike.com`) is in FalconPy as of v1.6.4.
1515

16+
### Changed
17+
18+
- **NGSIEM `start_search` keyword guidance updated for FalconPy 1.6.5** — The `search=` keyword remains the recommended approach (works on all versions), but the explanation now notes that `body=` was fixed in FalconPy 1.6.5 ([#1497](https://github.com/CrowdStrike/falconpy/pull/1497)). Since FalconPy is unpinned, `search=` is still the safe default.
19+
1620
### Fixed
1721

1822
- **`connection issue` on tenant commands (Codex)** — Codex confines writes to the workspace, so the CLI cannot write `~/.config/foundry/token.json`, where it keeps its short-lived access token. The CLI reports only the symptom, which sent agents off investigating networks and credentials. The debugging skill now explains that the roughly 30-minute token refresh is expected, and that the fix is to request write access to that one directory and retry. Any assistant with a workspace-scoped sandbox can hit this. Codex is where it was observed.

skills/functions-falcon-api/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ if __name__ == '__main__':
277277

278278
### The `search=` Keyword Gotcha
279279

280-
**CRITICAL:** Pass the query payload as `search=`, not `body=`. FalconPy's guard reads only `kwargs.get("search")`, so `body=` returns a local error without issuing a request. The docstring lists `body` as accepted, but the guard ignores it ([falconpy#1491](https://github.com/CrowdStrike/falconpy/issues/1491)).
280+
**Use `search=`.** It works on every FalconPy version. `body=` was silently ignored before 1.6.5 ([falconpy#1491](https://github.com/CrowdStrike/falconpy/issues/1491), fixed in [#1497](https://github.com/CrowdStrike/falconpy/pull/1497)). Since FalconPy is unpinned, `search=` is the safe default.
281281

282282
Response keys are asymmetric: `start_search` renames its payload to `resources` (read `started["resources"]["id"]`), while `get_search_status` does not (read `status["body"]`).
283283

0 commit comments

Comments
 (0)