@xen-orchestra/rest-api 0.24.0 → 0.25.0

package/open-api/spec/swagger.json

@@ -2373,6 +2373,47 @@
 							"params": {
 								"$ref": "#/components/schemas/Record_string.unknown_"
 							},
+							"objectType": {
+								"type": "string",
+								"enum": [
+									"pool",
+									"VBD",
+									"host",
+									"VIF",
+									"VTPM",
+									"VM",
+									"VM-snapshot",
+									"SR",
+									"message",
+									"vgpu",
+									"gpuGroup",
+									"network",
+									"PBD",
+									"PCI",
+									"PGPU",
+									"PIF",
+									"VDI",
+									"VDI-snapshot",
+									"VDI-unmanaged",
+									"vgpuType",
+									"VM-controller",
+									"VM-template",
+									"SM",
+									"backup",
+									"backup-archive",
+									"backup-job",
+									"backup-log",
+									"backup-repository",
+									"group",
+									"proxy",
+									"restore",
+									"restore-log",
+									"schedule",
+									"server",
+									"task",
+									"user"
+								]
+							},
 							"objectId": {
 								"type": "string"
 							},
@@ -2481,6 +2522,47 @@
 							"params": {
 								"$ref": "#/components/schemas/Record_string.unknown_"
 							},
+							"objectType": {
+								"type": "string",
+								"enum": [
+									"backup",
+									"pool",
+									"VBD",
+									"host",
+									"VIF",
+									"VTPM",
+									"VM",
+									"VM-snapshot",
+									"SR",
+									"message",
+									"vgpu",
+									"gpuGroup",
+									"network",
+									"PBD",
+									"PCI",
+									"PGPU",
+									"PIF",
+									"VDI",
+									"VDI-snapshot",
+									"VDI-unmanaged",
+									"vgpuType",
+									"VM-controller",
+									"VM-template",
+									"SM",
+									"user",
+									"proxy",
+									"task",
+									"backup-archive",
+									"backup-job",
+									"backup-log",
+									"backup-repository",
+									"group",
+									"restore",
+									"restore-log",
+									"schedule",
+									"server"
+								]
+							},
 							"objectId": {
 								"type": "string"
 							},
@@ -5559,6 +5641,80 @@
 			"UnbrandedXoVif": {
 				"$ref": "#/components/schemas/Unbrand_XoVif_"
 			},
+			"Pick_CreateVifParams_91_0_93_.Exclude_keyofCreateVifParams_91_0_93_.network-or-VM__": {
+				"properties": {
+					"other_config": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					},
+					"device": {
+						"type": "string"
+					},
+					"MTU": {
+						"type": "number",
+						"format": "double"
+					},
+					"currently_attached": {
+						"type": "boolean"
+					},
+					"ipv4_allowed": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"ipv6_allowed": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"locking_mode": {
+						"$ref": "#/components/schemas/VIF_LOCKING_MODE"
+					},
+					"qos_algorithm_params": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					},
+					"qos_algorithm_type": {
+						"type": "string"
+					}
+				},
+				"type": "object",
+				"description": "From T, pick a set of properties whose keys are in the union K"
+			},
+			"Omit_CreateVifParams_91_0_93_.network-or-VM_": {
+				"$ref": "#/components/schemas/Pick_CreateVifParams_91_0_93_.Exclude_keyofCreateVifParams_91_0_93_.network-or-VM__",
+				"description": "Construct a type with the properties of T except for those in type K."
+			},
+			"CreateVifBody": {
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/Omit_CreateVifParams_91_0_93_.network-or-VM_"
+					},
+					{
+						"properties": {
+							"MAC": {
+								"type": "string"
+							}
+						},
+						"type": "object"
+					},
+					{
+						"properties": {
+							"vmId": {
+								"type": "string"
+							},
+							"networkId": {
+								"type": "string"
+							}
+						},
+						"required": [
+							"vmId",
+							"networkId"
+						],
+						"type": "object"
+					}
+				]
+			},
 			"Exclude_SUPPORTED_VDI_FORMAT.qcow2_": {
 				"type": "string",
 				"enum": [
@@ -5671,6 +5827,76 @@
 				],
 				"type": "object"
 			},
+			"Pick_CreateVdiParams_91_0_93_.Exclude_keyofCreateVdiParams_91_0_93_.SR__": {
+				"properties": {
+					"name_description": {
+						"type": "string"
+					},
+					"name_label": {
+						"type": "string"
+					},
+					"tags": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"type": {
+						"$ref": "#/components/schemas/VDI_TYPE"
+					},
+					"other_config": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					},
+					"read_only": {
+						"type": "boolean"
+					},
+					"sharable": {
+						"type": "boolean"
+					},
+					"virtual_size": {
+						"type": "number",
+						"format": "double"
+					},
+					"xenstore_data": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					}
+				},
+				"required": [
+					"virtual_size"
+				],
+				"type": "object",
+				"description": "From T, pick a set of properties whose keys are in the union K"
+			},
+			"Omit_CreateVdiParams_91_0_93_.SR_": {
+				"$ref": "#/components/schemas/Pick_CreateVdiParams_91_0_93_.Exclude_keyofCreateVdiParams_91_0_93_.SR__",
+				"description": "Construct a type with the properties of T except for those in type K."
+			},
+			"CreateVdiBody": {
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/Omit_CreateVdiParams_91_0_93_.SR_"
+					},
+					{
+						"properties": {
+							"srId": {
+								"type": "string"
+							}
+						},
+						"required": [
+							"srId"
+						],
+						"type": "object"
+					},
+					{
+						"properties": {
+							"sm_config": {
+								"$ref": "#/components/schemas/Record_string.string_"
+							}
+						},
+						"type": "object"
+					}
+				]
+			},
 			"CreateActionReturnType__id-Unbrand_XoVdi__91_id_93___": {
 				"anyOf": [
 					{
@@ -5835,18 +6061,18 @@
 					"mode": {
 						"$ref": "#/components/schemas/VBD_MODE"
 					},
-					"bootable": {
-						"type": "boolean"
-					},
-					"empty": {
-						"type": "boolean"
-					},
 					"qos_algorithm_params": {
 						"$ref": "#/components/schemas/Record_string.string_"
 					},
 					"qos_algorithm_type": {
 						"type": "string"
 					},
+					"bootable": {
+						"type": "boolean"
+					},
+					"empty": {
+						"type": "boolean"
+					},
 					"unpluggable": {
 						"type": "boolean"
 					},
@@ -6305,6 +6531,47 @@
 							"params": {
 								"$ref": "#/components/schemas/Record_string.unknown_"
 							},
+							"objectType": {
+								"type": "string",
+								"enum": [
+									"backup",
+									"pool",
+									"VBD",
+									"host",
+									"VIF",
+									"VTPM",
+									"VM",
+									"VM-snapshot",
+									"SR",
+									"message",
+									"vgpu",
+									"gpuGroup",
+									"network",
+									"PBD",
+									"PCI",
+									"PGPU",
+									"PIF",
+									"VDI",
+									"VDI-snapshot",
+									"VDI-unmanaged",
+									"vgpuType",
+									"VM-controller",
+									"VM-template",
+									"SM",
+									"user",
+									"proxy",
+									"task",
+									"backup-archive",
+									"backup-job",
+									"backup-log",
+									"backup-repository",
+									"group",
+									"restore",
+									"restore-log",
+									"schedule",
+									"server"
+								]
+							},
 							"objectId": {
 								"type": "string"
 							},
@@ -7852,23 +8119,50 @@
 						"type": "array"
 					},
 					"install": {
-						"properties": {
-							"repository": {
-								"type": "string"
+						"anyOf": [
+							{
+								"properties": {
+									"repository": {
+										"type": "string"
+									},
+									"method": {
+										"type": "string",
+										"enum": [
+											"cdrom"
+										],
+										"nullable": false
+									}
+								},
+								"required": [
+									"repository",
+									"method"
+								],
+								"type": "object"
 							},
-							"method": {
-								"type": "string",
-								"enum": [
-									"network",
-									"cdrom"
-								]
+							{
+								"properties": {
+									"repository": {
+										"type": "string",
+										"enum": [
+											""
+										],
+										"nullable": false
+									},
+									"method": {
+										"type": "string",
+										"enum": [
+											"network"
+										],
+										"nullable": false
+									}
+								},
+								"required": [
+									"repository",
+									"method"
+								],
+								"type": "object"
 							}
-						},
-						"required": [
-							"repository",
-							"method"
-						],
-						"type": "object"
+						]
 					},
 					"cloud_config": {
 						"type": "string"
@@ -12052,7 +12346,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.24.0",
+		"version": "0.25.0",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"
@@ -15423,9 +15717,138 @@
 				]
 			}
 		},
-		"/vm-templates": {
-			"get": {
-				"operationId": "GetVmTemplates",
+		"/vms/{id}/actions/migrate": {
+			"post": {
+				"operationId": "MigrateVm",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CreateActionReturnType_void_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"taskId": "0m7kl0j9l"
+										}
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"description": "VIF mapping is not allowed for intra-pool migration\n\nNetworks and SRs must belong to the same pool as the destination host",
+				"tags": [
+					"vms"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "613f541c-4bed-fc77-7ca8-2db6b68f079c"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				],
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"anyOf": [
+									{
+										"properties": {
+											"migrationNetworkId": {
+												"type": "string"
+											},
+											"hostId": {
+												"type": "string"
+											}
+										},
+										"required": [
+											"hostId"
+										],
+										"type": "object"
+									},
+									{
+										"properties": {
+											"networkIdByVifId": {
+												"properties": {},
+												"additionalProperties": {
+													"type": "string"
+												},
+												"type": "object"
+											},
+											"srIdByVdiId": {
+												"properties": {},
+												"additionalProperties": {
+													"type": "string"
+												},
+												"type": "object"
+											},
+											"srId": {
+												"type": "string"
+											},
+											"migrationNetworkId": {
+												"type": "string"
+											},
+											"hostId": {
+												"type": "string"
+											}
+										},
+										"required": [
+											"hostId"
+										],
+										"type": "object"
+									}
+								]
+							},
+							"example": {
+								"hostId": "b61a5c92-700e-4966-a13b-00633f03eea8"
+							}
+						}
+					}
+				}
+			}
+		},
+		"/vm-templates": {
+			"get": {
+				"operationId": "GetVmTemplates",
 				"responses": {
 					"200": {
 						"description": "Ok",
@@ -18039,6 +18462,74 @@
 						"example": 42
 					}
 				]
+			},
+			"post": {
+				"operationId": "CreateVif",
+				"responses": {
+					"201": {
+						"description": "Resource created",
+						"content": {
+							"application/json": {
+								"schema": {
+									"properties": {
+										"id": {
+											"type": "string"
+										}
+									},
+									"required": [
+										"id"
+									],
+									"type": "object"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"id": "f028c5d4-578a-332c-394e-087aaca32dd3"
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"vifs"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [],
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/CreateVifBody"
+							},
+							"example": {
+								"networkId": "6b6ca0f5-6611-0636-4b0a-1fb1c1e96414",
+								"vmId": "613f541c-4bed-fc77-7ca8-2db6b68f079c"
+							}
+						}
+					}
+				}
 			}
 		},
 		"/vifs/{id}": {
@@ -18107,6 +18598,45 @@
 						"example": "f028c5d4-578a-332c-394e-087aaca32dd3"
 					}
 				]
+			},
+			"delete": {
+				"operationId": "DestroyVif",
+				"responses": {
+					"204": {
+						"description": "No content"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"vifs"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "6b6ca0f5-6611-0636-4b0a-1fb1c1e96414"
+					}
+				]
 			}
 		},
 		"/vifs/{id}/alarms": {
@@ -18573,6 +19103,73 @@
 						"example": 42
 					}
 				]
+			},
+			"post": {
+				"operationId": "CreateVdi",
+				"responses": {
+					"201": {
+						"description": "Resource created",
+						"content": {
+							"application/json": {
+								"schema": {
+									"properties": {
+										"id": {
+											"type": "string"
+										}
+									},
+									"required": [
+										"id"
+									],
+									"type": "object"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"id": "5e13f673-760e-41be-826e-620d16b7f43b"
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"description": "Create an empty VDI on the given SR.",
+				"tags": [
+					"vdis"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [],
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/CreateVdiBody"
+							},
+							"example": {
+								"srId": "c4284e12-37c9-7967-b9e8-83ef229c3e03",
+								"virtual_size": 10737418240,
+								"name_label": "test VDI"
+							}
+						}
+					}
+				}
 			}
 		},
 		"/vdis/{id}": {
@@ -22417,6 +23014,68 @@
 				]
 			}
 		},
+		"/srs/{id}/actions/reclaim_space": {
+			"post": {
+				"operationId": "ReclaimSpaceSr",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CreateActionReturnType_void_"
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"srs"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "b61a5c92-700e-4966-a13b-00633f03eea8"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				]
+			}
+		},
 		"/sms": {
 			"get": {
 				"operationId": "GetSrs",
@@ -28269,6 +28928,144 @@
 				]
 			}
 		},
+		"/pbds/{id}/actions/plug": {
+			"post": {
+				"operationId": "PlugPbd",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CreateActionReturnType_void_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"taskId": "0m7kl0j9l"
+										}
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"pbds"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "b61a5c92-700e-4966-a13b-00633f03eea8"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				]
+			}
+		},
+		"/pbds/{id}/actions/unplug": {
+			"post": {
+				"operationId": "UnplugPbd",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CreateActionReturnType_void_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"taskId": "0m7kl0j9l"
+										}
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"pbds"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "b61a5c92-700e-4966-a13b-00633f03eea8"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				]
+			}
+		},
 		"/networks": {
 			"get": {
 				"operationId": "GetNetworks",