rusty_falcon 0.4.0

Rust bindings for CrowdStrike Falcon API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437

# \FoundryLogscaleApi

All URIs are relative to *<https://api.crowdstrike.com>*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_saved_searches_dynamic_execute_alt_v1**](FoundryLogscaleApi.md#create_saved_searches_dynamic_execute_alt_v1) | **POST** /loggingapi/entities/saved-searches-dynamic-execute/v1 | Execute a dynamic saved search
[**create_saved_searches_dynamic_execute_v1**](FoundryLogscaleApi.md#create_saved_searches_dynamic_execute_v1) | **POST** /loggingapi/entities/saved-searches/execute-dynamic/v1 | Execute a dynamic saved search
[**create_saved_searches_execute_alt_v1**](FoundryLogscaleApi.md#create_saved_searches_execute_alt_v1) | **POST** /loggingapi/entities/saved-searches-execute/v1 | Execute a saved search
[**create_saved_searches_execute_v1**](FoundryLogscaleApi.md#create_saved_searches_execute_v1) | **POST** /loggingapi/entities/saved-searches/execute/v1 | Execute a saved search
[**create_saved_searches_ingest_alt_v1**](FoundryLogscaleApi.md#create_saved_searches_ingest_alt_v1) | **POST** /loggingapi/entities/saved-searches-ingest/v1 | Populate a saved search
[**create_saved_searches_ingest_v1**](FoundryLogscaleApi.md#create_saved_searches_ingest_v1) | **POST** /loggingapi/entities/saved-searches/ingest/v1 | Populate a saved search
[**get_saved_searches_execute_alt_v1**](FoundryLogscaleApi.md#get_saved_searches_execute_alt_v1) | **GET** /loggingapi/entities/saved-searches-execute/v1 | Get the results of a saved search
[**get_saved_searches_execute_v1**](FoundryLogscaleApi.md#get_saved_searches_execute_v1) | **GET** /loggingapi/entities/saved-searches/execute/v1 | Get the results of a saved search
[**get_saved_searches_job_results_download_alt_v1**](FoundryLogscaleApi.md#get_saved_searches_job_results_download_alt_v1) | **GET** /loggingapi/entities/saved-searches-job-results-download/v1 | Get the results of a saved search as a file
[**get_saved_searches_job_results_download_v1**](FoundryLogscaleApi.md#get_saved_searches_job_results_download_v1) | **GET** /loggingapi/entities/saved-searches/job-results-download/v1 | Get the results of a saved search as a file
[**ingest_data_async_v1**](FoundryLogscaleApi.md#ingest_data_async_v1) | **POST** /loggingapi/entities/data-ingestion/ingest-async/v1 | Asynchronously ingest data into the application repository
[**ingest_data_v1**](FoundryLogscaleApi.md#ingest_data_v1) | **POST** /loggingapi/entities/data-ingestion/ingest/v1 | Synchronously ingest data into the application repository
[**list_repos_v1**](FoundryLogscaleApi.md#list_repos_v1) | **GET** /loggingapi/combined/repos/v1 | Lists available repositories and views
[**list_view_v1**](FoundryLogscaleApi.md#list_view_v1) | **GET** /loggingapi/entities/views/v1 | List views

## create_saved_searches_dynamic_execute_alt_v1

> models::ApidomainPeriodQueryResponseWrapperV1 create_saved_searches_dynamic_execute_alt_v1(body, app_id, include_schema_generation, include_test_data, infer_json_types, match_response_schema, metadata, mode)
Execute a dynamic saved search

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | [**ApidomainPeriodDynamicExecuteSearchRequestV1**](ApidomainPeriodDynamicExecuteSearchRequestV1.md) |  | [required] |
**app_id** | Option<**String**> | Application ID. |  |
**include_schema_generation** | Option<**bool**> | Include generated schemas in the response |  |[default to false]
**include_test_data** | Option<**bool**> | Include test data when executing searches |  |[default to false]
**infer_json_types** | Option<**bool**> | Whether to try to infer data types in json event response instead of returning map[string]string |  |[default to false]
**match_response_schema** | Option<**bool**> | Whether to validate search results against their schema |  |[default to false]
**metadata** | Option<**bool**> | Whether to include metadata in the response |  |[default to false]
**mode** | Option<**String**> | Mode to execute the query under. |  |

### Return type

[**models::ApidomainPeriodQueryResponseWrapperV1**](apidomain.QueryResponseWrapperV1.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## create_saved_searches_dynamic_execute_v1

> models::ApidomainPeriodQueryResponseWrapperV1 create_saved_searches_dynamic_execute_v1(body, app_id, include_schema_generation, include_test_data, infer_json_types, match_response_schema, metadata, mode)
Execute a dynamic saved search

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | [**ApidomainPeriodDynamicExecuteSearchRequestV1**](ApidomainPeriodDynamicExecuteSearchRequestV1.md) |  | [required] |
**app_id** | Option<**String**> | Application ID. |  |
**include_schema_generation** | Option<**bool**> | Include generated schemas in the response |  |[default to false]
**include_test_data** | Option<**bool**> | Include test data when executing searches |  |[default to false]
**infer_json_types** | Option<**bool**> | Whether to try to infer data types in json event response instead of returning map[string]string |  |[default to false]
**match_response_schema** | Option<**bool**> | Whether to validate search results against their schema |  |[default to false]
**metadata** | Option<**bool**> | Whether to include metadata in the response |  |[default to false]
**mode** | Option<**String**> | Mode to execute the query under. |  |

### Return type

[**models::ApidomainPeriodQueryResponseWrapperV1**](apidomain.QueryResponseWrapperV1.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## create_saved_searches_execute_alt_v1

> models::ApidomainPeriodQueryResponseWrapperV1 create_saved_searches_execute_alt_v1(body, app_id, detailed, include_test_data, infer_json_types, match_response_schema, metadata)
Execute a saved search

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | [**ApidomainPeriodSavedSearchExecuteRequestV1**](ApidomainPeriodSavedSearchExecuteRequestV1.md) |  | [required] |
**app_id** | Option<**String**> | Application ID. |  |
**detailed** | Option<**bool**> | Whether to include search field details |  |[default to false]
**include_test_data** | Option<**bool**> | Include test data when executing searches |  |[default to false]
**infer_json_types** | Option<**bool**> | Whether to try to infer data types in json event response instead of returning map[string]string |  |[default to false]
**match_response_schema** | Option<**bool**> | Whether to validate search results against their schema |  |[default to false]
**metadata** | Option<**bool**> | Whether to include metadata in the response |  |[default to false]

### Return type

[**models::ApidomainPeriodQueryResponseWrapperV1**](apidomain.QueryResponseWrapperV1.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## create_saved_searches_execute_v1

> models::ApidomainPeriodQueryResponseWrapperV1 create_saved_searches_execute_v1(body, app_id, detailed, include_test_data, infer_json_types, match_response_schema, metadata)
Execute a saved search

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | [**ApidomainPeriodSavedSearchExecuteRequestV1**](ApidomainPeriodSavedSearchExecuteRequestV1.md) |  | [required] |
**app_id** | Option<**String**> | Application ID. |  |
**detailed** | Option<**bool**> | Whether to include search field details |  |[default to false]
**include_test_data** | Option<**bool**> | Include test data when executing searches |  |[default to false]
**infer_json_types** | Option<**bool**> | Whether to try to infer data types in json event response instead of returning map[string]string |  |[default to false]
**match_response_schema** | Option<**bool**> | Whether to validate search results against their schema |  |[default to false]
**metadata** | Option<**bool**> | Whether to include metadata in the response |  |[default to false]

### Return type

[**models::ApidomainPeriodQueryResponseWrapperV1**](apidomain.QueryResponseWrapperV1.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## create_saved_searches_ingest_alt_v1

> models::ClientPeriodDataIngestResponseWrapperV1 create_saved_searches_ingest_alt_v1(app_id)
Populate a saved search

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_id** | Option<**String**> | Application ID. |  |

### Return type

[**models::ClientPeriodDataIngestResponseWrapperV1**](client.DataIngestResponseWrapperV1.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## create_saved_searches_ingest_v1

> models::ClientPeriodDataIngestResponseWrapperV1 create_saved_searches_ingest_v1(app_id)
Populate a saved search

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_id** | Option<**String**> | Application ID. |  |

### Return type

[**models::ClientPeriodDataIngestResponseWrapperV1**](client.DataIngestResponseWrapperV1.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## get_saved_searches_execute_alt_v1

> models::ApidomainPeriodQueryResponseWrapperV1 get_saved_searches_execute_alt_v1(job_id, app_id, infer_json_types, job_status_only, limit, match_response_schema, metadata, offset)
Get the results of a saved search

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**job_id** | **String** | Job ID for a previously executed async query | [required] |
**app_id** | Option<**String**> | Application ID. |  |
**infer_json_types** | Option<**bool**> | Whether to try to infer data types in json event response instead of returning map[string]string |  |[default to false]
**job_status_only** | Option<**bool**> | If set to true, result rows are dropped from the response and only the job status is returned |  |[default to false]
**limit** | Option<**String**> | Maximum number of records to return. |  |
**match_response_schema** | Option<**bool**> | Whether to validate search results against their schema |  |[default to false]
**metadata** | Option<**bool**> | Whether to include metadata in the response |  |[default to false]
**offset** | Option<**String**> | Starting pagination offset of records to return. |  |

### Return type

[**models::ApidomainPeriodQueryResponseWrapperV1**](apidomain.QueryResponseWrapperV1.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## get_saved_searches_execute_v1

> models::ApidomainPeriodQueryResponseWrapperV1 get_saved_searches_execute_v1(job_id, app_id, infer_json_types, job_status_only, limit, match_response_schema, metadata, offset)
Get the results of a saved search

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**job_id** | **String** | Job ID for a previously executed async query | [required] |
**app_id** | Option<**String**> | Application ID. |  |
**infer_json_types** | Option<**bool**> | Whether to try to infer data types in json event response instead of returning map[string]string |  |[default to false]
**job_status_only** | Option<**bool**> | If set to true, result rows are dropped from the response and only the job status is returned |  |[default to false]
**limit** | Option<**String**> | Maximum number of records to return. |  |
**match_response_schema** | Option<**bool**> | Whether to validate search results against their schema |  |[default to false]
**metadata** | Option<**bool**> | Whether to include metadata in the response |  |[default to false]
**offset** | Option<**String**> | Starting pagination offset of records to return. |  |

### Return type

[**models::ApidomainPeriodQueryResponseWrapperV1**](apidomain.QueryResponseWrapperV1.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## get_saved_searches_job_results_download_alt_v1

> std::path::PathBuf get_saved_searches_job_results_download_alt_v1(job_id, infer_json_types, result_format)
Get the results of a saved search as a file

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**job_id** | **String** | Job ID for a previously executed async query | [required] |
**infer_json_types** | Option<**bool**> | Whether to try to infer data types in json event response instead of returning map[string]string |  |[default to false]
**result_format** | Option<**String**> | Result Format |  |

### Return type

[**std::path::PathBuf**](std::path::PathBuf.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/octet-stream, text/csv, application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## get_saved_searches_job_results_download_v1

> std::path::PathBuf get_saved_searches_job_results_download_v1(job_id, infer_json_types, result_format)
Get the results of a saved search as a file

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**job_id** | **String** | Job ID for a previously executed async query | [required] |
**infer_json_types** | Option<**bool**> | Whether to try to infer data types in json event response instead of returning map[string]string |  |[default to false]
**result_format** | Option<**String**> | Result Format |  |

### Return type

[**std::path::PathBuf**](std::path::PathBuf.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/octet-stream, text/csv, application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## ingest_data_async_v1

> models::ClientPeriodDataIngestResponseWrapperV1 ingest_data_async_v1(data_content, data_file, repo, tag, tag_source, test_data)
Asynchronously ingest data into the application repository

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**data_content** | Option<**String**> | JSON data to ingest |  |
**data_file** | Option<**std::path::PathBuf**> | Data file to ingest |  |
**repo** | Option<**String**> | Repository name if not part of a foundry app |  |
**tag** | Option<[**Vec<String>**](String.md)> | Custom tag for ingested data in the form tag:value |  |
**tag_source** | Option<**String**> | Tag the data with the specified source |  |
**test_data** | Option<**bool**> | Tag the data with test-ingest |  |[default to false]

### Return type

[**models::ClientPeriodDataIngestResponseWrapperV1**](client.DataIngestResponseWrapperV1.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: multipart/form-data
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## ingest_data_v1

> models::ClientPeriodDataIngestResponseWrapperV1 ingest_data_v1(data_content, data_file, tag, tag_source, test_data)
Synchronously ingest data into the application repository

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**data_content** | Option<**String**> | JSON data to ingest |  |
**data_file** | Option<**std::path::PathBuf**> | Data file to ingest |  |
**tag** | Option<[**Vec<String>**](String.md)> | Custom tag for ingested data in the form tag:value |  |
**tag_source** | Option<**String**> | Tag the data with the specified source |  |
**test_data** | Option<**bool**> | Tag the data with test-ingest |  |[default to false]

### Return type

[**models::ClientPeriodDataIngestResponseWrapperV1**](client.DataIngestResponseWrapperV1.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: multipart/form-data
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## list_repos_v1

> models::ApidomainPeriodRepoViewListItemWrapperV1 list_repos_v1(check_test_data)
Lists available repositories and views

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**check_test_data** | Option<**bool**> | Include whether test data is present in the application repository |  |[default to false]

### Return type

[**models::ApidomainPeriodRepoViewListItemWrapperV1**](apidomain.RepoViewListItemWrapperV1.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

## list_view_v1

> models::ApidomainPeriodRepoViewListItemWrapperV1 list_view_v1(check_test_data)
List views

### Parameters

Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**check_test_data** | Option<**bool**> | Include whether test data is present in the application repository |  |[default to false]

### Return type

[**models::ApidomainPeriodRepoViewListItemWrapperV1**](apidomain.RepoViewListItemWrapperV1.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)