-
Notifications
You must be signed in to change notification settings - Fork 0
/
ubicloud_openapi.yml
1214 lines (1201 loc) · 34.8 KB
/
ubicloud_openapi.yml
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: Clover API
version: "0.1.0"
description: API for managing resources on Ubicloud
servers:
- url: 'https://api.ubicloud.com'
security:
- BearerAuth: []
paths:
# LOGIN
/login:
post:
tags:
- Login
summary: Login with user information
operationId: login
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
login:
type: string
example: "[email protected]"
password:
type: string
example: "password"
required:
- login
- password
responses:
'200':
description: Logged in successfully.
headers:
Authorization:
description: JWT Token
schema:
type: string
'401':
description: Unauthorized
# PROJECT
/project:
get:
tags:
- Project
summary: List all projects visible to the logged in user.
operationId: listProjects
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/start_after'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/order_column'
responses:
'200':
description: Return the list of all projects visible to the logged in user
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Project'
count:
type: integer
'401':
description: Unauthorized
post:
tags:
- Project
summary: Create a new project
operationId: createProject
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: "my-project-name"
required:
- name
responses:
'200':
description: Project is created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'400':
description: InvalidRequest
'401':
description: Unauthorized
/project/{project_id}:
parameters:
- $ref: '#/components/parameters/project_id'
get:
tags:
- Project
summary: Retrieve a project
operationId: getProject
responses:
'200':
description: Retrieved project
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'401':
description: Unauthorized
'404':
description: Resource not found
delete:
tags:
- Project
summary: Delete a project
operationId: deleteProject
responses:
'204':
description: Project deleted successfully
'400':
description: Invalid request
'401':
description: Unauthorized
'404':
description: Resource not found
# VM
/project/{project_id}/vm:
get:
tags:
- Virtual Machine
summary: List all VMs created under the given project ID and visible to logged in user
operationId: listProjectVMs
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/start_after'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/order_column'
responses:
'200':
description: Return the list of all VMs visible created under the given project and visible to the logged in user
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Vm'
count:
type: integer
'401':
description: Unauthorized
/project/{project_id}/location/{location}/vm:
get:
tags:
- Virtual Machine
summary: List VMs in a specific location of a project
operationId: listLocationVMs
parameters:
- $ref: '#/components/parameters/project_id'
- in: path
name: location
required: true
schema:
type: string
description: Return the list VMs created in a specific location of a project and visible to the logged in user
- $ref: '#/components/parameters/start_after'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/order_column'
responses:
'200':
description: A list of VMs
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Vm'
count:
type: integer
'401':
description: Unauthorized
/project/{project_id}/location/{location}/vm/{vm_name}:
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/vm_name'
post:
tags:
- Virtual Machine
summary: Create a new VM in a specific location of a project
operationId: createVM
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
public_key:
type: string
description: Public SSH key for the VM
size:
type: string
description: Size of the VM
unix_user:
type: string
description: Unix user of the VM
boot_image:
type: string
description: Boot image of the VM
enable_ip4:
type: boolean
description: Enable IPv4
private_subnet_id:
type: string
description: ID of the private subnet
storage_size:
type: integer
description: Requested storage size in GiB
required:
- public_key
responses:
'200':
description: Virtual machine created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/VmDetailed'
'400':
description: Invalid request
'401':
description: Unauthorized
get:
tags:
- Virtual Machine
summary: Get details of a specific VM in a location
operationId: getVMDetails
responses:
'200':
description: Details of the VM
content:
application/json:
schema:
$ref: '#/components/schemas/VmDetailed'
'401':
description: Unauthorized
delete:
tags:
- Virtual Machine
summary: Delete a specific VM
operationId: deleteVM
responses:
'204':
description: VM deleted successfully
'401':
description: Unauthorized
/project/{project_id}/location/{location}/vm/id/{vm_id}:
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/vm_id'
get:
tags:
- Virtual Machine
summary: Get details of a specific VM in a location with ID
operationId: getVMDetailsWithId
responses:
'200':
description: Details of the VM
content:
application/json:
schema:
$ref: '#/components/schemas/VmDetailed'
'401':
description: Unauthorized
delete:
tags:
- Virtual Machine
summary: Delete a specific VM with ID
operationId: deleteVMWithId
responses:
'204':
description: VM deleted successfully
'401':
description: Unauthorized
# PRIVATE SUBNET
/project/{project_id}/private-subnet:
get:
tags:
- Private Subnet
summary: List visible Private Subnets
operationId: listPSs
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/start_after'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/order_column'
responses:
'200':
description: A list of private subnets
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/PrivateSubnet'
count:
type: integer
'401':
description: Unauthorized
'404':
description: Resource is not found
/project/{project_id}/location/{location}/private-subnet:
get:
tags:
- Private Subnet
summary: List Private Subnets in a specific location of a project
operationId: listLocationPrivateSubnets
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/start_after'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/order_column'
responses:
'200':
description: A list of Private Subnets in a location
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/PrivateSubnet'
count:
type: integer
'401':
description: Unauthorized
'404':
description: Resource not found
/project/{project_id}/location/{location}/private-subnet/{private_subnet_name}:
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/private_subnet_name'
post:
tags:
- Private Subnet
summary: Create a new Private Subnet in a specific location of a project
operationId: createPrivateSubnet
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
firewall_id:
type: string
responses:
'200':
description: Private subnet is created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateSubnet'
'401':
description: Unauthorized
get:
tags:
- Private Subnet
summary: Get details of a specific Private Subnet in a location
operationId: getPrivateSubnetDetails
responses:
'200':
description: Details of the private subnet
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateSubnet'
'401':
description: Unauthorized
'404':
description: Resource not found
delete:
tags:
- Private Subnet
summary: Delete a specific Private Subnet
operationId: deletePrivateSubnet
responses:
'204':
description: Private Subnet is deleted successfully
'401':
description: Unauthorized
/project/{project_id}/location/{location}/private-subnet/id/{private_subnet_id}:
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/private_subnet_id'
get:
tags:
- Private Subnet
summary: Get details of a specific Private Subnet in a location with ID
operationId: getPSDetailsWithId
responses:
'200':
description: Details of the private subnet
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateSubnet'
'401':
description: Unauthorized
delete:
tags:
- Private Subnet
summary: Delete a specific Private Subnet with ID
operationId: deletePSWithId
responses:
'204':
description: Private Subnet is deleted successfully
'401':
description: Unauthorized
# POSTGRES
/project/{project_id}/postgres:
get:
tags:
- Postgres
summary: List visible Postgres databases
operationId: listPostgresDatabases
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/start_after'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/order_column'
responses:
'200':
description: A list of Postgres databases
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Postgres'
count:
type: integer
'401':
description: Unauthorized
/project/{project_id}/location/{location}/postgres:
get:
tags:
- Postgres
summary: List Postgres databases in a specific location of a project
operationId: listLocationPostgresDatabases
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/start_after'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/order_column'
responses:
'200':
description: A list of Postgres databases in a specific location of a project
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Postgres'
count:
type: integer
'401':
description: Unauthorized
/project/{project_id}/location/{location}/postgres/{postgres_database_name}:
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/postgres_database_name'
post:
tags:
- Postgres
summary: Create a new Postgres database in a specific location of a project
operationId: createPostgresDatabase
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
size:
type: string
description: Requested size for the underlying VM
ha_type:
type: string
description: High availability type
storage_size:
type: integer
description: Requested storage size in GiB
required:
- size
responses:
'200':
description: Postgres database is created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/PostgresDetailed'
'401':
description: Unauthorized
get:
tags:
- Postgres
summary: Get details of a specific Postgres database in a location
operationId: getPostgresDatabaseDetails
responses:
'200':
description: Details of the Postgres database
content:
application/json:
schema:
$ref: '#/components/schemas/PostgresDetailed'
'401':
description: Unauthorized
delete:
tags:
- Postgres
summary: Delete a specific Postgres database
operationId: deletePostgresDatabase
responses:
'204':
description: Postgres database is deleted successfully
'401':
description: Unauthorized
/project/{project_id}/location/{location}/postgres/{postgres_database_name}/restore:
post:
tags:
- Postgres
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/postgres_database_name'
summary: Restore a new Postgres database in a specific location of a project
operationId: restorePostgresDatabase
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
restore_target:
type: string
required:
- name, restore_target
responses:
'200':
description: Postgres database is restored successfully
content:
application/json:
schema:
$ref: '#/components/schemas/PostgresDetailed'
'401':
description: Unauthorized
/project/{project_id}/location/{location}/postgres/{postgres_database_name}/reset-superuser-password:
post:
tags:
- Postgres
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/postgres_database_name'
summary: Reset superuser password of the Postgres database
operationId: resetSuperuserPassword
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
password:
type: string
required:
- password
responses:
'200':
description: Superuser password is updated
content:
application/json:
schema:
$ref: '#/components/schemas/PostgresDetailed'
'401':
description: Unauthorized
/project/{project_id}/location/{location}/postgres/id/{postgres_database_id}:
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/postgres_database_id'
get:
tags:
- Postgres
summary: Get details of a specific Postgres database in a location with ID
operationId: getPostgresDetailsWithId
responses:
'200':
description: Details of the Postgres databases in a location
content:
application/json:
schema:
$ref: '#/components/schemas/PostgresDetailed'
delete:
tags:
- Postgres
summary: Delete a specific Postgres database with ID
operationId: deletePostgresDatabaseWithID
responses:
'204':
description: Postgres database is deleted successfully
'401':
description: Unauthorized
/project/{project_id}/location/{location}/postgres/id/{postgres_database_id}/restore:
post:
tags:
- Postgres
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/postgres_database_id'
summary: Restore a new Postgres database in a specific location of a project with ID
operationId: restorePostgresDatabaseWithID
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
restore_target:
type: string
required:
- name, restore_target
responses:
'200':
description: Postgres database is restored successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Postgres'
'401':
description: Unauthorized
/project/{project_id}/location/{location}/postgres/id/{postgres_database_id}/reset-superuser-password:
post:
tags:
- Postgres
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/postgres_database_id'
summary: Reset super-user password of the Postgres database
operationId: resetSuperuserPasswordWithID
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
password:
type: string
required:
- password
responses:
'200':
description: Superuser password is updated
content:
application/json:
schema:
$ref: '#/components/schemas/PostgresDetailed'
'401':
description: Unauthorized
# FIREWALL RULES
/project/{project_id}/firewall/{firewall_id}/firewall-rule:
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/firewall_id'
post:
tags:
- Firewall Rule
summary: Create a new firewall rule
operationId: createFirewallRule
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
project_id:
type: string
firewall_id:
type: string
cidr:
type: string
description: CIDR of the firewall rule
port_range:
type: string
description: Port range of the firewall rule
required:
- cidr
responses:
'200':
description: Firewall rule created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/FirewallRule'
'400':
description: Invalid request
'401':
description: Unauthorized
/project/{project_id}/firewall/{firewall_id}/firewall-rule/{firewall_rule_id}:
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/firewall_id'
- $ref: '#/components/parameters/firewall_rule_id'
get:
tags:
- Firewall Rule
summary: Get details of a firewall rule
operationId: getFirewallRuleDetails
responses:
'200':
description: Details of the firewall rule
content:
application/json:
schema:
$ref: '#/components/schemas/FirewallRule'
'401':
description: Unauthorized
delete:
tags:
- Firewall Rule
summary: Delete a specific firewall rule
operationId: deleteFirewallRule
responses:
'204':
description: Firewall rule deleted successfully
'401':
description: Unauthorized
# FIREWALL
/project/{project_id}/firewall:
parameters:
- $ref: '#/components/parameters/project_id'
post:
tags:
- Firewall
summary: Create a new firewall
operationId: createFirewall
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name of the firewall
description:
type: string
description: Description of the firewall
required:
- name
responses:
'200':
description: Firewall created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Firewall'
'400':
description: Invalid request
'401':
description: Unauthorized
/project/{project_id}/firewall/{firewall_id}:
parameters:
- $ref: '#/components/parameters/project_id'
- $ref: '#/components/parameters/firewall_id'
get:
tags:
- Firewall
summary: Get details of a specific firewall
operationId: getFirewallDetails
responses:
'200':
description: Details of the firewall
content:
application/json:
schema:
$ref: '#/components/schemas/Firewall'
'401':
description: Unauthorized
delete:
tags:
- Firewall
summary: Delete a specific firewall
operationId: deleteFirewall
responses:
'204':
description: Firewall deleted successfully
'401':
description: Unauthorized
components:
securitySchemes:
BearerAuth: # Arbitrary name for the security scheme
type: http
scheme: bearer
bearerFormat: JWT # Optional, just for documentation purposes
schemas:
Project:
type: object
properties:
id:
type: string
example: pjw92xhhqjdy4g72xng1ubkda6
name:
type: string
example: my-project
description: Name of the project
credit:
type: number
format: float
example: 25.4
description: Remaining credit of the project in $
discount:
type: integer
example: 10
description: Discount of the project as percentage
Vm:
type: object
properties:
id:
type: string
example: vmw12ouhqjdy4g72xng1ubkda6
description: ID of the VM
name:
type: string
example: "my-vm-name"
description: Name of the VM
state:
type: string
description: State of the VM
location:
type: string
example: "eu-north-h1"
description: Location of the VM
size:
type: string
description: Size of the underlying VM
unix_user:
type: string
description: Unix user of the VM
storage_size_gib:
type: integer
description: Storage size in GiB
ip6:
type: string
format: ipv6
description: IPv6 address
ip4:
type: string
format: ipv4
description: IPv4 address
VmDetailed:
type: object
properties:
id:
type: string
example: vmw12ouhqjdy4g72xng1ubkda6
description: ID of the VM
name:
type: string
example: "my-vm-name"
description: Name of the VM
state:
type: string
description: State of the VM
location:
type: string
example: "eu-north-h1"
description: Location of the VM
size:
type: string
description: Size of the underlying VM
unix_user:
type: string
description: Unix user of the VM
storage_size_gib:
type: integer
description: Storage size in GiB
ip6:
type: string
format: ipv6
description: IPv6 address
ip4:
type: string
format: ipv4
description: IPv4 address
private_ipv6:
type: string
format: ipv6
description: Private IPv6 address
private_ipv4:
type: string
format: ipv4
description: Private IPv4 address
subnet:
type: string
description: Subnet of the VM
firewalls:
type: array
description: List of firewalls
items:
$ref: '#/components/schemas/Firewall'
Firewall:
type: object
properties:
id:
type: string
description: ID of the firewall
name:
type: string
description: Name of the firewall
description:
type: string
description: Description of the firewall
firewall_rules:
type: array
description: List of firewall rules
items:
$ref: '#/components/schemas/FirewallRule'
FirewallRule:
type: object
properties:
id:
type: string
description: ID of the firewall rule
cidr:
type: string
description: CIDR of the firewall rule
port_range:
type: string
description: Port range of the firewall rule
Nic:
type: object
properties: