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 StorageProfiles API

Operations for managing StorageProfile resources. StorageProfiles describe the capabilities of a StorageClass and provide default clone and access mode strategies.

KubeVirt StorageProfiles 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 StorageProfiles. 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 3 operations across 2 paths, and defines 3 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}.

3 operations 2 paths 3 schemas 2 GET1 PATCH

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 3

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

StorageProfiles 3

Operations for managing StorageProfile resources. StorageProfiles describe the capabilities of a StorageClass and provide default clone and access mode strategies.

GET
/apis/cdi.kubevirt.io/v1beta1/storageprofiles
KubeVirt List StorageProfiles
listStorageProfiles 2 params → 200401
GET
/apis/cdi.kubevirt.io/v1beta1/storageprofiles/{name}
KubeVirt Get a StorageProfile
readStorageProfile 1 param → 200401404
PATCH
/apis/cdi.kubevirt.io/v1beta1/storageprofiles/{name}
KubeVirt Update a StorageProfile
patchStorageProfile 1 param body → 200401404

Schemas 3

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

ObjectMeta
object
Standard Kubernetes object metadata.
7 properties 1 required
StorageProfileList
object
List of StorageProfile resources.
3 properties
StorageProfile
object
A CDI StorageProfile describing the capabilities and recommended configuration for a specific Kubernetes StorageClass.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubevirt-storageprofiles-api-openapi.yml Raw ↑

Other APIs KubeVirt publishes across the network.

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