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

Operations for managing VirtualMachineInstance (VMI) resources. A VirtualMachineInstance represents a running virtual machine and tracks its actual state.

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

2 operations 2 paths 10 schemas 2 GET

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 2

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

VirtualMachineInstances 2

Operations for managing VirtualMachineInstance (VMI) resources. A VirtualMachineInstance represents a running virtual machine and tracks its actual state.

GET
/apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances
KubeVirt List VirtualMachineInstances
listNamespacedVirtualMachineInstance 4 params → 200401403
GET
/apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}
KubeVirt Get a VirtualMachineInstance
readNamespacedVirtualMachineInstance 2 params → 200401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are VirtualMachineInstanceSpec (10 properties), Volume (9 properties), VirtualMachineInstanceStatus (7 properties), Interface (7 properties). Each schema is shown below with its type and property counts.

ObjectMeta
object
Standard Kubernetes object metadata.
7 properties 1 required
VirtualMachineInstanceSpec
object
Specification of the virtual machine hardware and guest configuration.
10 properties
Interface
object
A virtual network interface device.
7 properties 1 required
VirtualMachineInstance
object
A running VirtualMachineInstance representing the actual state of an active virtual machine process in KubeVirt.
5 properties
VirtualMachineInstanceList
object
List of VirtualMachineInstance resources.
3 properties
Volume
object
A storage volume to attach to a disk device.
9 properties 1 required
Network
object
A network to attach a VM interface to.
3 properties 1 required
VirtualMachineInstanceStatus
object
Observed runtime status of a VirtualMachineInstance.
7 properties
DomainSpec
object
Virtual hardware configuration for the VM guest.
6 properties
Disk
object
A virtual disk device attached to the VM.
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubevirt-virtualmachineinstances-api-openapi.yml Raw ↑

Other APIs KubeVirt publishes across the network.

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