|
1 | 1 | {
|
2 | 2 | "components": {
|
3 | 3 | "parameters": {
|
| 4 | + "backupId": { |
| 5 | + "description": "Backup id", |
| 6 | + "in": "path", |
| 7 | + "name": "backupId", |
| 8 | + "required": true, |
| 9 | + "schema": { |
| 10 | + "type": "integer" |
| 11 | + } |
| 12 | + }, |
4 | 13 | "instanceId": {
|
5 | 14 | "description": "Instance id",
|
6 | 15 | "in": "path",
|
|
82 | 91 | ],
|
83 | 92 | "type": "object"
|
84 | 93 | },
|
| 94 | + "CreateBackupResponse": { |
| 95 | + "items": { |
| 96 | + "$ref": "#/components/schemas/CreateBackupResponseItem" |
| 97 | + }, |
| 98 | + "type": "array" |
| 99 | + }, |
| 100 | + "CreateBackupResponseItem": { |
| 101 | + "properties": { |
| 102 | + "id": { |
| 103 | + "type": "integer" |
| 104 | + }, |
| 105 | + "message": { |
| 106 | + "type": "string" |
| 107 | + } |
| 108 | + }, |
| 109 | + "required": [ |
| 110 | + "id", |
| 111 | + "message" |
| 112 | + ], |
| 113 | + "type": "object" |
| 114 | + }, |
85 | 115 | "CreateInstancePayload": {
|
86 | 116 | "properties": {
|
87 | 117 | "instanceName": {
|
|
577 | 607 | ],
|
578 | 608 | "type": "object"
|
579 | 609 | },
|
| 610 | + "ListRestoresResponse": { |
| 611 | + "properties": { |
| 612 | + "instanceRestores": { |
| 613 | + "items": { |
| 614 | + "$ref": "#/components/schemas/Restore" |
| 615 | + }, |
| 616 | + "type": "array" |
| 617 | + } |
| 618 | + }, |
| 619 | + "required": [ |
| 620 | + "instanceRestores" |
| 621 | + ], |
| 622 | + "type": "object" |
| 623 | + }, |
580 | 624 | "Object": {
|
581 | 625 | "type": "object"
|
582 | 626 | },
|
|
680 | 724 | ],
|
681 | 725 | "type": "object"
|
682 | 726 | },
|
| 727 | + "Restore": { |
| 728 | + "properties": { |
| 729 | + "backup_id": { |
| 730 | + "type": "integer" |
| 731 | + }, |
| 732 | + "finished_at": { |
| 733 | + "type": "string" |
| 734 | + }, |
| 735 | + "id": { |
| 736 | + "type": "integer" |
| 737 | + }, |
| 738 | + "status": { |
| 739 | + "type": "string" |
| 740 | + }, |
| 741 | + "triggered_at": { |
| 742 | + "type": "string" |
| 743 | + } |
| 744 | + }, |
| 745 | + "required": [ |
| 746 | + "id", |
| 747 | + "backup_id", |
| 748 | + "status", |
| 749 | + "finished_at" |
| 750 | + ], |
| 751 | + "type": "object" |
| 752 | + }, |
683 | 753 | "Schema": {
|
684 | 754 | "properties": {
|
685 | 755 | "parameters": {
|
|
690 | 760 | "parameters"
|
691 | 761 | ],
|
692 | 762 | "type": "object"
|
| 763 | + }, |
| 764 | + "TriggerRestoreResponse": { |
| 765 | + "properties": { |
| 766 | + "id": { |
| 767 | + "type": "integer" |
| 768 | + } |
| 769 | + }, |
| 770 | + "required": [ |
| 771 | + "id" |
| 772 | + ], |
| 773 | + "type": "object" |
| 774 | + }, |
| 775 | + "UpdateBackupsConfigPayload": { |
| 776 | + "properties": { |
| 777 | + "encryption_key": { |
| 778 | + "type": "string" |
| 779 | + } |
| 780 | + }, |
| 781 | + "type": "object" |
| 782 | + }, |
| 783 | + "UpdateBackupsConfigResponse": { |
| 784 | + "properties": { |
| 785 | + "message": { |
| 786 | + "type": "string" |
| 787 | + } |
| 788 | + }, |
| 789 | + "required": [ |
| 790 | + "message" |
| 791 | + ], |
| 792 | + "type": "object" |
693 | 793 | }
|
694 | 794 | }
|
695 | 795 | },
|
|
933 | 1033 | }
|
934 | 1034 | },
|
935 | 1035 | "summary": "get latest backup information for provided instanceId"
|
| 1036 | + }, |
| 1037 | + "post": { |
| 1038 | + "operationId": "CreateBackup", |
| 1039 | + "parameters": [ |
| 1040 | + { |
| 1041 | + "$ref": "#/components/parameters/instanceId" |
| 1042 | + }, |
| 1043 | + { |
| 1044 | + "$ref": "#/components/parameters/projectId" |
| 1045 | + } |
| 1046 | + ], |
| 1047 | + "responses": { |
| 1048 | + "201": { |
| 1049 | + "content": { |
| 1050 | + "application/json": { |
| 1051 | + "schema": { |
| 1052 | + "$ref": "#/components/schemas/CreateBackupResponse" |
| 1053 | + } |
| 1054 | + } |
| 1055 | + }, |
| 1056 | + "description": "Created" |
| 1057 | + }, |
| 1058 | + "404": { |
| 1059 | + "$ref": "#/components/responses/NotFound" |
| 1060 | + }, |
| 1061 | + "500": { |
| 1062 | + "$ref": "#/components/responses/ServerError" |
| 1063 | + } |
| 1064 | + }, |
| 1065 | + "summary": "create a backup" |
| 1066 | + } |
| 1067 | + }, |
| 1068 | + "/v1/projects/{projectId}/instances/{instanceId}/backups-config": { |
| 1069 | + "patch": { |
| 1070 | + "description": "Update the configuration for backups for your instance.", |
| 1071 | + "operationId": "UpdateBackupsConfig", |
| 1072 | + "parameters": [ |
| 1073 | + { |
| 1074 | + "$ref": "#/components/parameters/instanceId" |
| 1075 | + }, |
| 1076 | + { |
| 1077 | + "$ref": "#/components/parameters/projectId" |
| 1078 | + } |
| 1079 | + ], |
| 1080 | + "requestBody": { |
| 1081 | + "content": { |
| 1082 | + "application/json": { |
| 1083 | + "schema": { |
| 1084 | + "$ref": "#/components/schemas/UpdateBackupsConfigPayload" |
| 1085 | + } |
| 1086 | + } |
| 1087 | + }, |
| 1088 | + "description": "Parameters for the requested backup configuration update", |
| 1089 | + "required": true |
| 1090 | + }, |
| 1091 | + "responses": { |
| 1092 | + "200": { |
| 1093 | + "content": { |
| 1094 | + "application/json": { |
| 1095 | + "schema": { |
| 1096 | + "$ref": "#/components/schemas/UpdateBackupsConfigResponse" |
| 1097 | + } |
| 1098 | + } |
| 1099 | + }, |
| 1100 | + "description": "OK" |
| 1101 | + }, |
| 1102 | + "404": { |
| 1103 | + "$ref": "#/components/responses/NotFound" |
| 1104 | + }, |
| 1105 | + "500": { |
| 1106 | + "$ref": "#/components/responses/ServerError" |
| 1107 | + } |
| 1108 | + }, |
| 1109 | + "summary": "backups configuration update" |
| 1110 | + } |
| 1111 | + }, |
| 1112 | + "/v1/projects/{projectId}/instances/{instanceId}/backups/{backupId}/download": { |
| 1113 | + "get": { |
| 1114 | + "operationId": "DownloadBackup", |
| 1115 | + "parameters": [ |
| 1116 | + { |
| 1117 | + "$ref": "#/components/parameters/backupId" |
| 1118 | + }, |
| 1119 | + { |
| 1120 | + "$ref": "#/components/parameters/instanceId" |
| 1121 | + }, |
| 1122 | + { |
| 1123 | + "$ref": "#/components/parameters/projectId" |
| 1124 | + } |
| 1125 | + ], |
| 1126 | + "responses": { |
| 1127 | + "200": { |
| 1128 | + "content": { |
| 1129 | + "application/octet-stream": { |
| 1130 | + "schema": { |
| 1131 | + "format": "binary", |
| 1132 | + "type": "string" |
| 1133 | + } |
| 1134 | + } |
| 1135 | + }, |
| 1136 | + "description": "OK" |
| 1137 | + }, |
| 1138 | + "500": { |
| 1139 | + "$ref": "#/components/responses/ServerError" |
| 1140 | + } |
| 1141 | + }, |
| 1142 | + "summary": "download backup" |
| 1143 | + } |
| 1144 | + }, |
| 1145 | + "/v1/projects/{projectId}/instances/{instanceId}/backups/{backupId}/restore": { |
| 1146 | + "post": { |
| 1147 | + "operationId": "TriggerRestore", |
| 1148 | + "parameters": [ |
| 1149 | + { |
| 1150 | + "$ref": "#/components/parameters/instanceId" |
| 1151 | + }, |
| 1152 | + { |
| 1153 | + "$ref": "#/components/parameters/projectId" |
| 1154 | + }, |
| 1155 | + { |
| 1156 | + "$ref": "#/components/parameters/backupId" |
| 1157 | + } |
| 1158 | + ], |
| 1159 | + "responses": { |
| 1160 | + "200": { |
| 1161 | + "content": { |
| 1162 | + "application/json": { |
| 1163 | + "schema": { |
| 1164 | + "$ref": "#/components/schemas/TriggerRestoreResponse" |
| 1165 | + } |
| 1166 | + } |
| 1167 | + }, |
| 1168 | + "description": "OK" |
| 1169 | + }, |
| 1170 | + "404": { |
| 1171 | + "$ref": "#/components/responses/NotFound" |
| 1172 | + }, |
| 1173 | + "500": { |
| 1174 | + "$ref": "#/components/responses/ServerError" |
| 1175 | + } |
| 1176 | + }, |
| 1177 | + "summary": "trigger a restore" |
936 | 1178 | }
|
937 | 1179 | },
|
938 | 1180 | "/v1/projects/{projectId}/instances/{instanceId}/credentials": {
|
|
1111 | 1353 | "summary": "get latest metrics for cpu load, memory and disk usage"
|
1112 | 1354 | }
|
1113 | 1355 | },
|
| 1356 | + "/v1/projects/{projectId}/instances/{instanceId}/recreate": { |
| 1357 | + "patch": { |
| 1358 | + "operationId": "TriggerRecreate", |
| 1359 | + "parameters": [ |
| 1360 | + { |
| 1361 | + "$ref": "#/components/parameters/instanceId" |
| 1362 | + }, |
| 1363 | + { |
| 1364 | + "$ref": "#/components/parameters/projectId" |
| 1365 | + } |
| 1366 | + ], |
| 1367 | + "responses": { |
| 1368 | + "202": { |
| 1369 | + "content": { |
| 1370 | + "application/json": { |
| 1371 | + "schema": { |
| 1372 | + "$ref": "#/components/schemas/CreateInstanceResponse" |
| 1373 | + } |
| 1374 | + } |
| 1375 | + }, |
| 1376 | + "description": "Accepted" |
| 1377 | + }, |
| 1378 | + "404": { |
| 1379 | + "$ref": "#/components/responses/NotFound" |
| 1380 | + }, |
| 1381 | + "500": { |
| 1382 | + "$ref": "#/components/responses/ServerError" |
| 1383 | + } |
| 1384 | + }, |
| 1385 | + "summary": "trigger a recreate" |
| 1386 | + } |
| 1387 | + }, |
| 1388 | + "/v1/projects/{projectId}/instances/{instanceId}/restart": { |
| 1389 | + "patch": { |
| 1390 | + "operationId": "TriggerRestart", |
| 1391 | + "parameters": [ |
| 1392 | + { |
| 1393 | + "$ref": "#/components/parameters/instanceId" |
| 1394 | + }, |
| 1395 | + { |
| 1396 | + "$ref": "#/components/parameters/projectId" |
| 1397 | + } |
| 1398 | + ], |
| 1399 | + "responses": { |
| 1400 | + "202": { |
| 1401 | + "content": { |
| 1402 | + "application/json": { |
| 1403 | + "schema": { |
| 1404 | + "$ref": "#/components/schemas/CreateInstanceResponse" |
| 1405 | + } |
| 1406 | + } |
| 1407 | + }, |
| 1408 | + "description": "Accepted" |
| 1409 | + }, |
| 1410 | + "404": { |
| 1411 | + "$ref": "#/components/responses/NotFound" |
| 1412 | + }, |
| 1413 | + "500": { |
| 1414 | + "$ref": "#/components/responses/ServerError" |
| 1415 | + } |
| 1416 | + }, |
| 1417 | + "summary": "trigger a restart" |
| 1418 | + } |
| 1419 | + }, |
| 1420 | + "/v1/projects/{projectId}/instances/{instanceId}/restores": { |
| 1421 | + "get": { |
| 1422 | + "operationId": "ListRestores", |
| 1423 | + "parameters": [ |
| 1424 | + { |
| 1425 | + "$ref": "#/components/parameters/instanceId" |
| 1426 | + }, |
| 1427 | + { |
| 1428 | + "$ref": "#/components/parameters/projectId" |
| 1429 | + } |
| 1430 | + ], |
| 1431 | + "responses": { |
| 1432 | + "200": { |
| 1433 | + "content": { |
| 1434 | + "application/json": { |
| 1435 | + "schema": { |
| 1436 | + "$ref": "#/components/schemas/ListRestoresResponse" |
| 1437 | + } |
| 1438 | + } |
| 1439 | + }, |
| 1440 | + "description": "OK" |
| 1441 | + }, |
| 1442 | + "404": { |
| 1443 | + "$ref": "#/components/responses/NotFound" |
| 1444 | + } |
| 1445 | + }, |
| 1446 | + "summary": "get latest restore information for provided instanceId" |
| 1447 | + } |
| 1448 | + }, |
1114 | 1449 | "/v1/projects/{projectId}/offerings": {
|
1115 | 1450 | "get": {
|
1116 | 1451 | "description": "Get the service offerings that the service broker offers.",
|
|
0 commit comments