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

> This endpoint retrieves a current screenshot of the 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 obtained  
from the same response to retrieve the screenshot.




## OpenAPI

````yaml post /kvm/v2/get/screenshot
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/screenshot:
    post:
      tags:
        - Collect Information
      summary: Get VPS Screenshot
      description: >
        This endpoint retrieves a current screenshot of the 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
        obtained  

        from the same response to retrieve the screenshot.
      operationId: getVpsScreenshot
      requestBody:
        description: Required parameters to fetch a screenshot for the VPS.
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/get_screenshot_body'
        required: true
      responses:
        '200':
          description: Screenshot retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_9'
        '400':
          description: Bad Request - Invalid parameters or missing fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400_7'
        '401':
          description: Unauthorized - The session signature is invalid or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401_7'
        '403':
          description: >-
            Forbidden - The client does not have permission to access this
            resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403_6'
        '500':
          description: Internal Server Error - An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_500_7'
components:
  schemas:
    get_screenshot_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 retrieve the screenshot
            from.  

            This value is specific to your VPS.
          example: kvm_xxxxx_yyyyy
        valid_until:
          type: string
          description: >
            The expiration timestamp for the session, obtained from the
            **"Create AUTH-session"** call.  

            Ensure that the session is valid and has not expired.
          example: '1737476000'
    inline_response_200_9:
      type: object
      properties:
        status:
          type: string
          example: success
        data:
          type: string
          description: |
            The screenshot image encoded in Base64 format.  
            Use the following example to display it in an `img` tag.
          format: binary
          example: data:image/jpg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...
        note:
          type: string
          description: Example script to display the image.
          example: var obj = JSON.parse(serverResponse); img.src=obj.data;
    inline_response_400_7:
      type: object
      properties:
        status:
          type: string
          example: error
        message:
          type: string
          example: Invalid parameters provided.
    inline_response_401_7:
      type: object
      properties:
        status:
          type: string
          example: error
        message:
          type: string
          example: Unauthorized request.
    inline_response_403_6:
      type: object
      properties:
        status:
          type: string
          example: error
        message:
          type: string
          example: Access forbidden.
    inline_response_500_7:
      type: object
      properties:
        status:
          type: string
          example: error
        message:
          type: string
          example: Internal server error.

````