-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
1141 lines (1141 loc) · 31.9 KB
/
openapi.yaml
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
openapi: 3.0.0
info:
title: Swagger CrowdSec
description: CrowdSec local API
version: 1.0.0
contact:
email: contact@crowdsec.net
x-api-status-urls: false
servers:
- url: https://127.0.0.1/v1
- url: http://127.0.0.1/v1
tags:
- description: 'Operations about watchers : cscli & crowdsec'
name: watchers
- description: 'Operations about decisions : bans, captcha, rate-limit etc.'
name: Remediation component
paths:
/decisions/stream:
get:
tags:
- Remediation component
summary: getDecisionsStream
operationId: Bouncers_getDecisionsStream
security:
- APIKeyAuthorizer: []
description: >-
Returns a list of new/expired decisions. Intended for remediation
component that need to "stream" decisions
parameters:
- description: >-
If true, means that the remediation component is starting and a full
list must be provided
name: startup
in: query
required: false
schema:
type: boolean
- description: Comma separated scopes of decisions to fetch
name: scopes
in: query
required: false
schema:
type: string
- description: >-
Comma separated name of origins. If provided, then only the
decisions originating from provided origins would be returned.
name: origins
in: query
required: false
schema:
type: string
- description: >-
Comma separated words. If provided, only the decisions created by
scenarios containing any of the provided word would be returned.
name: scenarios_containing
in: query
required: false
schema:
type: string
- description: >-
Comma separated words. If provided, only the decisions created by
scenarios, not containing any of the provided word would be
returned.
name: scenarios_not_containing
in: query
required: false
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DecisionsStreamResponse'
'400':
description: 400 response
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
head:
tags:
- Remediation component
summary: GetDecisionsStream
operationId: Bouncers_getDecisionsStream
security:
- APIKeyAuthorizer: []
description: >-
Returns a list of new/expired decisions. Intended for remediation
component that need to "stream" decisions
parameters:
- description: >-
If true, means that the bouncer is starting and a full list must be
provided
name: startup
in: query
required: false
schema:
type: boolean
responses:
'200':
description: successful operation
headers: {}
'400':
description: 400 response
deprecated: false
/decisions:
get:
tags:
- Remediation component
summary: getDecisions
operationId: Bouncers_getInformation
description: Returns information about existing decisions
parameters:
- description: >-
scope to which the decision applies (ie.
IP/Range/Username/Session/...)
name: scope
in: query
required: false
schema:
type: string
- description: the value to match for in the specified scope
name: value
in: query
required: false
schema:
type: string
- description: type of decision
name: type
in: query
required: false
schema:
type: string
- description: IP to search for (shorthand for scope=ip&value=)
name: ip
in: query
required: false
schema:
type: string
- description: range to search for (shorthand for scope=range&value=)
name: range
in: query
required: false
schema:
type: string
- description: >-
indicate if you're looking for a decision that contains the value,
or that is contained within the value
name: contains
in: query
required: false
schema:
type: boolean
- description: >-
Comma separated name of origins. If provided, then only the
decisions originating from provided origins would be returned.
name: origins
in: query
required: false
schema:
type: string
- description: >-
Comma separated words. If provided, only the decisions created by
scenarios containing any of the provided word would be returned.
name: scenarios_containing
in: query
required: false
schema:
type: string
- description: >-
Comma separated words. If provided, only the decisions created by
scenarios, not containing any of the provided word would be
returned.
name: scenarios_not_containing
in: query
required: false
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GetDecisionsResponse'
'400':
description: 400 response
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
head:
tags:
- Remediation component
summary: GetDecisions
operationId: Bouncers_getInformation
security:
- APIKeyAuthorizer: []
description: Returns information about existing decisions
parameters:
- description: >-
scope to which the decision applies (ie.
IP/Range/Username/Session/...)
name: scope
in: query
required: false
schema:
type: string
- description: the value to match for in the specified scope
name: value
in: query
required: false
schema:
type: string
- description: type of decision
name: type
in: query
required: false
schema:
type: string
- description: IP to search for (shorthand for scope=ip&value=)
name: ip
in: query
required: false
schema:
type: string
- description: range to search for (shorthand for scope=range&value=)
name: range
in: query
required: false
schema:
type: string
- description: >-
indicate if you're looking for a decision that contains the value,
or that is contained within the value
name: contains
in: query
required: false
schema:
type: boolean
responses:
'200':
description: successful operation
'400':
description: 400 response
deprecated: false
delete:
tags:
- watchers
summary: deleteDecisions
operationId: Watchers_removeDecisions
security:
- JWTAuthorizer: []
description: Delete decisions(s) for given filters (only from cscli)
parameters:
- description: >-
scope to which the decision applies (ie.
IP/Range/Username/Session/...)
name: scope
in: query
required: false
schema:
type: string
- description: the value to match for in the specified scope
name: value
in: query
required: false
schema:
type: string
- description: type of decision
name: type
in: query
required: false
schema:
type: string
- description: IP to search for (shorthand for scope=ip&value=)
name: ip
in: query
required: false
schema:
type: string
- description: range to search for (shorthand for scope=range&value=)
name: range
in: query
required: false
schema:
type: string
- description: scenario to search
name: scenario
in: query
required: false
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDecisionResponse'
'400':
description: 400 response
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
/decisions/{decision_id}:
delete:
tags:
- watchers
summary: DeleteDecision
operationId: Watchers_removeDecisionById
security:
- JWTAuthorizer: []
description: Delete decision for given decision ID (only from cscli)
parameters:
- description: ''
name: decision_id
in: path
required: true
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDecisionResponse'
'404':
description: 404 response
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
/watchers:
post:
tags:
- watchers
summary: RegisterWatcher
operationId: Watchers_registerWatcher
description: This method is used when installing crowdsec (cscli->APIL)
requestBody:
description: Information about the watcher to be registered
content:
application/json:
schema:
$ref: '#/components/schemas/WatcherRegistrationRequest'
required: true
responses:
'201':
description: Watcher Created
headers: {}
'400':
description: 400 response
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
/watchers/login:
post:
tags:
- watchers
summary: AuthenticateWatcher
operationId: Watchers_authenticateSession
description: Authenticate current to get session ID
requestBody:
description: Information about the watcher to be reset
content:
application/json:
schema:
$ref: '#/components/schemas/WatcherAuthRequest'
required: true
responses:
'200':
description: Login successful
content:
application/json:
schema:
$ref: '#/components/schemas/WatcherAuthResponse'
'403':
description: 403 response
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
/alerts:
post:
tags:
- watchers
summary: pushAlerts
operationId: Watchers_createAlerts
security:
- JWTAuthorizer: []
description: Push alerts to API
requestBody:
description: Push alerts to the API
content:
application/json:
schema:
$ref: '#/components/schemas/AddAlertsRequest'
required: true
responses:
'201':
description: Alert(s) created
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AddAlertsResponse'
'400':
description: 400 response
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
get:
tags:
- watchers
summary: searchAlerts
operationId: Watchers_listAlerts
security:
- JWTAuthorizer: []
description: Allows to search for alerts
parameters:
- description: show alerts for this scope
name: scope
in: query
required: false
schema:
type: string
- description: show alerts for this value (used with scope)
name: value
in: query
required: false
schema:
type: string
- description: show alerts for this scenario
name: scenario
in: query
required: false
schema:
type: string
- description: IP to search for (shorthand for scope=ip&value=)
name: ip
in: query
required: false
schema:
type: string
- description: range to search for (shorthand for scope=range&value=)
name: range
in: query
required: false
schema:
type: string
- description: >-
search alerts newer than delay (format must be compatible with
time.ParseDuration)
name: since
in: query
required: false
schema:
type: string
format: date-time
- description: >-
search alerts older than delay (format must be compatible with
time.ParseDuration)
name: until
in: query
required: false
schema:
type: string
format: date-time
- description: >-
if set to true, decisions in simulation mode will be returned as
well
name: simulated
in: query
required: false
schema:
type: boolean
- description: only return alerts with decisions not expired yet
name: has_active_decision
in: query
required: false
schema:
type: boolean
- description: restrict results to alerts with decisions matching given type
name: decision_type
in: query
required: false
schema:
type: string
- description: number of alerts to return
name: limit
in: query
required: false
schema:
type: number
- description: restrict results to this origin (ie. lists,CAPI,cscli)
name: origin
in: query
required: false
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GetAlertsResponse'
'400':
description: 400 response
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
head:
tags:
- watchers
summary: searchAlerts
operationId: Watchers_searchAlerts
security:
- JWTAuthorizer: []
description: Allows to search for alerts
parameters:
- description: show alerts for this scope
name: scope
in: query
required: false
schema:
type: string
- description: show alerts for this value (used with scope)
name: value
in: query
required: false
schema:
type: string
- description: show alerts for this scenario
name: scenario
in: query
required: false
schema:
type: string
- description: IP to search for (shorthand for scope=ip&value=)
name: ip
in: query
required: false
schema:
type: string
- description: range to search for (shorthand for scope=range&value=)
name: range
in: query
required: false
schema:
type: string
- description: >-
search alerts newer than delay (format must be compatible with
time.ParseDuration)
name: since
in: query
required: false
schema:
type: string
format: date-time
- description: >-
search alerts older than delay (format must be compatible with
time.ParseDuration)
name: until
in: query
required: false
schema:
type: string
format: date-time
- description: >-
if set to true, decisions in simulation mode will be returned as
well
name: simulated
in: query
required: false
schema:
type: boolean
- description: only return alerts with decisions not expired yet
name: has_active_decision
in: query
required: false
schema:
type: boolean
- description: restrict results to alerts with decisions matching given type
name: decision_type
in: query
required: false
schema:
type: string
- description: number of alerts to return
name: limit
in: query
required: false
schema:
type: number
- description: restrict results to this origin (ie. lists,CAPI,cscli)
name: origin
in: query
required: false
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
'400':
description: 400 response
deprecated: false
delete:
tags:
- watchers
summary: deleteAlerts
operationId: Watchers_removeAlerts
security:
- JWTAuthorizer: []
description: Allows to delete alerts
parameters:
- description: delete alerts for this scope
name: scope
in: query
required: false
schema:
type: string
- description: delete alerts for this value (used with scope)
name: value
in: query
required: false
schema:
type: string
- description: delete alerts for this scenario
name: scenario
in: query
required: false
schema:
type: string
- description: delete Alerts with IP (shorthand for scope=ip&value=)
name: ip
in: query
required: false
schema:
type: string
- description: delete alerts concerned by range (shorthand for scope=range&value=)
name: range
in: query
required: false
schema:
type: string
- description: delete alerts added after YYYY-mm-DD-HH:MM:SS
name: since
in: query
required: false
schema:
type: string
format: date-time
- description: delete alerts added before YYYY-mm-DD-HH:MM:SS
name: until
in: query
required: false
schema:
type: string
format: date-time
- description: delete only alerts with decisions not expired yet
name: has_active_decision
in: query
required: false
schema:
type: boolean
- description: delete only alerts with matching source (ie. cscli/crowdsec)
name: alert_source
in: query
required: false
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAlertsResponse'
'400':
description: 400 response
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
/alerts/{alert_id}:
get:
tags:
- watchers
summary: GetAlertByID
operationId: Watchers_getAlertById
security:
- JWTAuthorizer: []
description: Get alert by ID
parameters:
- description: ''
name: alert_id
in: path
required: true
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Alert'
'400':
description: 400 response
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
head:
tags:
- watchers
summary: GetAlertByID
operationId: Watchers_getAlertById
security:
- JWTAuthorizer: []
description: Get alert by ID
parameters:
- description: ''
name: alert_id
in: path
required: true
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
'400':
description: 400 response
deprecated: false
delete:
tags:
- watchers
summary: DeleteAlert
operationId: Watchers_deleteAlertById
security:
- JWTAuthorizer: []
description: Delete alert for given alert ID (only from cscli)
parameters:
- description: ''
name: alert_id
in: path
required: true
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAlertsResponse'
'404':
description: 404 response
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
components:
securitySchemes:
JWTAuthorizer:
type: apiKey
name: 'Authorization: Bearer'
in: header
APIKeyAuthorizer:
type: apiKey
name: X-Api-Key
in: header
schemas:
WatcherRegistrationRequest:
title: WatcherRegistrationRequest
type: object
properties:
machine_id:
type: string
password:
type: string
format: password
required:
- machine_id
- password
WatcherAuthRequest:
title: WatcherAuthRequest
type: object
properties:
machine_id:
type: string
password:
type: string
format: password
scenarios:
description: the list of scenarios enabled on the watcher
type: array
items:
type: string
required:
- machine_id
- password
WatcherAuthResponse:
title: WatcherAuthResponse
description: the response of a successful authentication
type: object
properties:
code:
type: integer
expire:
type: string
token:
type: string
Alert:
title: Alert
type: object
properties:
id:
description: only relevant for GET, ignored in POST requests
type: integer
readOnly: true
uuid:
description: >-
only relevant for LAPI->CAPI, ignored for cscli->LAPI and
crowdsec->LAPI
type: string
readOnly: true
machine_id:
description: >-
only relevant for LAPI->CAPI, ignored for cscli->LAPI and
crowdsec->LAPI
type: string
readOnly: true
created_at:
description: only relevant for GET, ignored in POST requests
type: string
readOnly: true
scenario:
type: string
scenario_hash:
type: string
scenario_version:
type: string
message:
description: a human readable message
type: string
events_count:
type: integer
format: int32
start_at:
type: string
stop_at:
type: string
capacity:
type: integer
format: int32
leakspeed:
type: string
simulated:
type: boolean
events:
description: the Meta of the events leading to overflow
type: array
items:
$ref: '#/components/schemas/Event'
remediation:
type: boolean
decisions:
type: array
items:
$ref: '#/components/schemas/Decision'
source:
$ref: '#/components/schemas/Source'
meta:
$ref: '#/components/schemas/Meta'
labels:
type: array
items:
type: string
required:
- scenario
- scenario_hash
- scenario_version
- message
- events_count
- start_at
- stop_at
- capacity
- leakspeed
- simulated
- events
- source
Source:
title: Source
type: object
properties:
scope:
description: 'the scope of a source : ip,range,username,etc'
type: string
value:
description: 'the value of a source : the ip, the range, the username,etc'
type: string
ip:
description: provided as a convenience when the source is an IP
type: string
range:
description: provided as a convenience when the source is an IP
type: string
as_number:
description: provided as a convenience when the source is an IP
type: string
as_name:
description: provided as a convenience when the source is an IP
type: string
cn:
type: string
latitude:
type: number
format: float
longitude:
type: number
format: float
required:
- scope
- value
Metrics:
title: Metrics
type: object
properties:
apil_version:
description: the local version of crowdsec/apil
type: string
bouncers:
type: array
items:
$ref: '#/components/schemas/MetricsBouncerInfo'
machines:
type: array
items:
$ref: '#/components/schemas/MetricsAgentInfo'
required:
- apil_version
- bouncers
- machines
MetricsBouncerInfo:
title: MetricsBouncerInfo
description: >-
Software version info (so we can warn users about out-of-date software).
The software name and the version are "guessed" from the user-agent
type: object
properties:
version:
description: software version
type: string
custom_name:
description: name of the component
type: string
name:
description: bouncer type (firewall, php ...)
type: string
last_pull:
description: last bouncer pull date
type: string
MetricsAgentInfo:
title: MetricsAgentInfo
description: >-
Software version info (so we can warn users about out-of-date software).
The software name and the version are "guessed" from the user-agent
type: object
properties:
version: