-
Notifications
You must be signed in to change notification settings - Fork 112
/
kubernetes_protection.py
2055 lines (1704 loc) · 90.5 KB
/
kubernetes_protection.py
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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""CrowdStrike Falcon Kubernetes Protection API interface class.
_______ __ _______ __ __ __
| _ .----.-----.--.--.--.--| | _ | |_.----|__| |--.-----.
|. 1___| _| _ | | | | _ | 1___| _| _| | <| -__|
|. |___|__| |_____|________|_____|____ |____|__| |__|__|__|_____|
|: 1 | |: 1 |
|::.. . | CROWDSTRIKE FALCON |::.. . | FalconPy
`-------' `-------'
OAuth2 API - Customer SDK
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <https://unlicense.org>
"""
# pylint: disable=C0302, R0904
from typing import Dict, Union
from ._util import process_service_request, force_default, handle_single_argument
from ._service_class import ServiceClass
from ._endpoint._kubernetes_protection import _kubernetes_protection_endpoints as Endpoints
class KubernetesProtection(ServiceClass):
"""The only requirement to instantiate an instance of this class is one of the following.
- a valid client_id and client_secret provided as keywords.
- a credential dictionary with client_id and client_secret containing valid API credentials
{
"client_id": "CLIENT_ID_HERE",
"client_secret": "CLIENT_SECRET_HERE"
}
- a previously-authenticated instance of the authentication service class (oauth2.py)
- a valid token provided by the authentication service class (OAuth2.token())
"""
def read_clusters_by_date_range(self: object) -> Dict[str, Union[int, dict]]:
"""Retrieve clusters by date range counts.
Keyword arguments:
This method does not accept keyword arguments.
This method does not accept arguments.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadClustersByDateRangeCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadClustersByDateRangeCount"
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_clusters_by_version(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Bucket clusters by kubernetes version.
Keyword arguments:
filter -- Retrieve count of Kubernetes clusters that match a query in Falcon Query Language (FQL). String.
Supported filters:
access cluster_status
agent_status container_count
cid kubernetes_version
cloud_account_id last_seen
cloud_name management_status
cloud_region node_count
cluster_id pod_count
cluster_name tags
iar_coverage
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#
/kubernetes-protection/ReadClustersByKubernetesVersionCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadClustersByKubernetesVersionCount",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_clusters_by_status(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Bucket clusters by status.
Keyword arguments:
filter -- Retrieve count of Kubernetes clusters that match a query in Falcon Query Language (FQL). String.
Supported filters:
access cluster_status
agent_status container_count
cid kubernetes_version
cloud_account_id last_seen
cloud_name management_status
cloud_region node_count
cluster_id pod_count
cluster_name tags
iar_coverage
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadClustersByStatusCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadClustersByStatusCount",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_cluster_count(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Retrieve cluster counts.
Keyword arguments:
filter -- Retrieve count of Kubernetes clusters that match a query in Falcon Query Language (FQL). String.
Supported filters:
access cluster_status
agent_status container_count
cid kubernetes_version
cloud_account_id last_seen
cloud_name management_status
cloud_region node_count
cluster_id pod_count
cluster_name tags
iar_coverage
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadClusterCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadClusterCount",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_containers_by_date_range(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Retrieve containers by date range counts.
Keyword arguments:
filter -- Get container counts using a query in Falcon Query Language (FQL). String.
Supported filters:
agent_id image_vulnerability_count
agent_type insecure_mount_source
allow_privilege_escalation insecure_mount_type
cid insecure_propagation_mode
cloud_account_id interactive_mode
cloud_name ipv4
cloud_region ipv6
cluster_id labels
cluster_name last_seen
container_id namespace
container_name node_name
cve_id node_uid
detection_name package_name_version
first_seen pod_id
image_detection_count pod_name
image_digest port
image_has_been_assessed privileged
image_id root_write_access
image_registry run_as_root_group
image_repository run_as_root_user
image_tag running_status
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadContainersByDateRangeCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadContainersByDateRangeCount",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_containers_by_registry(self: object, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Retrieve top container image registries.
Keyword arguments:
under_assessment -- Flag indicating whether to return registries under assessment or not under assessment.
If not provided all registries are considered. Boolean. Defaults to False.
limit -- The upper-bound on the number of records to retrieve. Integer.
parameters -- Full parameters payload dictionary. Not required if using other keywords.
This method only supports keywords for providing arguments.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadContainerCountByRegistry
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadContainerCountByRegistry",
keywords=kwargs,
params=parameters
)
def read_zero_day_affected_counts(self: object) -> Dict[str, Union[int, dict]]:
"""Retrieve containers count affected by zero day vulnerabilities.
Keyword arguments:
This method does not accept keyword arguments.
This method does not accept arguments.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#
/kubernetes-protection/FindContainersCountAffectedByZeroDayVulnerabilities
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="FindContainersCountAffectedByZeroDayVulnerabilities"
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_vulnerable_container_count(self: object,
*args,
parameters: dict = None,
**kwargs
) -> Dict[str, Union[int, dict]]:
"""Retrieve count of vulnerable images running on containers.
Keyword arguments:
filter -- Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). String.
Supported filters:
agent_id image_vulnerability_count
agent_type insecure_mount_source
allow_privilege_escalation insecure_mount_type
cid insecure_propagation_mode
cloud_account_id interactive_mode
cloud_name ipv4
cloud_region ipv6
cluster_id labels
cluster_name last_seen
container_id namespace
container_name node_name
cve_id node_uid
detection_name package_name_version
first_seen pod_id
image_detection_count pod_name
image_digest port
image_has_been_assessed privileged
image_id root_write_access
image_registry run_as_root_group
image_repository run_as_root_user
image_tag running_status
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#
/kubernetes-protection/ReadVulnerableContainerImageCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadVulnerableContainerImageCount",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_container_counts(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Retrieve container counts.
Keyword arguments:
filter -- Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). String.
Supported filters:
agent_id image_vulnerability_count
agent_type insecure_mount_source
allow_privilege_escalation insecure_mount_type
cid insecure_propagation_mode
cloud_account_id interactive_mode
cloud_name ipv4
cloud_region ipv6
cluster_id labels
cluster_name last_seen
container_id namespace
container_name node_name
cve_id node_uid
detection_name package_name_version
first_seen pod_id
image_detection_count pod_name
image_digest port
image_has_been_assessed privileged
image_id root_write_access
image_registry run_as_root_group
image_repository run_as_root_user
image_tag running_status
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadContainerCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadContainerCount",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def find_containers_by_runtime_version(self: object, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Retrieve containers by container_runtime_version.
Keyword arguments:
limit -- The upper-bound on the number of container records to retrieve.
offset -- It is used to get the offset
sort -- Field to sort results by
filter -- Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). String.
Supported filters:
agent_id image_vulnerability_count
agent_type insecure_mount_source
allow_privilege_escalation insecure_mount_type
cid insecure_propagation_mode
cloud_account_id interactive_mode
cloud_name ipv4
cloud_region ipv6
cluster_id labels
cluster_name last_seen
container_id namespace
container_name node_name
cve_id node_uid
detection_name package_name_version
first_seen pod_id
image_detection_count pod_name
image_digest port
image_has_been_assessed privileged
image_id root_write_access
image_registry run_as_root_group
image_repository run_as_root_user
image_tag running_status
parameters -- Full parameters payload dictionary. Not required if using other keywords.
This method only supports keywords for providing arguments.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/FindContainersByContainerRunTimeVersion
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="FindContainersByContainerRunTimeVersion",
keywords=kwargs,
params=parameters
)
@force_default(defaults=["parameters"], default_types=["dict"])
def group_managed_containers(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Group the containers by Managed.
Keyword arguments:
filter -- Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). String.
Supported filters:
agent_id image_vulnerability_count
agent_type insecure_mount_source
allow_privilege_escalation insecure_mount_type
cid insecure_propagation_mode
cloud_account_id interactive_mode
cloud_name ipv4
cloud_region ipv6
cluster_id labels
cluster_name last_seen
container_id namespace
container_name node_name
cve_id node_uid
detection_name package_name_version
first_seen pod_id
image_detection_count pod_name
image_digest port
image_has_been_assessed privileged
image_id root_write_access
image_registry run_as_root_group
image_repository run_as_root_user
image_tag running_status
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/GroupContainersByManaged
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="GroupContainersByManaged",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_detections_count_by_date(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Retrieve count of image assessment detections on running containers over a period of time.
Keyword arguments:
filter -- Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). String.
Supported filters:
agent_id image_vulnerability_count
agent_type insecure_mount_source
allow_privilege_escalation insecure_mount_type
cid insecure_propagation_mode
cloud_account_id interactive_mode
cloud_name ipv4
cloud_region ipv6
cluster_id labels
cluster_name last_seen
container_id namespace
container_name node_name
cve_id node_uid
detection_name package_name_version
first_seen pod_id
image_detection_count pod_name
image_digest port
image_has_been_assessed privileged
image_id root_write_access
image_registry run_as_root_group
image_repository run_as_root_user
image_tag running_status
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#
/kubernetes-protection/ReadContainerImageDetectionsCountByDate
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadContainerImageDetectionsCountByDate",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_images_by_state(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Retrieve count of image states running on containers.
Keyword arguments:
filter -- Filter using a query in Falcon Query Language (FQL). String.
Supported filters: cid
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadContainerImagesByState
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadContainerImagesByState",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_sensor_coverage(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Bucket containers by agent type and calculate sensor coverage.
Keyword arguments:
filter -- Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). String.
Supported filters:
agent_id image_vulnerability_count
agent_type insecure_mount_source
allow_privilege_escalation insecure_mount_type
cid insecure_propagation_mode
cloud_account_id interactive_mode
cloud_name ipv4
cloud_region ipv6
cluster_id labels
cluster_name last_seen
container_id namespace
container_name node_name
cve_id node_uid
detection_name package_name_version
first_seen pod_id
image_detection_count pod_name
image_digest port
image_has_been_assessed privileged
image_id root_write_access
image_registry run_as_root_group
image_repository run_as_root_user
image_tag running_status
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadContainersSensorCoverage
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadContainersSensorCoverage",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_vulnerability_counts_by_severity(self: object,
*args,
parameters: dict = None,
**kwargs
) -> Dict[str, Union[int, dict]]:
"""Retrieve container vulnerabilities by severity counts.
Keyword arguments:
filter -- Get vulnerabilities count by severity for container using a query in Falcon Query Language (FQL). String.
Supported filters:
agent_id image_vulnerability_count
agent_type insecure_mount_source
allow_privilege_escalation insecure_mount_type
cid insecure_propagation_mode
cloud_account_id interactive_mode
cloud_name ipv4
cloud_region ipv6
cluster_id labels
cluster_name last_seen
container_id namespace
container_name node_name
cve_id node_uid
detection_name package_name_version
first_seen pod_id
image_detection_count pod_name
image_digest port
image_has_been_assessed privileged
image_id root_write_access
image_registry run_as_root_group
image_repository run_as_root_user
image_tag running_status
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#
/kubernetes-protection/ReadContainerVulnerabilitiesBySeverityCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadContainerVulnerabilitiesBySeverityCount",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
def read_deployment_counts_by_date_range(self: object) -> Dict[str, Union[int, dict]]:
"""Retrieve deployments by date range counts.
Keyword arguments:
This method does not accept keyword arguments.
This method does not accept arguments.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadDeploymentsByDateRangeCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadDeploymentsByDateRangeCount"
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_deployment_count(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Retrieve deployment counts.
Keyword arguments:
filter -- Retrieve count of Kubernetes deployments that match a query in Falcon Query Language (FQL). String.
Supported filters:
annotations_list deployment_id
cid deployment_name
cloud_account_id first_seen
cloud_name last_seen
cloud_region namespace
cluster_id pod_count
cluster_name
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadDeploymentCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadDeploymentCount",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_cluster_enrichment(self: object, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Retrieve cluster enrichment data.
Keyword arguments:
cluster_id -- One or more cluster ids for which to retrieve enrichment info
filter -- Supported filters: last_seen
parameters -- Full parameters payload dictionary. Not required if using other keywords.
This method only supports keywords for providing arguments.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadClusterEnrichment
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadClusterEnrichment",
keywords=kwargs,
params=parameters
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_node_enrichment(self: object, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Retrieve node enrichment data.
Keyword arguments:
node_name -- One or more node names for which to retrieve enrichment info
filter -- Supported filters: last_seen
parameters -- Full parameters payload dictionary. Not required if using other keywords.
This method only supports keywords for providing arguments.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadNodeEnrichment
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadNodeEnrichment",
keywords=kwargs,
params=parameters
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_distinct_image_count(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Retrieve count of distinct images running on containers.
Keyword arguments:
filter -- Search Kubernetes containers using a query in Falcon Query Language (FQL). String.
Supported filters:
agent_id image_vulnerability_count
agent_type insecure_mount_source
allow_privilege_escalation insecure_mount_type
cid insecure_propagation_mode
cloud_account_id interactive_mode
cloud_name ipv4
cloud_region ipv6
cluster_id labels
cluster_name last_seen
container_id namespace
container_name node_name
cve_id node_uid
detection_name package_name_version
first_seen pod_id
image_detection_count pod_name
image_digest port
image_has_been_assessed privileged
image_id root_write_access
image_registry run_as_root_group
image_repository run_as_root_user
image_tag running_status
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadDistinctContainerImageCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadDistinctContainerImageCount",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_images_by_most_used(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Bucket container by image-digest.
Keyword arguments:
filter -- Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). String.
Supported filters:
agent_id image_vulnerability_count
agent_type insecure_mount_source
allow_privilege_escalation insecure_mount_type
cid insecure_propagation_mode
cloud_account_id interactive_mode
cloud_name ipv4
cloud_region ipv6
cluster_id labels
cluster_name last_seen
container_id namespace
container_name node_name
cve_id node_uid
detection_name package_name_version
first_seen pod_id
image_detection_count pod_name
image_digest port
image_has_been_assessed privileged
image_id root_write_access
image_registry run_as_root_group
image_repository run_as_root_user
image_tag running_status
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadContainerImagesByMostUsed
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadContainerImagesByMostUsed",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_iom_count_by_date_range(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Return the count of Kubernetes IOMs by the date. by default it's for 7 days.
Keyword arguments:
filter -- Filter images using a query in Falcon Query Language (FQL). String.
Supported filters: cid, created_timestamp, detect_timestamp, prevented, severity
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadKubernetesIomByDateRange
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadKubernetesIomByDateRange",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_iom_count(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Return the total count of Kubernetes IOMs over the past seven days.
Keyword arguments:
filter -- Filter images using a query in Falcon Query Language (FQL). String.
Supported filters: cid, created_timestamp, detect_timestamp, prevented, severity
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadKubernetesIomCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadKubernetesIomCount",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_node_counts_by_cloud(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Bucket nodes by cloud providers.
Keyword arguments:
filter -- Search Kubernetes nodes using a query in Falcon Query Language (FQL). String.
Supported filters:
aid container_count
annotations_list container_runtime_version
cid first_seen
cloud_account_id image_digest
cloud_name ipv4
cloud_region last_seen
cluster_id node_name
cluster_name pod_count
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#/kubernetes-protection/ReadNodesByCloudCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadNodesByCloudCount",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_nodes_by_container_engine_version(self: object,
*args,
parameters: dict = None,
**kwargs
) -> Dict[str, Union[int, dict]]:
"""Bucket nodes by their container engine version.
Keyword arguments:
filter -- Search Kubernetes nodes using a query in Falcon Query Language (FQL). String.
Supported filters:
aid container_count
annotations_list container_runtime_version
cid first_seen
cloud_account_id image_digest
cloud_name ipv4
cloud_region last_seen
cluster_id node_name
cluster_name pod_count
parameters -- Full parameters payload dictionary. Not required if using other keywords.
Arguments: When not specified, the first argument to this method is assumed to be 'filter'.
All others are ignored.
Returns: dict object containing API response.
HTTP Method: GET
Swagger URL
https://assets.falcon.crowdstrike.com/support/api/swagger.html#
/kubernetes-protection/ReadNodesByContainerEngineVersionCount
"""
return process_service_request(
calling_object=self,
endpoints=Endpoints,
operation_id="ReadNodesByContainerEngineVersionCount",
keywords=kwargs,
params=handle_single_argument(args, parameters, "filter")
)
@force_default(defaults=["parameters"], default_types=["dict"])
def read_node_counts_by_date_range(self: object, *args, parameters: dict = None, **kwargs) -> Dict[str, Union[int, dict]]:
"""Retrieve nodes by date range counts.
Keyword arguments:
filter -- Search Kubernetes nodes using a query in Falcon Query Language (FQL). String.
Supported filters:
aid container_count