> ## 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.

# VNC Status

> This endpoint retrieves the current status of the VNC session 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`, and `valid_until` parameters to get the VNC session status.




## OpenAPI

````yaml post /kvm/v2/get/vnc/status
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/get/vnc/status:
    post:
      tags:
        - VNC Management
      summary: Get VNC status
      description: >
        This endpoint retrieves the current status of the VNC session 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`, and `valid_until` parameters to get
        the VNC session status.
      operationId: getVncStatus
      requestBody:
        description: >
          Required parameters to retrieve the VNC session status.  

          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_status_body'
        required: true
      responses:
        '200':
          description: VNC status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_16'
        '400':
          description: Bad Request - Invalid or missing parameters in the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400_12'
        '401':
          description: Unauthorized - Invalid or expired session signature provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401_11'
        '403':
          description: Forbidden - Access to the requested resource is denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403_10'
        '500':
          description: Internal Server Error - An unexpected issue occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_500_11'
components:
  schemas:
    vnc_status_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 check the VNC status.  
            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'
    inline_response_200_16:
      type: object
      properties:
        status:
          type: string
          description: The status of the operation.
          example: success
        vnc_status:
          type: string
          description: The current VNC status (e.g., enabled, disabled).
          example: enabled
        novnc_port:
          type: integer
          description: The noVNC port for web-based access.
          example: 6080
        vnc_port:
          type: string
          description: The port used for VNC connections.
          example: '5901'
        vnc_host:
          type: string
          description: The VNC host address.
          example: example.edis.at
    inline_response_400_12:
      type: object
      properties:
        status:
          type: string
          description: Status of the request.
          example: error
        error:
          type: string
          description: >-
            Detailed error message indicating what parameters are missing or
            invalid.
          example: 'Missing required field: kvm_id'
    inline_response_401_11:
      type: object
      properties:
        status:
          type: string
          description: Status of the request.
          example: error
        error:
          type: string
          description: Explanation for the unauthorized access attempt.
          example: Session signature has expired
    inline_response_403_10:
      type: object
      properties:
        status:
          type: string
          description: Status of the request.
          example: error
        error:
          type: string
          description: Explanation why access is forbidden.
          example: You do not have permission to perform this operation
    inline_response_500_11:
      type: object
      properties:
        status:
          type: string
          description: Status of the request.
          example: error
        error:
          type: string
          description: Generic server-side error message.
          example: An unexpected error occurred, please try again later

````