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

Subresource endpoints for accessing VM consoles via VNC, serial console, and USB redirection.

KubeVirt VMConsole 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 VMConsole. 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. 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 0 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.

VMConsole 2

Subresource endpoints for accessing VM consoles via VNC, serial console, and USB redirection.

GET
/apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/vnc
KubeVirt Access VM VNC console
getVirtualMachineInstanceVNC 2 params → 101401404
GET
/apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/console
KubeVirt Access VM serial console
getVirtualMachineInstanceConsole 2 params → 101401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubevirt-vmconsole-api-openapi.yml Raw ↑

Other APIs KubeVirt publishes across the network.

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