search

CrowdStrike / falconpy

The CrowdStrike Falcon SDK for Python
https://www.falconpy.io
The Unlicense
360 stars 116 forks source link

[ DOC ] Report Executions method incorrectly lists allowing multiple 'ids' values #588

Closed tsullivan06 closed 2 years ago

tsullivan06 commented 2 years ago

Documentation page topic Using the Report Executions service collection: report_executions_download_get

Describe the error or typo The examples show the report_execution_download_get ids field containing multiple IDs: id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']

This is inaccurate as one 1 report ID can be retrieved at a time, per documentation in the Falcon UI: _idsrequired | string | query | The unique ID of the report execution you want to download. Multiple IDs in a single request are not supported. (https://falcon.crowdstrike.com/documentation/211/scheduled-reports-searches-apis#download-report-file-by-execution-id)

Providing multiple IDs will result in the following response: 'errors': [{'code': 400, 'message': "The 'ids' field may only be given once."}]}}

Documentation repository:

Additional context Add any other context about the problem here.

jshcodes commented 2 years ago

Documentation has been updated within the wiki and synced to falconpy.io to reflect this change. Please allow up to an hour for these changes to replicate out to your edge location.