-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathopenapi.yaml
9866 lines (9866 loc) · 441 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.1
info:
title: Cisco Security Cloud Control API
version: 1.5.0
description: Use the documentation to explore the endpoints Security Cloud Control has to offer
contact:
name: Cisco Security Cloud Control TAC
email: cdo.tac@cisco.com
paths:
/.well-known/jwks.json:
get:
description: 'Retrieves the JSON Web Key Set (JWKS), which is a set of keys containing the public keys used to verify any JSON Web Token (JWT) issued by the Authorization Server and signed using the RS256 signing algorithm. Note: Verification of the token using a JSON Web Key does not guarantee validity due to the possibility of revocation.'
operationId: getJwks
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/JwkSet'
description: The JSON Web Key Set.
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
summary: Fetch JSON Web Key Set
tags:
- Meta
/swagger-ui/**:
get:
operationId: redirectWithUsingRedirectView
responses:
"200":
content:
'*/*':
schema:
$ref: '#/components/schemas/RedirectView'
description: OK
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
tags:
- swagger-redirect-controller
/v1/ai-assistant/conversations:
get:
description: 'Get a list of AI Assistant Conversations. Note: the total number of conversations is set to -1 as this information is currently unavailable.'
operationId: getConversations
parameters:
- description: The number of results to retrieve.
in: query
name: limit
required: false
schema:
default: "50"
maximum: 200
minimum: 0
type: string
- description: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
in: query
name: offset
required: false
schema:
default: "0"
minimum: 0
type: string
- description: The fields to sort results by.
example: name:DESC
in: query
name: sort
required: false
schema:
items:
type: string
type: array
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/AiAssistantConversationPage'
description: List of Conversations
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Get Conversations
tags:
- AI Assistant
post:
description: Start a new conversation with the AI Assistant by asking a question.
operationId: askAiAssistantInNewConversation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AiQuestion'
required: true
responses:
"202":
content:
application/json:
schema:
$ref: '#/components/schemas/CdoTransaction'
description: Security Cloud Control Transaction object that can be used to track the status of the question.
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Ask AI Assistant (New Conversation)
tags:
- AI Assistant
/v1/ai-assistant/conversations/{conversationUid}:
get:
description: Get an AI Assistant conversation by UID in the Security Cloud Control tenant.
operationId: getConversation
parameters:
- description: The unique identifier, represented as a UUID, of the conversation in Security Cloud Control.
in: path
name: conversationUid
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/AiConversation'
description: Conversation object
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"404":
$ref: '#/components/responses/http404NotFound'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Get Conversation
tags:
- AI Assistant
post:
description: Ask the AI Assistant a question in the context of an existing conversation with the AI Assistant.
operationId: askAiAssistantInExistingConversation
parameters:
- in: path
name: conversationUid
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AiQuestion'
required: true
responses:
"202":
content:
application/json:
schema:
$ref: '#/components/schemas/CdoTransaction'
description: Security Cloud Control Transaction object that can be used to track the status of the question.
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Ask AI Assistant (Existing Conversation)
tags:
- AI Assistant
/v1/ai-assistant/conversations/{conversationUid}/messages:
get:
description: 'Get a list of messages in a single AI Assistant conversation. Note: this endpoint is not paginated, and returns the full list of messages.'
operationId: getAiAssistantConversationMessages
parameters:
- description: The unique identifier, represented as a UUID, of the conversation in Security Cloud Control.
in: path
name: conversationUid
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AiMessage'
type: array
description: List of Conversation Messages
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Get Messages
tags:
- AI Assistant
/v1/auditlogs:
get:
description: Get a list of Audit Logs.
operationId: getAuditLogs
parameters:
- description: The number of results to retrieve.
in: query
name: limit
required: false
schema:
default: "50"
maximum: 200
minimum: 0
type: string
- description: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
in: query
name: offset
required: false
schema:
default: "0"
minimum: 0
type: string
- description: The searchText parameter serves as a flexible search option that allows for text-based filtering across the username fields of the Audit Log object. This parameter can be used independently to search for entries containing the specified text, or in combination with the q query parameter for more targeted results. When used with q, the search conditions of searchText are logically ANDed with the q parameter's criteria, ensuring that the returned entries satisfy both sets of conditions.
in: query
name: searchText
required: false
schema:
type: string
- description: The time range for which to retrieve Audit Logs. This parameter cannot be used in conjunction with a query on the eventTime field.
in: query
name: timeRange
required: false
schema:
type: string
- description: The query to execute. Use the Lucene Query Syntax to construct your query.
example: fieldName:fieldValue
in: query
name: q
required: false
schema:
type: string
- description: The fields to sort results by.
example: name:DESC
in: query
name: sort
required: false
schema:
items:
type: string
type: array
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/AuditLogPage'
description: List of Audit Logs objects
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Get Audit Logs
tags:
- Audit Logs
/v1/cdfmc/**:
delete:
description: This endpoint proxies the request to the Cloud-Delivered FMC (cdFMC). Refer to the <a href="https://www.cisco.com/c/en/us/td/docs/security/firepower/730/Rapid-Release/API/CDO/cloud_delivered_firewall_management_center_rest_api_quick_start_guide/About_The_API_Explorer.html">cdFMC API Explorer in CDO</a> for the list of available endpoints. You can append the relative API paths provided in the cdFMC API documentation to the `/v1/cdfmc` URL to make requests to the cdFMC in your CDO tenant. <b>Note:</b> These endpoints will return 404 if the Security Cloud Control tenant does not have a cdFMC provisioned.
operationId: proxyFmcRequest_4
responses:
"401":
$ref: '#/components/responses/http401Unauthorised'
"404":
$ref: '#/components/responses/http404NotFound'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Proxy Request To Cloud-Delivered FMC
tags:
- Cloud-delivered FMC
get:
description: This endpoint proxies the request to the Cloud-Delivered FMC (cdFMC). Refer to the <a href="https://www.cisco.com/c/en/us/td/docs/security/firepower/730/Rapid-Release/API/CDO/cloud_delivered_firewall_management_center_rest_api_quick_start_guide/About_The_API_Explorer.html">cdFMC API Explorer in CDO</a> for the list of available endpoints. You can append the relative API paths provided in the cdFMC API documentation to the `/v1/cdfmc` URL to make requests to the cdFMC in your CDO tenant. <b>Note:</b> These endpoints will return 404 if the Security Cloud Control tenant does not have a cdFMC provisioned.
operationId: proxyFmcRequest
responses:
"401":
$ref: '#/components/responses/http401Unauthorised'
"404":
$ref: '#/components/responses/http404NotFound'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Proxy Request To Cloud-Delivered FMC
tags:
- Cloud-delivered FMC
patch:
description: This endpoint proxies the request to the Cloud-Delivered FMC (cdFMC). Refer to the <a href="https://www.cisco.com/c/en/us/td/docs/security/firepower/730/Rapid-Release/API/CDO/cloud_delivered_firewall_management_center_rest_api_quick_start_guide/About_The_API_Explorer.html">cdFMC API Explorer in CDO</a> for the list of available endpoints. You can append the relative API paths provided in the cdFMC API documentation to the `/v1/cdfmc` URL to make requests to the cdFMC in your CDO tenant. <b>Note:</b> These endpoints will return 404 if the Security Cloud Control tenant does not have a cdFMC provisioned.
operationId: proxyFmcRequest_3
responses:
"401":
$ref: '#/components/responses/http401Unauthorised'
"404":
$ref: '#/components/responses/http404NotFound'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Proxy Request To Cloud-Delivered FMC
tags:
- Cloud-delivered FMC
post:
description: This endpoint proxies the request to the Cloud-Delivered FMC (cdFMC). Refer to the <a href="https://www.cisco.com/c/en/us/td/docs/security/firepower/730/Rapid-Release/API/CDO/cloud_delivered_firewall_management_center_rest_api_quick_start_guide/About_The_API_Explorer.html">cdFMC API Explorer in CDO</a> for the list of available endpoints. You can append the relative API paths provided in the cdFMC API documentation to the `/v1/cdfmc` URL to make requests to the cdFMC in your CDO tenant. <b>Note:</b> These endpoints will return 404 if the Security Cloud Control tenant does not have a cdFMC provisioned.
operationId: proxyFmcRequest_1
responses:
"401":
$ref: '#/components/responses/http401Unauthorised'
"404":
$ref: '#/components/responses/http404NotFound'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Proxy Request To Cloud-Delivered FMC
tags:
- Cloud-delivered FMC
put:
description: This endpoint proxies the request to the Cloud-Delivered FMC (cdFMC). Refer to the <a href="https://www.cisco.com/c/en/us/td/docs/security/firepower/730/Rapid-Release/API/CDO/cloud_delivered_firewall_management_center_rest_api_quick_start_guide/About_The_API_Explorer.html">cdFMC API Explorer in CDO</a> for the list of available endpoints. You can append the relative API paths provided in the cdFMC API documentation to the `/v1/cdfmc` URL to make requests to the cdFMC in your CDO tenant. <b>Note:</b> These endpoints will return 404 if the Security Cloud Control tenant does not have a cdFMC provisioned.
operationId: proxyFmcRequest_2
responses:
"401":
$ref: '#/components/responses/http401Unauthorised'
"404":
$ref: '#/components/responses/http404NotFound'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Proxy Request To Cloud-Delivered FMC
tags:
- Cloud-delivered FMC
/v1/changeRequests:
get:
description: Get a list of Change Requests.
operationId: getChangeRequests
parameters:
- description: The number of results to retrieve.
in: query
name: limit
required: false
schema:
default: "50"
maximum: 200
minimum: 0
type: string
- description: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
in: query
name: offset
required: false
schema:
default: "0"
minimum: 0
type: string
- description: The query to execute. Use the Lucene Query Syntax to construct your query.
example: fieldName:fieldValue
in: query
name: q
required: false
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequestPage'
description: List of Change Request objects
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Get Change Requests
tags:
- Change Requests
post:
description: Create a Change Request in the Security Cloud Control tenant.
operationId: createChangeRequest
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequestCreateInput'
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequest'
description: Created change Request object
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Create Change Request
tags:
- Change Requests
/v1/changeRequests/{changeRequestUid}:
delete:
description: Delete a Change Request by UID in the Security Cloud Control tenant.
operationId: deleteChangeRequest
parameters:
- description: The unique identifier, represented as a UUID, of the Change Request in Security Cloud Control.
in: path
name: changeRequestUid
required: true
schema:
format: uuid
type: string
responses:
"204":
description: No Content
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Delete Change Request
tags:
- Change Requests
get:
description: Get a Change Request by UID in the Security Cloud Control tenant.
operationId: getChangeRequest
parameters:
- description: The unique identifier, represented as a UUID, of the Change Request in Security Cloud Control.
in: path
name: changeRequestUid
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequest'
description: Change Request object
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"404":
$ref: '#/components/responses/http404NotFound'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Get Change Request
tags:
- Change Requests
/v1/changelogs:
get:
description: Get a list of Change Logs in the Security Cloud Control tenant.
operationId: getChangelogs
parameters:
- description: The number of results to retrieve.
in: query
name: limit
required: false
schema:
default: "50"
maximum: 200
minimum: 0
type: string
- description: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
in: query
name: offset
required: false
schema:
default: "0"
minimum: 0
type: string
- description: The searchText parameter serves as a flexible search option that allows for text-based filtering across all fields of the Change Log object. This parameter can be used independently to search for entries containing the specified text, or in combination with the q query parameter for more targeted results. When used with q, the search conditions of searchText are logically ANDed with the q parameter's criteria, ensuring that the returned entries satisfy both sets of conditions.
in: query
name: searchText
required: false
schema:
type: string
- description: The time range for which to retrieve Change Logs. This parameter cannot be used in conjunction with a query on the lastEventDate field.
in: query
name: timeRange
required: false
schema:
type: string
- description: The query to execute. Use the Lucene Query Syntax to construct your query.
example: fieldName:fieldValue
in: query
name: q
required: false
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ChangelogPage'
description: List of Change Log objects
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Get Change Logs
tags:
- Changelogs
/v1/changelogs/{changelogUid}:
get:
description: Get a specific Change Log object by UID in the Security Cloud Control tenant.
operationId: getChangelog
parameters:
- description: The unique identifier, represented as a UUID, of the changelog in Security Cloud Control.
in: path
name: changelogUid
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/Changelog'
description: Change Log objects
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Get Change Log
tags:
- Changelogs
/v1/cli/macros:
get:
description: Get a list of CLI macros. A CLI macro is a fully-formed CLI command ready to use, or a template of a CLI command you can modify before you run it.
operationId: getCliMacros
parameters:
- description: The number of results to retrieve.
in: query
name: limit
required: false
schema:
default: "50"
maximum: 200
minimum: 0
type: string
- description: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
in: query
name: offset
required: false
schema:
default: "0"
minimum: 0
type: string
- description: The query to execute. Use the Lucene Query Syntax to construct your query.
example: fieldName:fieldValue
in: query
name: q
required: false
schema:
type: string
- description: The fields to sort results by.
example: name:DESC
in: query
name: sort
required: false
schema:
items:
type: string
type: array
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/CdoCliMacroPage'
description: List of Security Cloud Control CLI macros
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Get CLI Macros
tags:
- Command Line Interface
post:
description: Create a CLI macro, which is a fully-formed CLI command ready to use or a template of a CLI command you can modify before you run it.
operationId: createCliMacro
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CliMacroCreateInput'
required: true
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/CdoCliMacro'
description: Security Cloud Control CLI macro
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Create CLI Macro
tags:
- Command Line Interface
/v1/cli/macros/{macroUid}:
delete:
description: Delete a Security Cloud Control CLI Macro by UID.
operationId: deleteCliMacro
parameters:
- description: The unique identifier, represented as a UUID, of the CDO CLI macro in Security Cloud Control.
in: path
name: macroUid
required: true
schema:
format: uuid
type: string
responses:
"204":
description: Security Cloud Control CLI macro
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Delete CLI Macro
tags:
- Command Line Interface
get:
description: Get a Security Cloud Control CLI Macro by UID.
operationId: getCliMacro
parameters:
- description: The unique identifier, represented as a UUID, of the CDO CLI macro in Security Cloud Control.
in: path
name: macroUid
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/CdoCliMacro'
description: Security Cloud Control CLI macro
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"404":
$ref: '#/components/responses/http404NotFound'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Get CLI Macro
tags:
- Command Line Interface
patch:
description: Modify a Security Cloud Control CLI Macro by UID.
operationId: modifyCliMacro
parameters:
- description: The unique identifier, represented as a UUID, of the CDO CLI macro in Security Cloud Control.
in: path
name: macroUid
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CliMacroPatchInput'
required: true
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/CdoCliMacro'
description: Security Cloud Control CLI macro
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"404":
$ref: '#/components/responses/http404NotFound'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Modify CLI Macro
tags:
- Command Line Interface
/v1/cli/results:
get:
description: Get a list of results from command lines executed using the [CDO Command Line Interface (CLI)](https://docs.defenseorchestrator.com/c-using-the-cdo-command-line-interface.html). These commands can be executed using either the Security Cloud Control UI or the API.
operationId: getCliResults
parameters:
- description: The number of results to retrieve.
in: query
name: limit
required: false
schema:
default: "50"
maximum: 200
minimum: 0
type: string
- description: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
in: query
name: offset
required: false
schema:
default: "0"
minimum: 0
type: string
- description: The query to execute. Use the Lucene Query Syntax to construct your query.
example: fieldName:fieldValue
in: query
name: q
required: false
schema:
type: string
- description: The fields to sort results by.
example: name:DESC
in: query
name: sort
required: false
schema:
items:
type: string
type: array
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/CdoCliResultPage'
description: List of Security Cloud Control CLI execution results
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"405":
$ref: '#/components/responses/http405MethodNotAllowed'
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/CommonApiError'
description: Internal server error.
security:
- bearerAuth: []
summary: Get CLI Results
tags:
- Command Line Interface
/v1/cli/results/{cliResultUid}:
get:
description: Get the result of a command executed using the Security Cloud Control Command Line Interface (CLI) by UID.
operationId: getCliResult
parameters:
- description: The unique identifier, represented as a UUID, of the CDO CLI result in Security Cloud Control.
in: path
name: cliResultUid
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/CdoCliResult'
description: Security Cloud Control CLI result
"400":
$ref: '#/components/responses/http400BadRequest'
"401":
$ref: '#/components/responses/http401Unauthorised'
"403":
$ref: '#/components/responses/http403Forbidden'
"404":
$ref: '#/components/responses/http404NotFound'
"405":