POST
/
kvm
/
v2
/
get
/
screenshot
curl --request POST \
  --url https://{api_host}.edisglobal.com/kvm/v2/get/screenshot \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=session_signature_12345 \
  --data kvm_id=kvm_xxxxx_yyyyy \
  --data valid_until=2025-01-12T15:30:00Z
{
  "status": "success",
  "note": "var obj = JSON.parse(serverResponse); img.src=obj.data;"
}

Body

application/x-www-form-urlencoded
Required parameters to fetch a screenshot for the VPS.
​
signature
string

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

Example:

"session_signature_12345"

​
kvm_id
string

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
string

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

Example:

"2025-01-12T15:30:00Z"

Response

200
application/json
Screenshot retrieved successfully.
​
status
string
Example:

"success"

​
data
file

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

​
note
string

Example script to display the image.

Example:

"var obj = JSON.parse(serverResponse); img.src=obj.data;"

Was this page helpful?