Skip to main content
Version: v1.5

List Namespaced Virtual Machine Backups

GET 

/apis/harvesterhci.io/v1beta1/namespaces/:namespace/virtualmachinebackups

Get a list of VirtualMachineBackup objects in a namespace.

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

Query Parameters

    continue string

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    fieldSelector string

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    includeUninitialized boolean

    If true, partially initialized resources are included in the response.

    labelSelector string

    A selector to restrict the list of returned objects by their labels. Defaults to everything

    limit integer

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    resourceVersion string

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    timeoutSeconds integer

    TimeoutSeconds for the list/watch call.

    watch boolean

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

OK

Schema
    apiVersionstringrequired
    items object[]required
  • Array [
  • apiVersionstringrequired
    kindstringrequired
    metadata object
    namestringrequired
    namespacestring
    spec objectrequired
    source objectrequired
    apiGroupstring
    kindstringrequired
    Default value:
    namestringrequired
    Default value:
    typestring
    status object
    backupTarget object
    bucketNamestring
    bucketRegionstring
    endpointstring
    conditions object[]
  • Array [
  • lastTransitionTimestring
    lastUpdateTimestring
    messagestring
    reasonstring
    statusstringrequired
    Default value:
    typestringrequired
    Default value:
  • ]
  • creationTimek8s.io.v1.Time (string)
    Default value:
    csiDriverVolumeSnapshotClassNames object
    property name*string
    Default value:
    error object
    messagestring
    timek8s.io.v1.Time (string)
    Default value:
    progressinteger<int32>
    readyToUseboolean
    secretBackups object[]
  • Array [
  • data object
    property name*string<byte>
    namestring
  • ]
  • source object
    metadata object
    namestringrequired
    namespacestring
    spec object
    dataVolumeTemplates object[]
  • Array [
  • apiVersionstringrequired
    kindstringrequired
    metadata object
    namestringrequired
    namespacestring
    spec objectrequired
    checkpoints object[]
  • Array [
  • currentstringrequired
    Default value:
    previousstringrequired
    Default value:
  • ]
  • contentTypestring
    finalCheckpointboolean
    preallocationboolean
    priorityClassNamestring
    pvc 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
    source object
    blankobject
    gcs object
    secretRefstring
    urlstringrequired
    Default value:
    http object
    certConfigMapstring
    extraHeadersstring[]
    secretExtraHeadersstring[]
    secretRefstring
    urlstringrequired
    Default value:
    imageio object
    certConfigMapstring
    diskIdstringrequired
    Default value:
    secretRefstring
    urlstringrequired
    Default value:
    pvc object
    namestringrequired
    Default value:
    namespacestringrequired
    Default value:
    registry object
    certConfigMapstring
    imageStreamstring
    pullMethodstring
    secretRefstring
    urlstring
    s3 object
    certConfigMapstring
    secretRefstring
    urlstringrequired
    Default value:
    snapshot object
    namestringrequired
    Default value:
    namespacestringrequired
    Default value:
    uploadobject
    vddk object
    backingFilestring
    initImageURLstring
    secretRefstring
    thumbprintstring
    urlstring
    uuidstring
    sourceRef object
    kindstringrequired
    Default value:
    namestringrequired
    Default value:
    namespacestring
    storage 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
    statusobject
  • ]
  • instancetype object
    inferFromVolumestring
    inferFromVolumeFailurePolicystring
    kindstring
    namestring
    revisionNamestring
    liveUpdateFeatures object
    affinityobject
    cpu object
    maxSocketsinteger<int64>
    memory object
    maxGuestk8s.io.apimachinery.pkg.api.resource.Quantity (string)
    preference object
    inferFromVolumestring
    inferFromVolumeFailurePolicystring
    kindstring
    namestring
    revisionNamestring
    runStrategystring
    runningboolean
    template objectrequired
    metadata object
    namestringrequired
    namespacestring
    spec object
    accessCredentials object[]
  • Array [
  • sshPublicKey object
    propagationMethod objectrequired
    configDriveobject
    noCloudobject
    qemuGuestAgent object
    usersstring[]required
    source objectrequired
    secret object
    secretNamestringrequired
    Default value:
    userPassword object
    propagationMethod objectrequired
    qemuGuestAgentobject
    source objectrequired
    secret object
    secretNamestringrequired
    Default value:
  • ]
  • affinity object
    nodeAffinity object
    preferredDuringSchedulingIgnoredDuringExecution object[]
  • Array [
  • preference objectrequired
    matchExpressions object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    Default value:
    valuesstring[]
  • ]
  • matchFields object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    Default value:
    valuesstring[]
  • ]
  • weightinteger<int32>required
    Default value: 0
  • ]
  • requiredDuringSchedulingIgnoredDuringExecution object
    nodeSelectorTerms object[]required
  • Array [
  • matchExpressions object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    Default value:
    valuesstring[]
  • ]
  • matchFields object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    Default value:
    valuesstring[]
  • ]
  • ]
  • podAffinity object
    preferredDuringSchedulingIgnoredDuringExecution object[]
  • Array [
  • podAffinityTerm objectrequired
    labelSelector object
    matchExpressions object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired
    Default value:
    valuesstring[]
  • ]
  • matchLabels object
    property name*string
    Default value:
    namespaceSelector object
    matchExpressions object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired
    Default value:
    valuesstring[]
  • ]
  • matchLabels object
    property name*string
    Default value:
    namespacesstring[]
    topologyKeystringrequired
    Default value:
    weightinteger<int32>required
    Default value: 0
  • ]
  • requiredDuringSchedulingIgnoredDuringExecution object[]
  • Array [
  • labelSelector object
    matchExpressions object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired
    Default value:
    valuesstring[]
  • ]
  • matchLabels object
    property name*string
    Default value:
    namespaceSelector object
    matchExpressions object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired
    Default value:
    valuesstring[]
  • ]
  • matchLabels object
    property name*string
    Default value:
    namespacesstring[]
    topologyKeystringrequired
    Default value:
  • ]
  • podAntiAffinity object
    preferredDuringSchedulingIgnoredDuringExecution object[]
  • Array [
  • podAffinityTerm objectrequired
    labelSelector object
    matchExpressions object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired
    Default value:
    valuesstring[]
  • ]
  • matchLabels object
    property name*string
    Default value:
    namespaceSelector object
    matchExpressions object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired
    Default value:
    valuesstring[]
  • ]
  • matchLabels object
    property name*string
    Default value:
    namespacesstring[]
    topologyKeystringrequired
    Default value:
    weightinteger<int32>required
    Default value: 0
  • ]
  • requiredDuringSchedulingIgnoredDuringExecution object[]
  • Array [
  • labelSelector object
    matchExpressions object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired
    Default value:
    valuesstring[]
  • ]
  • matchLabels object
    property name*string
    Default value:
    namespaceSelector object
    matchExpressions object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired
    Default value:
    valuesstring[]
  • ]
  • matchLabels object
    property name*string
    Default value:
    namespacesstring[]
    topologyKeystringrequired
    Default value:
  • ]
  • architecturestring
    dnsConfig object
    nameserversstring[]
    options object[]
  • Array [
  • namestring
    valuestring
  • ]
  • searchesstring[]
    dnsPolicystring

    Possible values: [ClusterFirst, ClusterFirstWithHostNet, Default, None]

    domain objectrequired
    chassis object
    assetstring
    manufacturerstring
    serialstring
    skustring
    versionstring
    clock object
    timer object
    hpet object
    presentboolean
    tickPolicystring
    hyperv object
    presentboolean
    kvm object
    presentboolean
    pit object
    presentboolean
    tickPolicystring
    rtc object
    presentboolean
    tickPolicystring
    trackstring
    timezonestring
    utc object
    offsetSecondsinteger<int32>
    cpu object
    coresinteger<int64>
    dedicatedCpuPlacementboolean
    features object[]
  • Array [
  • namestringrequired
    Default value:
    policystring
  • ]
  • isolateEmulatorThreadboolean
    maxSocketsinteger<int64>
    modelstring
    numa object
    guestMappingPassthroughobject
    realtime object
    maskstring
    socketsinteger<int64>
    threadsinteger<int64>
    devices objectrequired
    autoattachGraphicsDeviceboolean
    autoattachInputDeviceboolean
    autoattachMemBalloonboolean
    autoattachPodInterfaceboolean
    autoattachSerialConsoleboolean
    autoattachVSOCKboolean
    blockMultiQueueboolean
    clientPassthroughobject
    disableHotplugboolean
    disks object[]
  • Array [
  • blockSize object
    custom object
    logicalinteger<int32>required
    Default value: 0
    physicalinteger<int32>required
    Default value: 0
    matchVolume object
    enabledboolean
    bootOrderinteger<int32>
    cachestring
    cdrom object
    busstring
    readonlyboolean
    traystring
    dedicatedIOThreadboolean
    disk object
    busstring
    pciAddressstring
    readonlyboolean
    errorPolicystring
    iostring
    lun object
    busstring
    readonlyboolean
    reservationboolean
    namestringrequired
    Default value:
    serialstring
    shareableboolean
    tagstring
  • ]
  • downwardMetricsobject
    filesystems object[]
  • Array [
  • namestringrequired
    Default value:
    virtiofsobjectrequired
  • ]
  • gpus object[]
  • Array [
  • deviceNamestringrequired
    Default value:
    namestringrequired
    Default value:
    tagstring
    virtualGPUOptions object
    display object
    enabledboolean
    ramFB object
    enabledboolean
  • ]
  • hostDevices object[]
  • Array [
  • deviceNamestringrequired
    Default value:
    namestringrequired
    Default value:
    tagstring
  • ]
  • inputs object[]
  • Array [
  • busstring
    namestringrequired
    Default value:
    typestringrequired
    Default value:
  • ]
  • interfaces object[]
  • Array [
  • acpiIndexinteger<int32>
    binding object
    namestringrequired
    Default value:
    bootOrderinteger<int32>
    bridgeobject
    dhcpOptions object
    bootFileNamestring
    ntpServersstring[]
    privateOptions object[]
  • Array [
  • optioninteger<int32>required
    Default value: 0
    valuestringrequired
    Default value:
  • ]
  • tftpServerNamestring
    macAddressstring
    macvtapobject
    masqueradeobject
    modelstring
    namestringrequired
    Default value:
    passtobject
    pciAddressstring
    ports object[]
  • Array [
  • namestring
    portinteger<int32>required
    Default value: 0
    protocolstring
  • ]
  • slirpobject
    sriovobject
    statestring
    tagstring
  • ]
  • logSerialConsoleboolean
    networkInterfaceMultiqueueboolean
    rngobject
    sound object
    modelstring
    namestringrequired
    Default value:
    tpm object
    persistentboolean
    useVirtioTransitionalboolean
    watchdog object
    i6300esb object
    actionstring
    namestringrequired
    Default value:
    features object
    acpi object
    enabledboolean
    apic object
    enabledboolean
    endOfInterruptboolean
    hyperv object
    evmcs object
    enabledboolean
    frequencies object
    enabledboolean
    ipi object
    enabledboolean
    reenlightenment object
    enabledboolean
    relaxed object
    enabledboolean
    reset object
    enabledboolean
    runtime object
    enabledboolean
    spinlocks object
    enabledboolean
    spinlocksinteger<int64>
    synic object
    enabledboolean
    synictimer object
    direct object
    enabledboolean
    enabledboolean
    tlbflush object
    enabledboolean
    vapic object
    enabledboolean
    vendorid object
    enabledboolean
    vendoridstring
    vpindex object
    enabledboolean
    kvm object
    hiddenboolean
    pvspinlock object
    enabledboolean
    smm object
    enabledboolean
    firmware object
    bootloader object
    bios object
    useSerialboolean
    efi object
    persistentboolean
    secureBootboolean
    kernelBoot object
    container object
    imagestringrequired
    Default value:
    imagePullPolicystring

    Possible values: [Always, IfNotPresent, Never]

    imagePullSecretstring
    initrdPathstring
    kernelPathstring
    kernelArgsstring
    serialstring
    uuidstring
    ioThreadsPolicystring
    launchSecurity object
    sev object
    attestationobject
    dhCertstring
    policy object
    encryptedStateboolean
    sessionstring
    machine object
    typestring
    Default value:
    memory object
    guestk8s.io.apimachinery.pkg.api.resource.Quantity (string)
    hugepages object
    pageSizestring
    maxGuestk8s.io.apimachinery.pkg.api.resource.Quantity (string)
    resources object
    limits object
    property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
    Default value: {}
    overcommitGuestOverheadboolean
    requests object
    property name*k8s.io.apimachinery.pkg.api.resource.Quantity (string)
    Default value: {}
    evictionStrategystring
    hostnamestring
    livenessProbe object
    exec object
    commandstring[]
    failureThresholdinteger<int32>
    guestAgentPingobject
    httpGet object
    hoststring
    httpHeaders object[]
  • Array [
  • namestringrequired
    Default value:
    valuestringrequired
    Default value:
  • ]
  • pathstring
    portstring<int-or-string>required
    Default value: {}
    schemestring

    Possible values: [HTTP, HTTPS]

    initialDelaySecondsinteger<int32>
    periodSecondsinteger<int32>
    successThresholdinteger<int32>
    tcpSocket object
    hoststring
    portstring<int-or-string>required
    Default value: {}
    timeoutSecondsinteger<int32>
    networks object[]
  • Array [
  • multus object
    defaultboolean
    networkNamestringrequired
    Default value:
    namestringrequired
    Default value:
    pod object
    vmIPv6NetworkCIDRstring
    vmNetworkCIDRstring
  • ]
  • nodeSelector object
    property name*string
    Default value:
    priorityClassNamestring
    readinessProbe object
    exec object
    commandstring[]
    failureThresholdinteger<int32>
    guestAgentPingobject
    httpGet object
    hoststring
    httpHeaders object[]
  • Array [
  • namestringrequired
    Default value:
    valuestringrequired
    Default value:
  • ]
  • pathstring
    portstring<int-or-string>required
    Default value: {}
    schemestring

    Possible values: [HTTP, HTTPS]

    initialDelaySecondsinteger<int32>
    periodSecondsinteger<int32>
    successThresholdinteger<int32>
    tcpSocket object
    hoststring
    portstring<int-or-string>required
    Default value: {}
    timeoutSecondsinteger<int32>
    schedulerNamestring
    startStrategystring
    subdomainstring
    terminationGracePeriodSecondsinteger<int64>
    tolerations object[]
  • Array [
  • effectstring

    Possible values: [NoExecute, NoSchedule, PreferNoSchedule]

    keystring
    operatorstring

    Possible values: [Equal, Exists]

    tolerationSecondsinteger<int64>
    valuestring
  • ]
  • topologySpreadConstraints object[]
  • Array [
  • labelSelector object
    matchExpressions object[]
  • Array [
  • keystringrequired
    Default value:
    operatorstringrequired
    Default value:
    valuesstring[]
  • ]
  • matchLabels object
    property name*string
    Default value:
    matchLabelKeysstring[]
    maxSkewinteger<int32>required
    Default value: 0
    minDomainsinteger<int32>
    nodeAffinityPolicystring
    nodeTaintsPolicystring
    topologyKeystringrequired
    Default value:
    whenUnsatisfiablestringrequired

    Possible values: [DoNotSchedule, ScheduleAnyway]

    Default value:
  • ]
  • volumes object[]
  • Array [
  • cloudInitConfigDrive object
    networkDatastring
    networkDataBase64string
    networkDataSecretRef object
    namestring
    secretRef object
    namestring
    userDatastring
    userDataBase64string
    cloudInitNoCloud object
    networkDatastring
    networkDataBase64string
    networkDataSecretRef object
    namestring
    secretRef object
    namestring
    userDatastring
    userDataBase64string
    configMap object
    namestring
    optionalboolean
    volumeLabelstring
    containerDisk object
    imagestringrequired
    Default value:
    imagePullPolicystring

    Possible values: [Always, IfNotPresent, Never]

    imagePullSecretstring
    pathstring
    dataVolume object
    hotpluggableboolean
    namestringrequired
    Default value:
    downwardAPI object
    fields object[]
  • Array [
  • fieldRef object
    apiVersionstring
    fieldPathstringrequired
    Default value:
    modeinteger<int32>
    pathstringrequired
    Default value:
    resourceFieldRef object
    containerNamestring
    divisork8s.io.apimachinery.pkg.api.resource.Quantity (string)
    Default value: {}
    resourcestringrequired
    Default value:
  • ]
  • volumeLabelstring
    downwardMetricsobject
    emptyDisk object
    capacityk8s.io.apimachinery.pkg.api.resource.Quantity (string)required
    Default value: {}
    ephemeral object
    persistentVolumeClaim object
    claimNamestringrequired
    Default value:
    readOnlyboolean
    hostDisk object
    capacityk8s.io.apimachinery.pkg.api.resource.Quantity (string)
    Default value: {}
    pathstringrequired
    Default value:
    sharedboolean
    typestringrequired
    Default value:
    memoryDump object
    claimNamestringrequired
    Default value:
    hotpluggableboolean
    readOnlyboolean
    namestringrequired
    Default value:
    persistentVolumeClaim object
    claimNamestringrequired
    Default value:
    hotpluggableboolean
    readOnlyboolean
    secret object
    optionalboolean
    secretNamestring
    volumeLabelstring
    serviceAccount object
    serviceAccountNamestring
    sysprep object
    configMap object
    namestring
    secret object
    namestring
  • ]
  • sourceUIDstring
    volumeBackups object[]
  • Array [
  • creationTimek8s.io.v1.Time (string)
    Default value:
    csiDriverNamestringrequired
    Default value:
    error object
    messagestring
    timek8s.io.v1.Time (string)
    Default value:
    longhornBackupNamestring
    namestring
    persistentVolumeClaim objectrequired
    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>
    readyToUseboolean
    volumeNamestringrequired
    Default value:
    volumeSizeinteger<int64>
  • ]
  • ]
  • kindstringrequired
    metadata objectrequired
    continuestring
    remainingItemCountinteger<int64>
    resourceVersionstring
    selfLinkstring
curl -L 'https://699c5de8cd2250875530e216--harvester-preview.netlify.app/apis/harvesterhci.io/v1beta1/namespaces/:namespace/virtualmachinebackups' \
-H 'Accept: application/json'
RequestCollapse all
Parameters
— pathrequired
— query
— query
— query
— query
— query
— query
— query
— query