generated from longpdo/neumorphism
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathData Services Cloud Console API.yaml
2548 lines (2548 loc) · 100 KB
/
Data Services Cloud Console API.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: Data Services Cloud Console API
description: Data Services Cloud Console API
version: 1.0.0
servers:
- url: https://eu1.data.cloud.hpe.com
- url: https://us1.data.cloud.hpe.com
- url: https://jp1.data.cloud.hpe.com
components:
securitySchemes:
oauth2Auth:
type: http
scheme: oauth2
security:
- oauth2Auth: []
tags:
- name: GLBR > Protection Store Gateways
- name: GLBR > Protection Stores
- name: GLBR > Data Orchestrator
- name: GLBR > VM Backups
- name: GLBR > Backup Recovery Reports
- name: GLBR > Protection Policies
- name: GLBR > Protection Jobs Report
- name: GLBR > Protection Groups
- name: GLBR > vCenter Managers
- name: GLBR > VMware Objects Folder
- name: GLBR > VMware Clusters
- name: GLBR > Hosts
- name: GLBR > Snapshots
- name: GLBR > Datastore
- name: GLBR > Virtual Machine Protection Groups
- name: GLBR > Dashboard Items
paths:
/api/v1/protection-store-gateways:
get:
tags:
- GLBR > Protection Store Gateways
summary: Protection Store Gateways
parameters:
- name: offset
in: query
schema:
type: string
example: '{{DefaultOffset}}'
- name: limit
in: query
schema:
type: string
example: '{{DefaultLimit}}'
- name: select
in: query
schema:
type: string
example: id,hostname,serialNumber,name,type
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/protection-store-gateways/{protectionStoreGatewayID}:
get:
tags:
- GLBR > Protection Store Gateways
summary: Protection Store Gateways Detail
parameters:
- name: protectionStoreGatewayID
in: path
schema:
type: string
required: true
example: 41f34390-90ba-47d1-be6b-386320ecd8bc
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/protection-store-gateways/{protectionStoreGatewayID}/consoleUser:
get:
tags:
- GLBR > Protection Store Gateways
summary: Show credentials of a Protection Store Gateway console user
parameters:
- name: protectionStoreGatewayID
in: path
schema:
type: string
required: true
example: 41f34390-90ba-47d1-be6b-386320ecd8bc
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/protection-store-gateway-sizer:
post:
tags:
- GLBR > Protection Store Gateways
summary: Display resource requirements for Protection Storage Gateway
requestBody:
content:
application/json:
schema:
type: object
example:
maxInCloudDailyProtectedDataTiB: 2
maxInCloudRetentionDays: 2
maxOnPremDailyProtectedDataTiB: 2
maxOnPremRetentionDays: 2
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/protection-stores:
get:
tags:
- GLBR > Protection Stores
summary: Display Protection Stores
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/protection-stores/{protectionStoreId}:
get:
tags:
- GLBR > Protection Stores
summary: Display Protection Stores Detail Copy
parameters:
- name: protectionStoreId
in: path
schema:
type: string
required: true
example: 1d0875a9-10c9-4746-8f55-a585e2457962
responses:
'200':
description: Successful response
content:
application/json: {}
/protection-stores:
post:
tags:
- GLBR > Protection Stores
summary: Create Protection Store
requestBody:
content:
application/json:
schema:
type: object
example:
displayName: Ron RD Test Create Protection Store
protectionStoreType: CLOUD
region: USA, North Virginia
storageSystemId: 2dc06f5d-e175-4957-a460-b6cf909a6138
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/data-orchestrators:
get:
tags:
- GLBR > Data Orchestrator
summary: Data Orchestrator
parameters:
- name: select
in: query
schema:
type: string
example: id
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/data-orchestrators/{dataOrchestratorId}:
get:
tags:
- GLBR > Data Orchestrator
summary: Data Orchestrator Detail
parameters:
- name: select
in: query
schema:
type: string
example: >-
id,name,customerId,connectionState,serialNumber,status,state,softwareVersion,upTimeInSeconds,dateTime
- name: dataOrchestratorId
in: path
schema:
type: string
required: true
example: d36122b2-ab2d-4474-ba97-15d2521926f0
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/data-orchestrators/{DoId}/set-remote-support:
post:
tags:
- GLBR > Data Orchestrator
summary: Enable Remote Support for Data Orchestrator
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
remoteAccessEnabled:
type: boolean
example: 'true'
parameters:
- name: Accept
in: header
schema:
type: string
example: application/json
- name: DoId
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/data-orchestrators/{DoId}/restart-guest-os:
post:
tags:
- GLBR > Data Orchestrator
summary: Restart a Data Orchestrator
requestBody:
content:
application/json:
schema:
type: object
example:
force: false
parameters:
- name: DoId
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/data-orchestrators/{DoId}/generate-support-bundle:
post:
tags:
- GLBR > Data Orchestrator
summary: Generate Support Bundles
requestBody:
content:
application/json:
schema:
type: object
example:
description: This is a support bundle generated through API for validation
parameters:
- name: Accept
in: header
schema:
type: string
example: application/json
- name: DoId
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/backup-recovery/v1beta1/indexed-files:
get:
tags:
- GLBR > VM Backups
summary: Display Indexed Files from an asset
parameters:
- name: virtual-machine
in: query
schema:
type: string
example: 44986dda-aeff-5b68-a6af-4d942616ec9d
- name: backup
in: query
schema:
type: string
example: 7ab439fc-7f2e-4823-9c8d-0492f76349f2
- name: root-path
in: query
schema:
type: string
example: /Hard disk 1/volume 2/
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/virtual-machines:
get:
tags:
- GLBR > VM Backups
summary: Display list of the virtual machines across registered HV managers
parameters:
- name: select
in: query
schema:
type: string
example: id,displayName
- name: filter
in: query
schema:
type: string
example: name eq 0-RRD-VVOL-VM-Test01
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/virtual-machines/{vmId}:
get:
tags:
- GLBR > VM Backups
summary: Get Detail VM
parameters:
- name: vmId
in: path
schema:
type: string
required: true
example: e5ffa3bf-9df4-55a7-a88e-efde8dfa69f3
responses:
'200':
description: OK
headers:
content-type:
schema:
type: string
example: application/json; charset=utf-8
date:
schema:
type: string
example: Thu, 25 May 2023 04:04:39 GMT
x-envoy-upstream-service-time:
schema:
type: integer
example: '100'
server:
schema:
type: string
example: istio-envoy
transfer-encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
example:
allowedOperations:
- VIRTUAL_MACHINE_BACKUP_CREATE
- VIRTUAL_MACHINE_BACKUP_UPDATE
- VIRTUAL_MACHINE_BACKUP_DELETE
- VIRTUAL_MACHINE_SNAPSHOT_CREATE
- VIRTUAL_MACHINE_SNAPSHOT_UPDATE
- VIRTUAL_MACHINE_SNAPSHOT_DELETE
- VIRTUAL_MACHINE_RESTORE
- VIRTUAL_MACHINE_DISKS_RESTORE
appInfo:
vmware:
datacenterInfo:
id: c4054a24-6929-5540-92c1-b5cbef88df21
moref: datacenter-3
name: CDS-TME-DC
datastoresInfo:
- displayName: 0-BRS-VMFS-Test4
id: 5708f692-146c-5943-8722-a82288618d80
name: 0-BRS-VMFS-Test4
resourceUri: >-
/api/v1/datastores/5708f692-146c-5943-8722-a82288618d80
type: DATASTORE
moref: vm-372675
resourcePoolInfo:
displayName: Resources
id: 31467e84-23e1-5132-8a39-f89ea4e1011c
moref: resgroup-9
name: Resources
resourceUri: >-
/api/v1/hypervisor-managers/0c9acaa0-fe6e-4037-bc43-eaa239798f6d/resource-pools/31467e84-23e1-5132-8a39-f89ea4e1011c
type: HYPERVISOR_RESOURCE_POOL
toolsInfo:
status: OK
type: guestToolsTypeMSI
version: '11334'
type: VMFS
appType: VMWARE
capacityInBytes: 155692564480
clusterInfo:
displayName: CDS-TME-Cluster
id: d6c952be-80f4-5c86-9a69-a23504dc3f6b
name: CDS-TME-Cluster
resourceUri: >-
/api/v1/hypervisor-clusters/d6c952be-80f4-5c86-9a69-a23504dc3f6b
type: HYPERVISOR_CLUSTER
computeInfo:
memorySizeInMib: '8192'
numCpuCores: 2
numCpuThreads: 4
createdAt: '2023-05-23T00:51:03.156Z'
customerId: eb988b5e2dcb11ec840712b3b5263ef4
displayName: 0-VM-RRD-VMFS-VM01-physical-RDM
folderInfo:
displayName: ''
id: ''
name: ''
resourceUri: ''
type: ''
generation: 144
guestInfo:
buildVersion: ''
name: Microsoft Windows Server 2016 or later (64-bit)
releaseVersion: ''
type: WINDOWS
hciClusterUuid: ''
hostInfo:
displayName: rtp-hpe-cds04.rtplab.nimblestorage.com
id: b75287f5-0fb6-5c9b-b671-7e9f2632e929
name: rtp-hpe-cds04.rtplab.nimblestorage.com
resourceUri: >-
/api/v1/hypervisor-hosts/b75287f5-0fb6-5c9b-b671-7e9f2632e929
type: HYPERVISOR_HOST
hypervisorManagerInfo:
displayName: CDS-TPM-VCENTER
id: 0c9acaa0-fe6e-4037-bc43-eaa239798f6d
name: cds-tme-vcenter.rtplab.nimblestorage.com
resourceUri: >-
/api/v1/hypervisor-managers/0c9acaa0-fe6e-4037-bc43-eaa239798f6d
type: HYPERVISOR_MANAGER
id: 34738538-6f8a-5326-a102-676a20b91b5e
name: 0-VM-RRD-VMFS-VM01-physical-RDM
networkAdapters:
- macAddress: 00:50:56:b7:29:2e
macAddressType: AUTOMATIC
name: Network adapter 2
networkDetails:
connectAtPowerOn: true
displayName: Mgmt-DPortGroup
id: dvportgroup-1003
name: Mgmt-DPortGroup
resourceUri: ''
state: ''
type: Vmxnet3
networkAddress: 10.234.36.225
powerState: POWERED_ON
protected: true
protectionJobInfo:
id: 97f41fc1-b308-40ed-9934-eff462c87310
protectionPolicyInfo:
id: 9a401e5e-09a7-4996-8008-f43a8ed1c116
name: Snapshot, Local, & Cloud Backup
resourceUri: >-
/api/v1/protection-policies/9a401e5e-09a7-4996-8008-f43a8ed1c116
type: PROTECTION_POLICY
resourceUri: /api/v1/protection-jobs/97f41fc1-b308-40ed-9934-eff462c87310
type: PROTECTION_JOB
protectionPolicyAppliedAtInfo:
id: ''
name: ''
resourceUri: ''
type: ''
protectionStatus: PARTIAL
recoveryPointsExist: true
resourceUri: /api/v1/virtual-machines/34738538-6f8a-5326-a102-676a20b91b5e
services:
- backup-and-recovery
state: OK
stateReason: OK
status: OK
type: VIRTUAL_MACHINE
uid: 4237ca59-abeb-481c-9c3e-17aa2a80617e
updatedAt: '2023-05-25T04:01:15.696Z'
vclsVm: false
virtualDisks:
- appInfo:
vmware:
datastoreInfo:
displayName: 0-BRS-VMFS-Test4
id: 5708f692-146c-5943-8722-a82288618d80
name: 0-BRS-VMFS-Test4
resourceUri: >-
/api/v1/datastores/5708f692-146c-5943-8722-a82288618d80
type: DATASTORE
diskUuidEnabled: true
type: VMFS
capacityInBytes: 42949672960
filePath: >-
[0-BRS-VMFS-Test4]
0-VM-RRD-VMFS-VM01-physical-RDM/0-VM-RRD-VMFS-VM01-physical-RDM.vmdk
id: a6f8c930-eadc-5e0f-aef6-66bac0b3280a
name: Hard disk 1
uid: 6000C298-8225-b663-46e4-67ef686f0d97
- appInfo:
vmware:
datastoreInfo:
displayName: 0-BRS-VMFS-Test4
id: 5708f692-146c-5943-8722-a82288618d80
name: 0-BRS-VMFS-Test4
resourceUri: >-
/api/v1/datastores/5708f692-146c-5943-8722-a82288618d80
type: DATASTORE
diskUuidEnabled: false
type: VMFS
capacityInBytes: 5368709120
filePath: >-
[0-BRS-VMFS-Test4]
0-VM-RRD-VMFS-VM01-physical-RDM/0-VM-RRD-VMFS-VM01-physical-RDM_1.vmdk
id: 787d7a5d-a12f-593a-a741-66f931ab377f
name: Hard disk 2
uid: 6000C294-9653-6aaf-18ac-d3919e9817b2
- appInfo:
vmware:
datastoreInfo:
displayName: 0-BRS-VMFS-Test4
id: 5708f692-146c-5943-8722-a82288618d80
name: 0-BRS-VMFS-Test4
resourceUri: >-
/api/v1/datastores/5708f692-146c-5943-8722-a82288618d80
type: DATASTORE
diskUuidEnabled: false
type: PRDM
capacityInBytes: 107374182400
filePath: >-
[0-BRS-VMFS-Test4]
0-VM-RRD-VMFS-VM01-physical-RDM/0-VM-RRD-VMFS-VM01-physical-RDM_2.vmdk
id: b416ad29-9212-5a0e-8998-990d21974637
name: Hard disk 3
uid: >-
01001e00003838363630316330383961373762303536633963653930303430396362326336536572766572
vmClassification: ''
vmConfigPath: >-
[0-BRS-VMFS-Test4]
0-VM-RRD-VMFS-VM01-physical-RDM/0-VM-RRD-VMFS-VM01-physical-RDM.vmx
vmPerfMetricInfo:
averageReadLatency: 0
averageWriteLatency: 0
cpuAllocatedInMhz: 0
cpuUsedInMhz: 0
memoryAllocatedInMb: 0
memoryUsedInMb: 0
storageAllocatedInKb: 0
storageUsedInBytes: 0
totalReadIops: 0
totalWriteIops: 0
vmProtectionGroupsInfo: null
volumesInfo:
- displayName: ''
id: ''
name: ''
resourceUri: ''
scsiIdentifier: ''
sizeInBytes: 0
storageFolderInfo:
displayName: ''
id: ''
name: ''
resourceUri: ''
type: ''
storagePoolInfo:
displayName: ''
id: ''
name: ''
resourceUri: ''
type: ''
storageSystemInfo:
displayName: group-rtp-array369
id: 409cb2c6
managed: true
name: group-rtp-array369
resourceUri: ''
serialNumber: ''
type: NIMBLE
vendorName: ''
type: ''
volumeSetInfo:
displayName: ''
id: ''
name: ''
resourceUri: ''
type: ''
/api/v1/virtual-machines/{vmId}/backups:
post:
tags:
- GLBR > VM Backups
summary: Create a backup of a VM (not implemented yet)
requestBody:
content:
application/json:
schema:
type: object
example:
backupGranularity: VMWARE_CBT
backupMode: FULL
backupType: BACKUP
description: Test API for cloud backup
expireAfter:
unit: DAYS
value: 2
lockFor:
unit: HOURS
value: 1
name: Test-API-Cloud
protectionStoreId: 501a99e7-fb79-4fd7-89d5-a5dfb3441859
sourceCopyInfo:
id: 90ad82bd-fa67-5bc0-9e37-728c19d08fd9
resourceUri: >-
/api/v1/virtual-machines/90ad82bd-fa67-5bc0-9e37-728c19d08fd9
type: SNAPSHOT
verify: false
parameters:
- name: vmId
in: path
schema:
type: string
required: true
example: e5ffa3bf-9df4-55a7-a88e-efde8dfa69f3
responses:
'200':
description: Successful response
content:
application/json: {}
get:
tags:
- GLBR > VM Backups
summary: Display Backups of a VM
parameters:
- name: select
in: query
schema:
type: string
example: id,backupType,consistency,expiresAt,name,pointInTime
- name: vmId
in: path
schema:
type: string
required: true
example: 34738538-6f8a-5326-a102-676a20b91b5e
responses:
'200':
description: OK
headers:
content-type:
schema:
type: string
example: application/json; charset=utf-8
date:
schema:
type: string
example: Thu, 25 May 2023 04:09:26 GMT
content-length:
schema:
type: integer
example: '1977'
x-envoy-upstream-service-time:
schema:
type: integer
example: '527'
server:
schema:
type: string
example: istio-envoy
content:
application/json:
schema:
type: object
example:
items:
- backupType: BACKUP
consistency: CRASH
expiresAt: '2023-05-25T16:57:56.251Z'
id: 49f10d8d-2cbe-45af-9d09-ab2e0f17ead1
indexed: NOT_INDEXED
name: 0-VM-RRD-VMFS-VM01-physical-RDM-2023-05-23-12:42:07
partialBackup: false
pointInTime: '2023-05-23T16:18:05.000Z'
- backupType: CLOUD_BACKUP
consistency: CRASH
expiresAt: '2023-06-06T16:36:55.108Z'
id: c1b59d18-b245-4c92-8cc4-9888f43597fa
indexed: NOT_INDEXED
name: HPE_Cloud_Protection_Store_2023-05-23-12:26:33
partialBackup: false
pointInTime: '2023-05-23T16:18:05.000Z'
- backupType: BACKUP
consistency: CRASH
expiresAt: '2023-05-28T16:24:56.608Z'
id: 0fb97fe4-43ab-4b6c-b148-ea9029d151f2
indexed: NOT_INDEXED
name: On-Premises_Protection_Store_2023-05-23-12:18:11
partialBackup: false
pointInTime: '2023-05-23T16:18:05.000Z'
- backupType: BACKUP
consistency: CRASH
expiresAt: '2023-05-28T16:36:58.359Z'
id: 2e43ac81-355a-4776-bce9-01205b2c0ffa
indexed: NOT_INDEXED
name: On-Premises_Protection_Store_2023-05-23-12:30:14
partialBackup: false
pointInTime: '2023-05-23T16:30:08.000Z'
- backupType: BACKUP
consistency: CRASH
expiresAt: '2023-05-29T03:05:50.062Z'
id: 92ce90b4-b19f-4796-938f-34e896094f5b
indexed: NOT_INDEXED
name: On-Premises_Protection_Store_2023-05-23-23:00:00
partialBackup: false
pointInTime: '2023-05-24T02:17:36.000Z'
- backupType: BACKUP
consistency: CRASH
expiresAt: '2023-05-29T22:17:37.694Z'
id: 960c43ab-d946-4bdf-8127-0148b22506d2
indexed: NOT_INDEXED
name: On-Premises_Protection_Store_2023-05-24-18:11:33
partialBackup: false
pointInTime: '2023-05-24T22:11:27.000Z'
- backupType: BACKUP
consistency: CRASH
expiresAt: '2023-05-30T03:02:33.853Z'
id: 7f31ed11-20f1-4905-941d-11ee98b3ba55
indexed: NOT_INDEXED
name: On-Premises_Protection_Store_2023-05-24-23:00:00
partialBackup: false
pointInTime: '2023-05-25T02:17:35.000Z'
pageLimit: 100
pageOffset: 0
total: 7
/api/v1/virtual-machines/{vmId}/backups/{backupId}/index-files:
post:
tags:
- GLBR > VM Backups
summary: Create Index of VM Files
requestBody:
content:
application/json:
schema:
type: object
example: ''
parameters:
- name: vmId
in: path
schema:
type: string
required: true
example: 8502b867-dfb1-5aa5-9b78-27f5826238e2
- name: backupId
in: path
schema:
type: string
required: true
example: acb9969f-6373-4a55-945f-99145113ee52
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/virtual-machines/{vmId}/backups/{backupId}/indexed-files:
get:
tags:
- GLBR > VM Backups
summary: Display files & folders from a backup of a VM
parameters:
- name: offset
in: query
schema:
type: integer
example: '0'
- name: limit
in: query
schema:
type: integer
example: '100'
- name: rootPath
in: query
schema:
type: string
example: /
- name: vmId
in: path
schema:
type: string
required: true
example: 8502b867-dfb1-5aa5-9b78-27f5826238e2
- name: backupId
in: path
schema:
type: string
required: true
example: acb9969f-6373-4a55-945f-99145113ee52
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/virtual-machines/{vmId}/backups/{backupId}:
delete:
tags:
- GLBR > VM Backups
summary: Delete a backup of a VM
parameters:
- name: vmId
in: path
schema:
type: string
required: true
example: 90ad82bd-fa67-5bc0-9e37-728c19d08fd9
- name: backupId
in: path
schema:
type: string
required: true
example: ca259665-2ca1-449a-994c-60a586d064e9
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/backup-recovery-reports/protection-jobs:
get:
tags:
- GLBR > Protection Jobs Report
summary: Report all protection jobs
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/protection-policies:
get:
tags:
- GLBR > Protection Policies
summary: Get All Protection Policies
parameters:
- name: 'filter '
in: query
schema:
type: string
example: >-
protectionJobsInfo.assetInfo,displayName eq
"0-VM-RRD-VMFS-VM01-physical-RDM"
responses:
'200':
description: Successful response
content:
application/json: {}
post:
tags:
- GLBR > Protection Policies
summary: Create a new protection policy
requestBody:
content:
application/json:
schema:
type: object
example:
description: >-
Protection Policy protecting Finance department's Virtual
Machines or datastores.
name: Gold-Protection-Policy
protections:
- applicationType: VMWARE
protectionStoreId: 2a1172be-4281-44f9-848b-9c3f86378b13
schedules:
- expireAfter:
unit: HOURS
value: 0
id: 0
lockFor:
unit: HOURS
value: 0
name: Hourly snapshot schedule
namePattern:
format: Test_{SourceAssetName}_Copy_{DateFormat}
schedule:
activeTime:
activeFromTime: '16:15'
activeUntilTime: '20:15'
recurrence: BY_MINUTES
repeatInterval:
every: 0
'on':
- 0
startTime: '16:35'
sourceProtectionScheduleId: 0
verify: false
type: SNAPSHOT
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/protection-policies/{policyId}:
get:
tags:
- GLBR > Protection Policies
summary: Get detailed info from a protection policy
parameters:
- name: policyId
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/protection-jobs/{protectionJobsId}/run:
post:
tags:
- GLBR > Protection Policies
summary: Run a protection job immediately
requestBody:
content:
application/json:
schema:
type: object
example:
scheduleIds:
- 3
parameters:
- name: protectionJobsId
in: path
schema:
type: string
required: true
example: 97f41fc1-b308-40ed-9934-eff462c87310
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v1/protection-jobs/{protectionJobId}:
get:
tags:
- GLBR > Protection Policies
summary: Show detailed existing protection Job
parameters:
- name: select
in: query
schema:
type: string
example: id
- name: protectionJobId
in: path
schema:
type: string
required: true
example: 97f41fc1-b308-40ed-9934-eff462c87310
responses:
'200':
description: OK
headers:
date:
schema:
type: string
example: Wed, 24 May 2023 22:10:11 GMT
server:
schema:
type: string
example: istio-envoy
content-length:
schema:
type: integer
example: '2519'
content-type:
schema:
type: string
example: application/json
x-envoy-upstream-service-time:
schema:
type: integer
example: '33'
content:
application/json:
schema:
type: object
example:
assetInfo:
id: 34738538-6f8a-5326-a102-676a20b91b5e
displayName: 0-VM-RRD-VMFS-VM01-physical-RDM
type: VIRTUAL_MACHINE
resourceUri: >-