-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yml
More file actions
9110 lines (8957 loc) · 426 KB
/
Copy pathopenapi.yml
File metadata and controls
9110 lines (8957 loc) · 426 KB
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: ConnectWise Asio APIs
version: ""
description: ""
paths:
/api/v1/schemas/{schemaId}/dataset:
post:
summary: Add a record to the dataset for specified Schema
tags:
- MappingApplicationService
parameters:
- name: schemaId
in: path
description: the id of schema to add the record to the dataset of
required: true
schema:
type: string
format: uuid
x-cw-openapi:
api-path: /v1/mapping/schema/{schemaId}/dataset
api-scopes:
- platform.dataMapping.create
filters:
- api-scope: platform.dataMapping.create
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DatasetRequest"
responses:
"201":
description: Dataset created successfully
content:
application/json:
schema:
type: object
example:
id: c8f72634-ba9e-11ee-a506-0242ac120002
monitor_type: Monitor1
serviceBoard: Board A
serviceBoardId: 201
"400":
description: Invalid request
"500":
description: Internal server error
delete:
summary: Delete entire dataset for specified schema
tags:
- Mapping Dataset
x-cw-openapi:
api-path: v1/schemas/schema/{schemaId}/dataset
api-scopes:
- platform.dataMapping.delete
filters:
- api-scope: platform.dataMapping.delete
parameters:
- name: schemaId
in: path
description: the id of schema to delete the dataset of
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Successful delete schema dataset
"404":
description: Schema dataset not found
"500":
description: Internal server error
/api/v1/schemas/{schemaId}/dataset/{entryId}:
put:
summary: Update a dataset record for specified Schema
tags:
- MappingApplicationService
parameters:
- name: schemaId
in: path
description: the id of schema to update the record to the dataset of
required: true
schema:
type: string
format: uuid
- name: entryId
in: path
description: the id of dataset record to be updated
required: true
schema:
type: string
format: uuid
x-cw-openapi:
api-path: /v1/mapping/schema/{schemaId}/dataset/{entryId}
api-scopes:
- platform.dataMapping.update
filters:
- api-scope: platform.dataMapping.update
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DatasetRequest"
responses:
"200":
description: Dataset updated successfully
content:
application/json:
schema:
type: object
example:
id: c8f72634-ba9e-11ee-a506-0242ac120002
monitor_type: Monitor1
serviceBoard: Board A
serviceBoardId: 201
"400":
description: Invalid request
"500":
description: Internal server error
delete:
summary: Delete a record in the dataset for specified Schema
tags:
- Mapping Dataset
x-cw-openapi:
api-path: v1/schemas/schema/{schemaId}/dataset/{entryId}
api-scopes:
- platform.dataMapping.delete
filters:
- api-scope: platform.dataMapping.delete
parameters:
- name: schemaId
in: path
description: the id of schema to delete the record in
required: true
schema:
type: string
format: uuid
- name: entryId
in: path
description: the id of the record to delete
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Record deleted successfully
"404":
description: Record not found
"500":
description: Internal server error
/v1/token:
post:
tags:
- Authorization
summary: Authorize with credentials
operationId: Authorize with credentials
requestBody:
content:
application/json:
schema:
type: object
properties:
grant_type:
type: string
client_id:
type: string
client_secret:
type: string
scope:
type: string
example:
grant_type: client_credentials
client_id: "6500023"
client_secret: some_client_secret
scope: topology
required: false
responses:
"200":
description: OK
content:
application/json:
example:
access_token: o7-0jLHntmSEfkr5KGq2whqRfR0
scope: topology
token_type: Bearer
expires_in: 3599
x-codegen-request-body-name: body
/v1/rate_limits:
get:
tags:
- Rate Limits
summary: Get current rate limit
operationId: Get current rate limit
security:
- openapi_oauth: []
responses:
"200":
description: OK
content:
application/json:
example:
resources:
alerts:
create-alert:
limit: 35
remaining: 34
reset: 1603785300
asset:
partner-asset-endpoints-details:
limit: 35
remaining: 35
reset: 1603785300
service:
rate-limit:
limit: 35
remaining: 33
reset: 1603785300
topology:
partner-topology-clients:
limit: 35
remaining: 35
reset: 1603785300
partner-topology-endpoints:
limit: 35
remaining: 35
reset: 1603785300
partner-topology-sites:
limit: 35
remaining: 35
reset: 1603785300
/v1/alerts:
put:
tags:
- Alerting
summary: Update alerts
operationId: Update alerts
security:
- alerts:
- alerts
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
client_id:
type: string
site_id:
type: string
endpoint_id:
type: string
alert_id:
type: string
condition_id:
type: string
alertDetails:
type: object
properties:
Description:
type: string
EventId:
type: number
EventLevel:
type: number
LogName:
type: number
ObservedDate:
type: string
Source:
type: string
createdTimeStamp:
type: number
example:
client_id: c1
site_id: s1
endpoint_id: e1
condition_id: 7b409638-e567-4be2-9633-5ae2835cd1bc
alert_id: 47ec0839-ee56-4498-89ad-da8078212686
alertDetails:
Description:
A corruption was discovered in the file system structure on volume
Disk File System Error Event Via PowerShell.
EventId: 11
EventLevel: 4
LogName: 15
ObservedDate: 2018-04-12T11:30:00Z
Source: Ntfs
createdTimeStamp: 1558369952502
required: true
responses:
"207":
description: Multi-Status
content:
application/json:
example:
data:
- status_code: 204
resource:
client_id: c1
site_id: s1
endpoint_id: e1
condition_id: 7b409638-e567-4be2-9633-5ae2835cd1bc
alert_id: 47ec0839-ee56-4498-89ad-da8078212686
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: bad request
description: invalid input data
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: unauthorized request
description:
The access token provided is expired, revoked, malformed, or
invalid for other reasons.
"404":
description: Not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: not found
description: topology does not exist
"429":
description: Too many requests
content:
text/plain; charset=utf-8:
example: Too Many Requests
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: internal server error
description: internal error
post:
tags:
- Alerting
summary: Create alerts
operationId: Create alerts
security:
- alerts:
- alerts
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
client_id:
type: string
site_id:
type: string
endpoint_id:
type: string
condition_id:
type: string
alertDetails:
type: object
properties:
Description:
type: string
EventId:
type: number
EventLevel:
type: number
LogName:
type: number
ObservedDate:
type: string
Source:
type: string
createdTimeStamp:
type: number
example:
client_id: c1
site_id: s1
endpoint_id: e1
condition_id: 7b409638-e567-4be2-9633-5ae2835cd1bc
alertDetails:
Description:
A corruption was discovered in the file system structure on volume
Disk File System Error Event Via PowerShell.
EventId: 11
EventLevel: 4
LogName: 15
ObservedDate: 2018-04-12T11:30:00Z
Source: Ntfs
createdTimeStamp: 1558369952502
required: true
responses:
"207":
description: Multi-Status
content:
application/json:
example:
data:
- status_code: 201
resource:
client_id: c1
site_id: s1
endpoint_id: e1
condition_id: 7b409638-e567-4be2-9633-5ae2835cd1bc
alert_id: 00000-xxxxx-00000
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: bad request
description: invalid input data
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: unauthorized request
description:
The access token provided is expired, revoked, malformed, or
invalid for other reasons.
"404":
description: Not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: not found
description: topology does not exist
"429":
description: Too many requests
content:
text/plain; charset=utf-8:
example: Too Many Requests
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: internal server error
description: internal error
x-codegen-request-body-name: body
delete:
tags:
- Alerting
summary: Delete alerts
operationId: Delete alerts
security:
- alerts:
- alerts
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
client_id:
type: string
site_id:
type: string
endpoint_id:
type: string
alert_id:
type: string
condition_id:
type: string
example:
client_id: c1
site_id: s1
endpoint_id: e1
condition_id: 7b409638-e567-4be2-9633-5ae2835cd1bc
alert_id: 47ec0839-ee56-4498-89ad-da8078212686
required: true
responses:
"207":
description: Multi-Status
content:
application/json:
example:
data:
- status_code: 204
resource:
client_id: c1
site_id: s1
endpoint_id: e1
alert_id: 47ec0839-ee56-4498-89ad-da8078212686
condition_id: 7b409638-e567-4be2-9633-5ae2835cd1bc
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: bad request
description: invalid input data
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: unauthorized request
description:
The access token provided is expired, revoked, malformed, or
invalid for other reasons.
"404":
description: Not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: not found
description: topology does not exist
"429":
description: Too many requests
content:
text/plain; charset=utf-8:
example: Too Many Requests
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: internal server error
description: internal error
/v1/endpoint-mapping:
get:
tags:
- Endpoint Mapping
summary: Get list of partner level endpoint mappings
operationId: Get list of partner level endpoint mappings
security:
- endpoint_mapping:
- endpoint_mapping
responses:
"200":
description: OK
content:
application/json:
example:
- mapped: true
name: test_endpoint
client_id: xWtguxurixSAcxCx
site_id: xWtguxurixSAcxCx
endpoint_id: xWtguxurixSAcxCy
integrator_endpoint_id: xWtguxurixSAcxCv
/v1/clients/{clientID}/sites/{siteID}/endpoint-mapping/{integratorEndpointID}:
delete:
tags:
- Endpoint Mapping
summary: Delete target endpoint mapping
operationId: Delete target endpoint mapping
security:
- endpoint_mapping:
- endpoint_mapping
parameters:
- name: clientID
in: path
description: client id
required: true
schema:
type: string
example: 2lUrtru6uvuVs7
- name: siteID
in: path
description: site id
required: true
schema:
type: string
example: wOCDc3uZu7upuZ
- name: integratorEndpointID
in: path
description: integrator endpoint id
required: true
schema:
type: string
example: rOCZc8uWu1upuY
responses:
"204":
description: Integrator site endpoint mapping successfully deleted
/v1/clients/{clientID}/sites/{siteID}/endpoint-mapping:
get:
tags:
- Endpoint Mapping
summary: Get list of site level endpoint mappings
operationId: Get list of site level endpoint mappings
security:
- endpoint_mapping:
- endpoint_mapping
parameters:
- name: clientID
in: path
description: client id
required: true
schema:
type: string
example: 2lUrtru6uvuVs7
- name: siteID
in: path
description: site id
required: true
schema:
type: string
example: wOCDc3uZu7upuZ
responses:
"200":
description: OK
content:
application/json:
example:
- mapped: true
name: test_endpoint
client_id: xWtguxurixSAcxCx
site_id: xWtguxurixSAcxCx
endpoint_id: xWtguxurixSAcxCy
integrator_endpoint_id: xWtguxurixSAcxCv
post:
tags:
- Endpoint Mapping
summary: Upsert site level endpoint mappings
operationId: Upsert site level endpoint mappings
security:
- endpoint_mapping:
- endpoint_mapping
parameters:
- name: clientID
in: path
description: client id
required: true
schema:
type: string
example: 2lUrtru6uvuVs7
- name: siteID
in: path
description: site id
required: true
schema:
type: string
example: wOCDc3uZu7upuZ
requestBody:
content:
application/json:
schema:
type: object
properties:
identifiers:
type: object
properties:
name:
type: string
integrator_endpoint_id:
type: string
asset_attributes:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
example:
- integrator_endpoint_id: xWtguxurixSAcxCv
identifiers:
name: test_endpoint
asset_attributes:
- name: xWtguxurixSAcxCx
value: xWtguxurixSAcxCy
responses:
"200":
description: OK
content:
application/json:
example:
- mapped: true
name: test_endpoint
client_id: xWtguxurixSAcxCx
site_id: xWtguxurixSAcxCx
endpoint_id: xWtguxurixSAcxCy
integrator_endpoint_id: xWtguxurixSAcxCv
put:
tags:
- Endpoint Mapping
summary: Replace site level endpoint mappings
operationId: Replace site level endpoint mappings
security:
- endpoint_mapping:
- endpoint_mapping
parameters:
- name: clientID
in: path
description: client id
required: true
schema:
type: string
example: 2lUrtru6uvuVs7
- name: siteID
in: path
description: site id
required: true
schema:
type: string
example: wOCDc3uZu7upuZ
requestBody:
content:
application/json:
schema:
type: object
properties:
identifiers:
type: object
properties:
name:
type: string
integrator_endpoint_id:
type: string
asset_attributes:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
example:
- integrator_endpoint_id: xWtguxurixSAcxCv
identifiers:
name: test_endpoint
asset_attributes:
- name: xWtguxurixSAcxCx
value: xWtguxurixSAcxCy
responses:
"200":
description: OK
content:
application/json:
example:
- mapped: true
name: test_endpoint
client_id: xWtguxurixSAcxCx
site_id: xWtguxurixSAcxCx
endpoint_id: xWtguxurixSAcxCy
integrator_endpoint_id: xWtguxurixSAcxCv
delete:
tags:
- Endpoint Mapping
summary: Delete site level endpoint mappings
operationId: Delete site level endpoint mappings
security:
- endpoint_mapping:
- endpoint_mapping
parameters:
- name: clientID
in: path
description: client id
required: true
schema:
type: string
example: 2lUrtru6uvuVs7
- name: siteID
in: path
description: site id
required: true
schema:
type: string
example: wOCDc3uZu7upuZ
responses:
"204":
description: Integrator site endpoint mapping successfully deleted
/v1/site-mappings:
get:
tags:
- Site Mapping
summary: Get list of site mappings
operationId: Get list of site mappings
security:
- site_mapping:
- site_mapping
parameters:
- name: clientID
in: query
description: client id
required: true
schema:
type: string
example: 2lUrtru6uvuVs7
- name: siteID
in: query
description: site id
required: true
schema:
type: string
example: wOCDc3uZu7upuZ
responses:
"200":
description: OK
content:
application/json:
example:
- clientId: xWtguxurixSAcxCx
siteId: xWtguxurixSAcxCx
externalId: xWtguxurixSAcxCy
productInstanceId: xWtguxurixSAcxCv
/v1/clients/{clientID}/sites/{siteID}/network-devices:
post:
tags:
- Network devices
summary: Reviews the information about network devices
operationId: Reviews the information about network devices
security:
- network_and_monitoring:
- network_and_monitoring
parameters:
- name: clientID
in: path
description: client id
required: true
schema:
type: string
example: 2lUrtru6uvuVs7
- name: siteID
in: path
description: site id
required: true
schema:
type: string
example: wOCDc3uZu7upuZ
requestBody:
content:
application/json:
schema:
type: object
properties:
title:
type: string
$schema:
type: string
description:
type: string
type:
type: string
properties:
type: object
properties:
scopeId:
type: object
properties:
type:
type: string
description:
type: string
deviceId:
type: object
properties:
type:
type: string
description:
type: string
system:
type: object
properties:
type:
type: string
properties:
type: object
properties:
hostname:
type: object
properties:
type:
type: string
description:
type: string
bootTime:
type: object
properties:
description:
type: string
type:
type: string
pattern:
type: string
manageStatus:
type: object
properties:
type:
type: string
description:
type: string
operStatus:
type: object
properties:
type:
type: string
enum:
type: array
items:
type: string
description:
type: string
lastSeenTime:
type: object
properties:
description:
type: string
type:
type: string
pattern:
type: string
description:
type: object
properties:
type:
type: string
description:
type: string
vendor:
type: object
properties:
type:
type: string
description:
type: string
model:
type: object
properties:
type:
type: string
description:
type: string
deviceType:
type: object
properties:
type:
type: string
description:
type: string
enum:
type: array
items:
type: string
firmwareVersion:
type: object
properties:
type:
type: string
description:
type: string
serialNo:
type: object
properties:
type:
type: string
description:
type: string
softwareVersion:
type: object
properties:
type:
type: string
description:
type: string
interfaces:
type: object
properties:
type:
type: string
properties:
type: object