---
title: "Stop virtual desktop"
method: PUT
path: "/api/dcv/virtual_desktops/stop"
tags: ["Virtual Desktops"]
---

# Stop virtual desktop

`PUT /api/dcv/virtual_desktops/stop`

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

## Headers

- `X-EDH-USER` string, required
- `X-EDH-TOKEN` string, required

## Response `200`

Desktop stop/hibernate initiated successfully

- object
  - `success` boolean
  - `message` string

## Other responses

- `400` — Missing required parameter
- `401` — Session not found or already stopped
- `500` — Failed to stop desktop

## Changes

> 6 revisions in range; 3 could not be searched.

- **2026-04-21** (v1) `6db97cead8df` — 2 info
  - the endpoint scheme security `edhAuth AND edhToken` was added to the API
  - the endpoint scheme security `socaAuth AND socaToken` was removed from the API
- **2025-08-05** (v1) `55c07c16d2e1` — 2 breaking, 2 warning, 2 info
  - added the new required `header` request parameter `X-SOCA-TOKEN`
  - added the new required `header` request parameter `X-SOCA-USER`
  - deleted the `header` request parameter `X-EDH-TOKEN`
  - deleted the `header` request parameter `X-EDH-USER`
  - …2 more

[Change history](https://skmtc.dev/aws-samples/apis/engineering-development-hub-edh-api/changes/api/dcv/virtual_desktops/stop/put.md)

---

[API](https://skmtc.dev/aws-samples/apis/engineering-development-hub-edh-api.md) · [All operations](https://skmtc.dev/aws-samples/apis/engineering-development-hub-edh-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/aws-samples/engineering-development-hub-edh-api/revisions/058396b8f0f1/schema)