forked from Shuffle/openapi-apps
-
Notifications
You must be signed in to change notification settings - Fork 0
/
misp.yaml
8924 lines (8343 loc) · 259 KB
/
misp.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:
version: 2.4.148
title: MISP Automation API
description: |
### Getting Started
Automation functionality is designed to automatically generate signatures for intrusion detection systems.
To enable signature generation for a given attribute, Signature field of this attribute must be set to Yes.
Note that not all attribute types are applicable for signature generation, currently we only support NIDS signature
generation for IP, domains, host names, user agents etc., and hash list generation for MD5/SHA1 values of file artefacts.
Support for more attribute types is planned. To make this functionality available for automated tools an authentication
key is used. This makes it easier for your tools to access the data without further form-based-authentication.
The [API](https://www.circl.lu/doc/misp/GLOSSARY.html#api) key can be found and managed under My Profile page (/users/view/me)
on a MISP instance.
#### Accept and Content-Type headers
When performing your request, depending on the type of request, you might need to explicitly specify in what content
type you want to get your results. This is done by setting one of the below `Accept` headers:
Accept: application/json
Accept: application/xml
When submitting data in a `POST`, `PUT` or `DELETE` operation you also need to specify in what content-type you encoded the payload.
This is done by setting one of the below `Content-Type` headers:
Content-Type: application/json
Content-Type: application/xml
Example:
```
curl --header "Authorization: YOUR_API_KEY" \
--header "Accept: application/json" \
--header "Content-Type: application/json" https://<misp url>/
```
> **NOTE**: By appending .json or .xml the content type can also be set without the need for a header.
#### Automation using PyMISP
[PyMISP](https://github.com/MISP/PyMISP) is a Python library to access MISP platforms via their REST [API](https://www.circl.lu/doc/misp/GLOSSARY.html#api).
It allows you to fetch events, add or update events/attributes, add or update samples or search for attributes.
### FAQ
* [Dev FAQ](https://www.circl.lu/doc/misp/dev-faq/)
* [GitHub project FAQ](https://github.com/MISP/MISP/wiki/Frequently-Asked-Questions)
servers:
- url: https://misp.local
tags:
- name: Attributes
description: "Attributes in MISP can be network indicators (e.g. IP address), system indicators (e.g. a string in memory) or even bank account details."
externalDocs:
url: https://www.circl.lu/doc/misp/GLOSSARY.html#misp-attribute
- name: Events
description: "MISP events are encapsulations for contextually related information represented as attributes and objects."
externalDocs:
url: https://www.circl.lu/doc/misp/GLOSSARY.html#misp-event
- name: Galaxies
description: "Galaxies in MISP are a method used to express a large object called cluster that can be attached to MISP events or attributes."
externalDocs:
url: https://www.circl.lu/doc/misp/galaxy/
- name: Galaxy Clusters
description: "A galaxy cluster that can be attached to MISP events or attributes."
externalDocs:
url: https://www.circl.lu/doc/misp/galaxy/
- name: Users
description: "As an admin (not to be confused with Org Admin), you can set up new accounts for users, edit user profiles, delete them, or just have a look at all the viewers' profiles."
externalDocs:
url: https://www.circl.lu/doc/misp/administration/#users
- name: Organisations
description: "Each users belongs to an organisation. As admin, you can manage these organisations."
externalDocs:
url: https://www.circl.lu/doc/misp/administration/#organisations
- name: Servers
description: "Servers represent MISP instances we are connected to and from which we can pull/push data from/to."
externalDocs:
url: https://www.circl.lu/doc/misp/sharing/
- name: Sharing Groups
description: "Sharing groups in MISP are a more granular way to create re-usable distribution lists for events/attributes that allow users to include organisations from their own instance (local organisations) as well as organisations from directly, or indirectly connected instances (external organisations)."
externalDocs:
url: https://www.circl.lu/doc/misp/sharing/#sharing-groups
- name: Feeds
description: "Feeds are remote or local resources containing indicators that can be automatically imported into MISP at regular intervals. Feeds can be structured in [MISP format](https://www.circl.lu/doc/misp/GLOSSARY.html#misp-format), CSV format or even free-text format."
externalDocs:
url: https://www.circl.lu/doc/misp/managing-feeds/#feeds
- name: Objects
description: "MISP objects are in addition to MISP attributes to allow advanced combinations and concatenation of attributes. The creation of these objects and their associated attributes are based on real cyber security use-cases and existing practices in information sharing."
externalDocs:
url: https://www.circl.lu/doc/misp/misp-objects/
- name: Tags
description: ""
externalDocs:
url: https://www.circl.lu/doc/misp/quick-start/#tags-and-taglist
- name: Sightings
description: "Sightings is a system allowing people to react on attributes on an event. It was originally designed to provide an easy method for user to tell when they see a given attribute, giving it more credibility."
externalDocs:
url: https://www.circl.lu/doc/misp/sightings/
- name: Warninglists
description: "MISP warninglists are lists of well-known indicators that can be associated to potential false positives, errors or mistakes."
externalDocs:
url: https://www.circl.lu/doc/misp/warninglists/
- name: Noticelists
description: "Notice lists to inform MISP users of the legal, privacy, policy or even technical implications of using specific attributes, categories or objects."
externalDocs:
url: https://www.circl.lu/doc/misp/noticelists/
- name: Logs
description: "Users with audit permissions are able to browse or search logs that MISP automatically appends each time certain actions are taken (actions that modify data or if a user logs in and out)."
externalDocs:
url: https://www.circl.lu/doc/misp/administration/#using-misp-logs
- name: AuthKeys
description: "AuthKeys are used to authenticate MISP API requests. AuthKeys can be set to read-only, a single user can have multiple auth keys."
externalDocs:
url: https://www.circl.lu/doc/misp/automation/#automation-key
- name: UserSettings
description: "User settings enables users to customize different MISP features, such as UI elements and default API behaviors."
- name: Taxonomies
description: "MISP Taxonomies is a set of common classification libraries to tag, classify and organise information. Taxonomy allows to express the same vocabulary among a distributed set of users and organisations."
externalDocs:
url: https://www.circl.lu/doc/misp/taxonomy/#taxonomies
paths:
/attributes/restSearch:
post:
summary: "[restSearch] Get a filtered and paginated list of attributes"
description: |
**This is the recommended endpoint for searching attributes.**
operationId: restSearchAttributes
tags:
- Attributes
requestBody:
$ref: "#/components/requestBodies/RestSearchAttributesRequest"
responses:
"200":
$ref: "#/components/responses/AttributesRestSearchResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/attributes/add/{eventId}:
post:
summary: "Add an attribute"
operationId: addAttribute
tags:
- Attributes
parameters:
- $ref: "#/components/parameters/eventIdParameter"
requestBody:
$ref: "#/components/requestBodies/AddAttributeRequest"
responses:
"200":
$ref: "#/components/responses/AttributeResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/attributes/edit/{attributeId}:
put:
summary: "Edit an attribute"
operationId: editAttribute
tags:
- Attributes
parameters:
- $ref: "#/components/parameters/attributeIdParameter"
requestBody:
$ref: "#/components/requestBodies/EditAttributeRequest"
responses:
"200":
$ref: "#/components/responses/AttributeResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/attributes/delete/{attributeId}:
delete:
summary: "Delete an attribute"
operationId: deleteAttribute
tags:
- Attributes
parameters:
- $ref: "#/components/parameters/attributeIdParameter"
responses:
"200":
$ref: "#/components/responses/DeleteAttributeResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/attributes/restore/{attributeId}:
post:
summary: "Restore an attribute"
operationId: restoreAttribute
tags:
- Attributes
parameters:
- $ref: "#/components/parameters/attributeIdParameter"
responses:
"200":
$ref: "#/components/responses/AttributeResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/attributes/addTag/{attributeId}/{tagId}/local:{local}:
post:
summary: "Add a tag to an attribute"
operationId: tagAttribute
tags:
- Attributes
parameters:
- $ref: "#/components/parameters/attributeIdParameter"
- $ref: "#/components/parameters/tagIdParameter"
- $ref: "#/components/parameters/localParameter"
responses:
"200":
$ref: "#/components/responses/AddAttributeTagResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/attributes/removeTag/{attributeId}/{tagId}:
post:
summary: "Remove a tag from an attribute"
operationId: untagAttribute
tags:
- Attributes
parameters:
- $ref: "#/components/parameters/attributeIdParameter"
- $ref: "#/components/parameters/tagIdParameter"
responses:
"200":
$ref: "#/components/responses/RemoveAttributeTagResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/attributes:
get:
summary: "Get a list of attributes"
operationId: getAttributes
tags:
- Attributes
responses:
"200":
$ref: "#/components/responses/AttributeListResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/attributes/view/{attributeId}:
get:
summary: "Get an attribute by ID"
operationId: getAttributeById
tags:
- Attributes
parameters:
- $ref: "#/components/parameters/attributeIdParameter"
responses:
"200":
$ref: "#/components/responses/AttributeResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/attributes/attributeStatistics/{context}/{percentage}:
get:
summary: "Get the count of attributes per category"
operationId: getAttributeStatistics
tags:
- Attributes
parameters:
- $ref: "#/components/parameters/attributeStatisticsContextParameter"
- $ref: "#/components/parameters/attributeStatisticsPercentageParameter"
responses:
"200":
$ref: "#/components/responses/AttributeStatisticsResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/attributes/describeTypes:
get:
summary: "Get a list of the available attribute types"
operationId: describeAttributeTypes
tags:
- Attributes
responses:
"200":
$ref: "#/components/responses/DescribeAttributeTypesResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/events/restSearch:
post:
summary: "[restSearch] Get a filtered and paginated list of events"
operationId: restSearchEvents
description: |
**This is the recommended endpoint for searching events.**
tags:
- Events
requestBody:
$ref: "#/components/requestBodies/RestSearchEventsRequest"
responses:
"200":
$ref: "#/components/responses/EventsRestSearchResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/events/add:
post:
summary: "Add event"
operationId: addEvent
tags:
- Events
requestBody:
$ref: "#/components/requestBodies/AddEventRequest"
responses:
"200":
$ref: "#/components/responses/AddEventResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/events/edit/{eventId}:
put:
summary: "Edit event"
operationId: editEvent
tags:
- Events
parameters:
- $ref: "#/components/parameters/eventIdParameter"
requestBody:
$ref: "#/components/requestBodies/EditEventRequest"
responses:
"200":
$ref: "#/components/responses/EditEventResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/events/delete/{eventId}:
delete:
summary: "Delete event"
operationId: deleteEvent
tags:
- Events
parameters:
- $ref: "#/components/parameters/eventIdParameter"
responses:
"200":
$ref: "#/components/responses/DeleteEventResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/events:
get:
summary: "Get a list of events"
operationId: getEvents
tags:
- Events
responses:
"200":
$ref: "#/components/responses/ExtendedEventListResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/events/index:
post:
summary: "Search events"
operationId: searchEvents
tags:
- Events
requestBody:
$ref: "#/components/requestBodies/SearchEventRequest"
responses:
"200":
$ref: "#/components/responses/ExtendedEventListResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/events/view/{eventId}:
get:
summary: "Get event by ID"
operationId: getEventById
tags:
- Events
parameters:
- $ref: "#/components/parameters/eventIdParameter"
responses:
"200":
$ref: "#/components/responses/ExtendedEventResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/events/publish/{eventId}:
post:
summary: "Publish an event"
operationId: publishEvent
tags:
- Events
parameters:
- $ref: "#/components/parameters/eventIdParameter"
responses:
"200":
$ref: "#/components/responses/PublishEventResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/events/unpublish/{eventId}:
post:
summary: "Unpublish an event"
operationId: unpublishEvent
tags:
- Events
parameters:
- $ref: "#/components/parameters/eventIdParameter"
responses:
"200":
$ref: "#/components/responses/UnpublishEventResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/events/addTag/{eventId}/{tagId}/local:{local}:
post:
summary: "Add event tag"
operationId: tagEvent
tags:
- Events
parameters:
- $ref: "#/components/parameters/eventIdParameter"
- $ref: "#/components/parameters/tagIdParameter"
- $ref: "#/components/parameters/localParameter"
responses:
"200":
$ref: "#/components/responses/AddEventTagResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/events/removeTag/{eventId}/{tagId}:
post:
summary: "Remove event tag"
operationId: untagEvent
tags:
- Events
parameters:
- $ref: "#/components/parameters/eventIdParameter"
- $ref: "#/components/parameters/tagIdParameter"
responses:
"200":
$ref: "#/components/responses/RemoveEventTagResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxies:
get:
summary: "Get galaxies"
operationId: getGalaxies
tags:
- Galaxies
responses:
"200":
$ref: "#/components/responses/GalaxyListResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
post:
summary: "Search galaxies"
operationId: searchGalaxies
tags:
- Galaxies
requestBody:
$ref: "#/components/requestBodies/SearchGalaxyRequest"
responses:
"200":
$ref: "#/components/responses/GalaxyListResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxies/view/{galaxyId}:
get:
summary: "Get galaxy by ID"
operationId: getGalaxyById
tags:
- Galaxies
parameters:
- $ref: "#/components/parameters/galaxyIdParameter"
responses:
"200":
$ref: "#/components/responses/ExtendedGalaxyResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxies/update:
post:
summary: "Force update the galaxies with the galaxy json definitions"
operationId: updateGalaxies
tags:
- Galaxies
responses:
"200":
$ref: "#/components/responses/UpdateGalaxiesResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxies/delete/{galaxyId}:
delete:
summary: "Delete a galaxy"
operationId: deleteGalaxy
tags:
- Galaxies
parameters:
- $ref: "#/components/parameters/galaxyIdParameter"
responses:
"200":
$ref: "#/components/responses/DeleteGalaxyResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxies/import:
post:
summary: "Import a galaxy cluster"
operationId: importGalaxyCluster
tags:
- Galaxies
requestBody:
$ref: "#/components/requestBodies/ImportGalaxyClusterRequest"
responses:
"200":
$ref: "#/components/responses/ImportGalaxyClusterResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxies/export/{galaxyId}:
post:
summary: "Export galaxy clusters"
operationId: exportGalaxyClusters
tags:
- Galaxies
parameters:
- $ref: "#/components/parameters/galaxyIdParameter"
requestBody:
$ref: "#/components/requestBodies/ExportGalaxyClusterRequest"
responses:
"200":
$ref: "#/components/responses/ExportGalaxyClustersResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxies/attachCluster/{attachTargetId}/{attachTargetType}/local:{local}:
post:
summary: "Attach the galaxy cluster tag a given entity"
operationId: attachGalaxyCluster
tags:
- Galaxies
parameters:
- $ref: "#/components/parameters/attachTargetIdParameter"
- $ref: "#/components/parameters/attachTargetTypeParameter"
- $ref: "#/components/parameters/localParameter"
requestBody:
$ref: "#/components/requestBodies/AttachGalaxyClusterRequest"
responses:
"200":
$ref: "#/components/responses/AttachGalaxyClusterResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxy_clusters/add/{galaxyId}:
post:
summary: "Add galaxy cluster"
operationId: addGalaxyCluster
tags:
- Galaxy Clusters
parameters:
- $ref: "#/components/parameters/galaxyIdParameter"
requestBody:
$ref: "#/components/requestBodies/AddGalaxyClusterRequest"
responses:
"200":
$ref: "#/components/responses/GalaxyClusterResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxy_clusters/edit/{galaxyClusterId}:
put:
summary: "Edit galaxy cluster"
operationId: editGalaxyCluster
tags:
- Galaxy Clusters
parameters:
- $ref: "#/components/parameters/galaxyClusterIdParameter"
requestBody:
$ref: "#/components/requestBodies/EditGalaxyClusterRequest"
responses:
"200":
$ref: "#/components/responses/GalaxyClusterResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxy_clusters/index/{galaxyId}:
get:
summary: "Get galaxy clusters"
operationId: getGalaxyClusters
tags:
- Galaxy Clusters
parameters:
- $ref: "#/components/parameters/galaxyIdParameter"
responses:
"200":
$ref: "#/components/responses/GalaxyClusterListResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
post:
summary: "Search galaxy clusters"
operationId: searchGalaxyClusters
tags:
- Galaxy Clusters
parameters:
- $ref: "#/components/parameters/galaxyIdParameter"
requestBody:
$ref: "#/components/requestBodies/SearchGalaxyClustersRequest"
responses:
"200":
$ref: "#/components/responses/GalaxyClusterListResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxy_clusters/view/{galaxyClusterId}:
get:
summary: "Get galaxy cluster by ID"
operationId: getGalaxyClusterById
tags:
- Galaxy Clusters
parameters:
- $ref: "#/components/parameters/galaxyClusterIdParameter"
responses:
"200":
$ref: "#/components/responses/ExtendedGalaxyClusterResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxy_clusters/publish/{galaxyClusterId}:
post:
summary: "Publish galaxy cluster"
operationId: publishGalaxyCluster
tags:
- Galaxy Clusters
parameters:
- $ref: "#/components/parameters/galaxyClusterIdParameter"
responses:
"200":
$ref: "#/components/responses/PublishGalaxyClusterResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxy_clusters/unpublish/{galaxyClusterId}:
post:
summary: "Unpublish galaxy cluster"
operationId: unpublishGalaxyCluster
tags:
- Galaxy Clusters
parameters:
- $ref: "#/components/parameters/galaxyClusterIdParameter"
responses:
"200":
$ref: "#/components/responses/UnpublishGalaxyClusterResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxy_clusters/delete/{galaxyClusterId}:
post:
summary: "Delete galaxy cluster"
operationId: deleteGalaxyCluster
tags:
- Galaxy Clusters
parameters:
- $ref: "#/components/parameters/galaxyClusterIdParameter"
responses:
"200":
$ref: "#/components/responses/DeleteGalaxyClusterResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxy_clusters/restore/{galaxyClusterId}:
post:
summary: "Restore galaxy cluster"
operationId: restoreGalaxyCluster
tags:
- Galaxy Clusters
parameters:
- $ref: "#/components/parameters/galaxyClusterIdParameter"
responses:
"200":
$ref: "#/components/responses/RestoreGalaxyClusterResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/users/initiatePasswordReset/{userId}/{firstTimeReset}:
post:
summary: "Reset user password"
operationId: resetUserPassword
tags:
- Users
parameters:
- $ref: "#/components/parameters/userIdParameter"
- $ref: "#/components/parameters/firstTimeResetParameter"
responses:
"200":
$ref: "#/components/responses/ResetUserPasswordResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/admin/users/add:
post:
summary: "Add user"
operationId: addUser
tags:
- Users
requestBody:
$ref: "#/components/requestBodies/AddUserRequest"
responses:
"200":
$ref: "#/components/responses/UserResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/admin/users/edit/{userId}:
put:
summary: "Edit user"
operationId: editUser
tags:
- Users
parameters:
- $ref: "#/components/parameters/userIdParameter"
requestBody:
$ref: "#/components/requestBodies/EditUserRequest"
responses:
"200":
$ref: "#/components/responses/UserResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/admin/users/delete/{userId}:
delete:
summary: "Delete user"
operationId: deleteUser
tags:
- Users
parameters:
- $ref: "#/components/parameters/userIdParameter"
responses:
"200":
$ref: "#/components/responses/DeleteUserResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/admin/users:
get:
summary: "Get users"
operationId: getUsers
tags:
- Users
responses:
"200":
$ref: "#/components/responses/UserListResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/admin/users/view/{userId}:
get:
summary: "Get user by ID"
operationId: getUserById
tags:
- Users
parameters:
- $ref: "#/components/parameters/userIdParameter"
responses:
"200":
$ref: "#/components/responses/ExtendedUserResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/admin/organisations/add:
post:
summary: "Add organisation"
operationId: addOrganisation
tags:
- Organisations
requestBody:
$ref: "#/components/requestBodies/AddOrganisationRequest"
responses:
"200":
$ref: "#/components/responses/OrganisationResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/admin/organisations/edit/{organisationId}:
put:
summary: "Edit organisation"
operationId: editOrganisation
tags:
- Organisations
parameters:
- $ref: "#/components/parameters/organisationIdParameter"
requestBody:
$ref: "#/components/requestBodies/EditOrganisationRequest"
responses:
"200":
$ref: "#/components/responses/OrganisationResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/admin/organisations/delete/{organisationId}:
delete:
summary: "Delete organisation"
operationId: deleteOrganisation
tags:
- Organisations
parameters:
- $ref: "#/components/parameters/organisationIdParameter"
responses:
"200":
$ref: "#/components/responses/DeleteOrganisationResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/admin/logs:
post:
summary: "Get instance logs"
operationId: getLogs
tags:
- Logs
requestBody:
$ref: "#/components/requestBodies/GetLogsRequest"
responses:
"200":
$ref: "#/components/responses/GetLogsResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/organisations:
get:
summary: "Get organisations"
operationId: getOrganisations
tags:
- Organisations
responses:
"200":
$ref: "#/components/responses/OrganisationListResponse"
"403":
$ref: "#/components/responses/UnauthorizedApiErrorResponse"
"404":
$ref: "#/components/responses/NotFoundApiErrorResponse"
default:
$ref: "#/components/responses/ApiErrorResponse"
/organisations/view/{organisationId}:
get: