KubeVirt

KubeVirt VMConsole API

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

GitHub OpenAPI

Documentation

📖
Documentation
https://kubevirt.io/user-guide/
📖
Documentation
https://kubevirt.io/user-guide/storage/containerized_data_importer/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/kubevirt/refs/heads/main/openapi/kubevirt-vmconsole-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/kubevirt/containerized-data-importer

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/kubevirt/refs/heads/main/json-schema/kubevirt-vm-schema.json

Other Resources

🔗
Reference
https://kubevirt.io/api-reference/
🔗
Reference
https://kubevirt.io/cdi-api-reference/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/kubevirt-vmconsole-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kubevirt-vmconsole-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: KubeVirt Containerized Data Importer DataSources VMConsole API
  description: The KubeVirt Containerized Data Importer (CDI) API provides Kubernetes CRD endpoints for managing virtual machine disk image import and cloning pipelines. CDI introduces DataVolume, DataSource, and StorageProfile resources that automate importing VM disk images from HTTP, S3, OCI registries, and other sources into PersistentVolumeClaims ready for use as KubeVirt VM disks.
  version: 1.59.0
  contact:
    name: KubeVirt Community
    url: https://kubevirt.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://{kubernetes-api-server}
  description: Kubernetes API server
  variables:
    kubernetes-api-server:
      default: localhost:6443
      description: Address of the Kubernetes API server
tags:
- name: VMConsole
  description: Subresource endpoints for accessing VM consoles via VNC, serial console, and USB redirection.
paths:
  /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/vnc:
    get:
      operationId: getVirtualMachineInstanceVNC
      summary: KubeVirt Access VM VNC console
      description: Opens a WebSocket connection to the VNC console of the specified VirtualMachineInstance for graphical console access.
      tags:
      - VMConsole
      parameters:
      - $ref: '#/components/parameters/namespace'
      - $ref: '#/components/parameters/name'
      responses:
        '101':
          description: WebSocket connection established for VNC access
        '401':
          description: Unauthorized
        '404':
          description: VirtualMachineInstance not found
  /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/console:
    get:
      operationId: getVirtualMachineInstanceConsole
      summary: KubeVirt Access VM serial console
      description: Opens a WebSocket connection to the serial console of the specified VirtualMachineInstance for text-based console access.
      tags:
      - VMConsole
      parameters:
      - $ref: '#/components/parameters/namespace'
      - $ref: '#/components/parameters/name'
      responses:
        '101':
          description: WebSocket connection established for serial console access
        '401':
          description: Unauthorized
        '404':
          description: VirtualMachineInstance not found
components:
  parameters:
    namespace:
      name: namespace
      in: path
      required: true
      description: The Kubernetes namespace of the resource.
      schema:
        type: string
    name:
      name: name
      in: path
      required: true
      description: The name of the resource.
      schema:
        type: string
externalDocs:
  description: CDI Documentation
  url: https://kubevirt.io/user-guide/storage/containerized_data_importer/