Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

KubeVirt DataVolumes API

Operations for managing DataVolume resources. A DataVolume is a managed PersistentVolumeClaim with an integrated import/clone pipeline that automatically populates the volume from a specified source.

KubeVirt DataVolumes API is one of 8 APIs that KubeVirt publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include DataVolumes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a GitHub repository, and 1 JSON Schema.

This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.59.0.

Requests are made against a single base URL, https://{kubernetes-api-server}.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.59.0
Server
https://{kubernetes-api-server}
License
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

DataVolumes 5

Operations for managing DataVolume resources. A DataVolume is a managed PersistentVolumeClaim with an integrated import/clone pipeline that automatically populates the volume from…

GET
/apis/cdi.kubevirt.io/v1beta1/namespaces/{namespace}/datavolumes
KubeVirt List DataVolumes in a namespace
listNamespacedDataVolume 5 params → 200401403
POST
/apis/cdi.kubevirt.io/v1beta1/namespaces/{namespace}/datavolumes
KubeVirt Create a DataVolume
createNamespacedDataVolume 1 param body → 201400401403409
GET
/apis/cdi.kubevirt.io/v1beta1/namespaces/{namespace}/datavolumes/{name}
KubeVirt Get a DataVolume
readNamespacedDataVolume 2 params → 200401404
PUT
/apis/cdi.kubevirt.io/v1beta1/namespaces/{namespace}/datavolumes/{name}
KubeVirt Replace a DataVolume
replaceNamespacedDataVolume 2 params body → 200400401404
DELETE
/apis/cdi.kubevirt.io/v1beta1/namespaces/{namespace}/datavolumes/{name}
KubeVirt Delete a DataVolume
deleteNamespacedDataVolume 2 params → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are DataVolumeSource (9 properties), DataVolumeSpec (9 properties), ObjectMeta (7 properties), DataVolumeStatus (5 properties). Each schema is shown below with its type and property counts.

DataVolume
object
A CDI DataVolume providing a managed PVC with automated import or clone pipeline. Integrates with KubeVirt to provision VM disk images from various sources.
5 properties 4 required
ObjectMeta
object
Standard Kubernetes object metadata.
7 properties 1 required
DataVolumeSpec
object
Specification of a DataVolume.
9 properties
DataVolumeStatus
object
Observed status of a DataVolume import pipeline.
5 properties
DataVolumeSource
object
Source configuration for the DataVolume import. Exactly one source type should be specified.
9 properties
DataVolumeList
object
List of DataVolume resources.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubevirt-datavolumes-api-openapi.yml Raw ↑

Other APIs KubeVirt publishes across the network.

KubeVirt DataSources API
KubeVirt StorageProfiles API
KubeVirt VirtualMachineInstanceMigrations API
KubeVirt VirtualMachineInstances API
KubeVirt VirtualMachines API
KubeVirt VMConsole API
KubeVirt VMLifecycle API