v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-171,1822,9897.4 MB

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

get/#Action=GetConsoleScreenshot

Query parameters

DryRunboolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

InstanceIdstring required

The ID of the instance.

WakeUpboolean

When set to <code>true</code>, acts as keystroke input and wakes up an instance that's in standby or "sleep" mode.

Action'GetConsoleScreenshot' required
Version'2016-11-15' required

Response

Success