# KubeVirt VMConsole API

**Canonical:** https://apis.io/apis/kubevirt/kubevirt-vmconsole-api/  
**Provider:** KubeVirt — https://apis.io/providers/kubevirt/  
**Documentation:** https://kubevirt.io/user-guide/

KubeVirt VMConsole API is one of 8 APIs that [KubeVirt](https://apis.io/providers/kubevirt/) publishes on the [APIs.io](https://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.

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

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/kubevirt/refs/heads/main/openapi/kubevirt-vmconsole-api-openapi.yml
- **Documentation** — https://kubevirt.io/user-guide/
- **Reference** — https://kubevirt.io/api-reference/
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/kubevirt/refs/heads/main/json-schema/kubevirt-vm-schema.json
- **Documentation** — https://kubevirt.io/user-guide/storage/containerized_data_importer/
- **Reference** — https://kubevirt.io/cdi-api-reference/
- **GitHubRepository** — https://github.com/kubevirt/containerized-data-importer

## Other KubeVirt APIs (7)

- [KubeVirt DataSources API](https://apis.io/apis/kubevirt/kubevirt-datasources-api/)
- [KubeVirt DataVolumes API](https://apis.io/apis/kubevirt/kubevirt-datavolumes-api/)
- [KubeVirt StorageProfiles API](https://apis.io/apis/kubevirt/kubevirt-storageprofiles-api/)
- [KubeVirt VirtualMachineInstanceMigrations API](https://apis.io/apis/kubevirt/kubevirt-virtualmachineinstancemigrations-api/)
- [KubeVirt VirtualMachineInstances API](https://apis.io/apis/kubevirt/kubevirt-virtualmachineinstances-api/)
- [KubeVirt VirtualMachines API](https://apis.io/apis/kubevirt/kubevirt-virtualmachines-api/)
- [KubeVirt VMLifecycle API](https://apis.io/apis/kubevirt/kubevirt-vmlifecycle-api/)

## Tags

VMConsole

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/kubevirt/kubevirt-vmconsole-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/kubevirt/.