Skip to main content
Version: v1.6

Create a Namespaced Virtual Machine Restore

POST 
/apis/harvesterhci.io/v1beta1/namespaces/:namespace/virtualmachinerestores

Create a VirtualMachineRestore object.

Request​

Path Parameters

    namespace stringrequired

    Possible values: Value must match regular expression [a-z0-9][a-z0-9\-]*

    Object name and auth scope, such as for teams and projects

Bodyrequired

    apiVersionstringrequired
    kindstringrequired
    metadata object
    namestringrequired
    namespacestring
    spec objectrequired
    deletionPolicystring
    keepMacAddressboolean
    newVMboolean
    target objectrequired
    apiGroupstring
    kindstringrequired
    Default value:
    namestringrequired
    Default value:
    virtualMachineBackupNamestringrequired
    Default value:
    virtualMachineBackupNamespacestringrequired
    Default value:
    status object
    completeboolean
    conditions object[]
  • Array [
    • lastTransitionTimestring
    lastUpdateTimestring
    messagestring
    reasonstring
    statusstringrequired
    Default value:
    typestringrequired
    Default value:
  • ]
    • deletedVolumesstring[]
    progressinteger<int32>
    restoreTimek8s.io.v1.Time (string)
    Default value:
    restores object[]
  • Array [
    • longhornEngineNamestring
    persistentVolumeClaimSpec object
    metadata object
    namestringrequired
    namespacestring
    spec object
    accessModesstring[]
    dataSource object
    apiGroupstring
    kindstringrequired
    Default value:
    namestringrequired
    Default value:
    dataSourceRef object
    apiGroupstring
    kindstringrequired
    Default value:
    namestringrequired
    Default value:
    namespacestring
    resources object
    claims object[]
  • Array [
    • namestringrequired
    Default value:
  • ]
    • limits object
    property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
    Default value: {}
    requests object
    property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
    Default value: {}
    selector object
    matchExpressions object[]
  • Array [
    • keystringrequired
    Default value:
    operatorstringrequired
    Default value:
    valuesstring[]
  • ]
    • matchLabels object
    property name*string
    Default value:
    storageClassNamestring
    volumeModestring
    volumeNamestring
    progressinteger<int32>
    volumeBackupNamestring
    volumeNamestring
    volumeSizeinteger<int64>
  • ]
    • targetUIDstring

Responses​

OK

Schema
    apiVersionstringrequired
    kindstringrequired
    metadata object
    namestringrequired
    namespacestring
    spec objectrequired
    deletionPolicystring
    keepMacAddressboolean
    newVMboolean
    target objectrequired
    apiGroupstring
    kindstringrequired
    Default value:
    namestringrequired
    Default value:
    virtualMachineBackupNamestringrequired
    Default value:
    virtualMachineBackupNamespacestringrequired
    Default value:
    status object
    completeboolean
    conditions object[]
  • Array [
    • lastTransitionTimestring
    lastUpdateTimestring
    messagestring
    reasonstring
    statusstringrequired
    Default value:
    typestringrequired
    Default value:
  • ]
    • deletedVolumesstring[]
    progressinteger<int32>
    restoreTimek8s.io.v1.Time (string)
    Default value:
    restores object[]
  • Array [
    • longhornEngineNamestring
    persistentVolumeClaimSpec object
    metadata object
    namestringrequired
    namespacestring
    spec object
    accessModesstring[]
    dataSource object
    apiGroupstring
    kindstringrequired
    Default value:
    namestringrequired
    Default value:
    dataSourceRef object
    apiGroupstring
    kindstringrequired
    Default value:
    namestringrequired
    Default value:
    namespacestring
    resources object
    claims object[]
  • Array [
    • namestringrequired
    Default value:
  • ]
    • limits object
    property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
    Default value: {}
    requests object
    property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
    Default value: {}
    selector object
    matchExpressions object[]
  • Array [
    • keystringrequired
    Default value:
    operatorstringrequired
    Default value:
    valuesstring[]
  • ]
    • matchLabels object
    property name*string
    Default value:
    storageClassNamestring
    volumeModestring
    volumeNamestring
    progressinteger<int32>
    volumeBackupNamestring
    volumeNamestring
    volumeSizeinteger<int64>
  • ]
    • targetUIDstring
curl -L 'https://699c5de8cd2250875530e216--harvester-preview.netlify.app/apis/harvesterhci.io/v1beta1/namespaces/:namespace/virtualmachinerestores' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "name": "string",
    "namespace": "string"
  },
  "spec": {
    "deletionPolicy": "string",
    "keepMacAddress": true,
    "newVM": true,
    "target": {
      "apiGroup": "string",
      "kind": "",
      "name": ""
    },
    "virtualMachineBackupName": "",
    "virtualMachineBackupNamespace": ""
  },
  "status": {
    "complete": true,
    "conditions": [
      {
        "lastTransitionTime": "string",
        "lastUpdateTime": "string",
        "message": "string",
        "reason": "string",
        "status": "",
        "type": ""
      }
    ],
    "deletedVolumes": [
      ""
    ],
    "progress": 0,
    "restoreTime": "",
    "restores": [
      {
        "longhornEngineName": "string",
        "persistentVolumeClaimSpec": {
          "metadata": {
            "name": "string",
            "namespace": "string"
          },
          "spec": {
            "accessModes": [
              ""
            ],
            "dataSource": {
              "apiGroup": "string",
              "kind": "",
              "name": ""
            },
            "dataSourceRef": {
              "apiGroup": "string",
              "kind": "",
              "name": "",
              "namespace": "string"
            },
            "resources": {
              "claims": [
                {
                  "name": ""
                }
              ],
              "limits": {},
              "requests": {}
            },
            "selector": {
              "matchExpressions": [
                {
                  "key": "",
                  "operator": "",
                  "values": [
                    ""
                  ]
                }
              ],
              "matchLabels": {}
            },
            "storageClassName": "string",
            "volumeMode": "string",
            "volumeName": "string"
          }
        },
        "progress": 0,
        "volumeBackupName": "string",
        "volumeName": "string",
        "volumeSize": 0
      }
    ],
    "targetUID": "string"
  }
}'
RequestCollapse all
Parameters
— pathrequired
Body required
{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "name": "string",
    "namespace": "string"
  },
  "spec": {
    "deletionPolicy": "string",
    "keepMacAddress": true,
    "newVM": true,
    "target": {
      "apiGroup": "string",
      "kind": "",
      "name": ""
    },
    "virtualMachineBackupName": "",
    "virtualMachineBackupNamespace": ""
  },
  "status": {
    "complete": true,
    "conditions": [
      {
        "lastTransitionTime": "string",
        "lastUpdateTime": "string",
        "message": "string",
        "reason": "string",
        "status": "",
        "type": ""
      }
    ],
    "deletedVolumes": [
      ""
    ],
    "progress": 0,
    "restoreTime": "",
    "restores": [
      {
        "longhornEngineName": "string",
        "persistentVolumeClaimSpec": {
          "metadata": {
            "name": "string",
            "namespace": "string"
          },
          "spec": {
            "accessModes": [
              ""
            ],
            "dataSource": {
              "apiGroup": "string",
              "kind": "",
              "name": ""
            },
            "dataSourceRef": {
              "apiGroup": "string",
              "kind": "",
              "name": "",
              "namespace": "string"
            },
            "resources": {
              "claims": [
                {
                  "name": ""
                }
              ],
              "limits": {},
              "requests": {}
            },
            "selector": {
              "matchExpressions": [
                {
                  "key": "",
                  "operator": "",
                  "values": [
                    ""
                  ]
                }
              ],
              "matchLabels": {}
            },
            "storageClassName": "string",
            "volumeMode": "string",
            "volumeName": "string"
          }
        },
        "progress": 0,
        "volumeBackupName": "string",
        "volumeName": "string",
        "volumeSize": 0
      }
    ],
    "targetUID": "string"
  }
}