Collect Information

Get VPS 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.

post/kvm/v2/get/screenshot

Request

Request body application/x-www-form-urlencoded

signaturestring

The session signature obtained from the "Create AUTH-session" call.

kvm_idstring

The unique identifier of the KVM VPS to retrieve the screenshot from.
This value is specific to your VPS.

valid_untilstring

The expiration timestamp for the session, obtained from the "Create AUTH-session" call.
Ensure that the session is valid and has not expired.

Example request

{
  "signature": "session_signature_12345",
  "kvm_id": "kvm_xxxxx_yyyyy",
  "valid_until": "1737476000"
}

Response

Screenshot retrieved successfully.

statusstring
datastring binary

The screenshot image encoded in Base64 format.
Use the following example to display it in an img tag.

notestring

Example script to display the image.

Example response

{
  "status": "success",
  "data": "data:image/jpg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...",
  "note": "var obj = JSON.parse(serverResponse); img.src=obj.data;"
}

Changes

No recorded changes to this operation across all 1 revision of this API.