> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vexelia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# VNC

<Card title="VNC clients and VMs only!" icon="terminal" horizontal>
  This endpoint is exclusively for VNC clients and is compatible only with nodes
  that are virtual machines - not dedicated hardware, providing remote display
  and control access for VMs.
</Card>


## OpenAPI

````yaml GET /vnc
openapi: 3.0.1
info:
  title: Vexelia API
  description: >-
    The base Vexelia API for interfacing with the Vexelia platform through a
    REST interface.
  termsOfService: https://vexelia.com/terms
  contact:
    name: Support
    url: https://help.vexelia.com
    email: support@vexelia.com
  version: v0.0.1
servers:
  - url: https://api.vexelia.com
    description: The production Vexelia API
security:
  - bearer: []
tags:
  - name: Backup
    description: Controller that handles backing up and restoring VMs
  - name: HostNode
    description: Controller that handles getting and updating host nodes
  - name: Network
    description: Controller that handles network management for the platform
  - name: Node
    description: Handles the management of VPS servers and dedicated servers (nodes)
  - name: Payment
    description: Handles all payment-related systems and webhooks
  - name: Plan
    description: Controller that handles managing pricing plans
  - name: Template
    description: Manages templates for Proxmox
  - name: User
    description: >-
      Handles all user-related functions such as creating and authenticating
      users
  - name: Vnc
    description: Handles proxying VNC websockets to client safely
paths:
  /vnc:
    get:
      tags:
        - Vnc
      summary: Proxies a Proxmox VNC websocket
      parameters:
        - name: hostNodeId
          in: query
          description: The ID of the host node to connect to
          schema:
            type: string
            format: uuid
        - name: vmId
          in: query
          description: The ID of the VM to proxy
          schema:
            type: integer
            format: int32
        - name: ticket
          in: query
          description: The ticket to pass down
          schema:
            type: string
        - name: port
          in: query
          description: The port to use
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: OK
components:
  securitySchemes:
    bearer:
      type: http
      description: Your API key goes here, you can generate one in your account settings.
      scheme: bearer
      bearerFormat: JWT

````