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

# Enable VNC

> This endpoint enables VNC access for a specified KVM VPS.  
The `api_host` parameter, obtained from the **"Create AUTH-session"** response,  
is dynamically set in the URL.  
Provide the `signature`, `kvm_id`, `valid_until`, and `vnc_pw` parameters to activate VNC.




## OpenAPI

````yaml post /kvm/v2/set/vnc/enable
openapi: 3.0.0
info:
  title: EDIS Global Management API
  description: >
    Use the API to access and manage your VPS services, including power control,
    rDNS, and VNC management.  

    **Authentication:** Enable API access on any KVM VPS you own. Then use the
    provided credentials to authenticate your requests.
  version: 1.0.0
servers:
  - url: https://{api_host}
    description: Dynamic API host returned from the AUTH session endpoint.
    variables:
      api_host:
        default: api_host.edisglobal.com
        description: >-
          Enter the full API host exactly as returned by /kvm/v2/get/auth (for
          example: 12345.edisglobal.com)
security: []
tags:
  - name: Authentication
    description: Create an AUTH Session
  - name: Power Management
    description: KVM Power Management
  - name: Installation
    description: ISO, Turnkey, Reinstall
  - name: Settings
    description: KVM System Settings
  - name: Collect Information
    description: KVM VPS Details.
  - name: VNC Management
    description: KVM VNC Access
  - name: PTR
    description: KVM Reverse DNS
  - name: Traffic Pool
    description: Traffic Pool Management
  - name: Hooks
    description: KVM Webhook Management
paths:
  /kvm/v2/set/vnc/enable:
    post:
      tags:
        - VNC Management
      summary: Enable VNC access
      description: >
        This endpoint enables VNC access for a specified KVM VPS.  

        The `api_host` parameter, obtained from the **"Create AUTH-session"**
        response,  

        is dynamically set in the URL.  

        Provide the `signature`, `kvm_id`, `valid_until`, and `vnc_pw`
        parameters to activate VNC.
      operationId: enableVnc
      requestBody:
        description: >
          Required parameters to enable VNC access.  

          All parameters must be passed in the request body as
          `application/x-www-form-urlencoded`.
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/vnc_enable_body'
        required: true
      responses:
        '200':
          description: VNC access enabled successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_17'
        '400':
          description: >-
            Bad Request - The request contains invalid parameters or required
            fields are missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400_13'
        '401':
          description: >-
            Unauthorized - The provided session signature is invalid or has
            expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401_12'
        '403':
          description: >-
            Forbidden - The client does not have the required permissions to
            access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403_11'
        '500':
          description: >-
            Internal Server Error - An unexpected error occurred on the server
            side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_500_12'
components:
  schemas:
    vnc_enable_body:
      type: object
      properties:
        signature:
          type: string
          description: The session signature obtained from the "Create AUTH-session" call.
          example: session_signature_12345
        kvm_id:
          type: string
          description: |
            The unique identifier of the KVM VPS to enable VNC access for.  
            This value is specific to your VPS.
          example: kvm_123456_789012
        valid_until:
          type: string
          description: >
            The expiration timestamp for the session, as obtained from the
            "Create AUTH-session" call.  

            Ensure that the session is valid and has not expired.
          example: '1737476000'
        vnc_pw:
          type: string
          description: |-
            The password to set for the VNC connection.  
            This password will be required to access the VNC session.

            VNC password requirements:
            - Exactly 8 characters long.
            - Only letters (A-Z, a-z) and numbers (0-9).
            - No symbols allowed.
          example: securepassword123
    inline_response_200_17:
      type: object
      properties:
        status:
          type: string
          description: The status of the operation.
          example: success
        vnc_status:
          type: string
          description: The new VNC status.
          example: enabled
        novnc_port:
          type: integer
          description: The noVNC web-based access port.
          example: 6080
        vnc_port:
          type: integer
          description: The VNC port for client connections.
          example: 5901
        vnc_host:
          type: string
          description: The VNC server host address.
          example: example.edis.at
    inline_response_400_13:
      type: object
      properties:
        status:
          type: string
          description: Indicates the failure status.
          example: error
        error_code:
          type: string
          description: A code representing the specific error type.
          example: INVALID_PARAMETERS
        message:
          type: string
          description: Detailed explanation of the error.
          example: The 'kvm_id' field is required.
    inline_response_401_12:
      type: object
      properties:
        status:
          type: string
          description: Indicates the failure status.
          example: error
        error_code:
          type: string
          description: A code representing the authentication error.
          example: UNAUTHORIZED
        message:
          type: string
          description: Explanation of the authentication failure.
          example: Invalid session signature. Please log in again.
    inline_response_403_11:
      type: object
      properties:
        status:
          type: string
          description: Indicates the failure status.
          example: error
        error_code:
          type: string
          description: A code representing the authorization failure.
          example: ACCESS_DENIED
        message:
          type: string
          description: Explanation of the permission issue.
          example: You do not have permission to perform this action.
    inline_response_500_12:
      type: object
      properties:
        status:
          type: string
          description: Indicates the failure status.
          example: error
        error_code:
          type: string
          description: A code representing the server error.
          example: INTERNAL_ERROR
        message:
          type: string
          description: Explanation of the server-side error.
          example: An unexpected error occurred. Please try again later.

````