AWaws-samples
Virtual Desktops

Stop virtual desktop

Changed on

Stop or hibernate a DCV virtual desktop session, automatically detecting hibernation capability

put/api/dcv/virtual_desktops/stop

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Headers

X-EDH-USERstring required
Example:john.doe

SOCA username for authentication

X-EDH-TOKENstring required
Example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

SOCA authentication token

Request body application/x-www-form-urlencoded

session_uuidstring uuid required

UUID of the virtual desktop session to stop

Example request

{
  "session_uuid": "12345678-1234-1234-1234-123456789012"
}

Response

Desktop stop/hibernate initiated successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Your desktop will be stopped soon."
}

Changes

  • v1058396b8f0f1Revision changes
    • info

      the endpoint scheme security socaAuth AND socaToken was added to the API

    • info

      the endpoint scheme security edhAuth AND edhToken was removed from the API

  • v16db97cead8dfRevision changes
    • info

      the endpoint scheme security edhAuth AND edhToken was added to the API

    • info

      the endpoint scheme security socaAuth AND socaToken was removed from the API