# Open the desktop

URL: https://heaven.dev/docs/reference/computers/desktop
Updated: 2026-11-21

Get a browser desktop link for a running Computer you own or have root access to. The Computer must provide a desktop.

`GET /v1/computer/?view=desktop`

## Parameters

- `computer` (string, required): Computer name or ID.

## Returns

- `data` (object, always present): The desktop address for a running Computer. The desktop starts on the first visit.
  - `url` (string, always present): Desktop URL requiring Owner or Root access.

## Errors

Each code is explained in full at https://heaven.dev/docs/reference/errors.

| Code | Status | What happened |
|---|---:|---|
| `invalid` | 400 | An input is missing or invalid. |
| `unauthenticated` | 401 | The credential is missing, invalid, expired or revoked. |
| `denied` | 403 | The caller lacks permission for this action. |
| `not_found` | 404 | The resource is absent or inaccessible to this caller. |
| `conflict` | 409 | The request conflicts with the current resource state or an earlier request. |
| `over_capacity` | 409 | The request exceeds a resource or credential allowance. |
| `access_list_full` | 409 | The change would exceed the access-list allowance. |
| `rate_limited` | 429 | The caller's request rate exceeds its limit. |
| `busy` | 429 | Too much work is in progress to accept this request. |
| `unknown` | 503 | The outcome is unconfirmed; a change may have happened. |
| `unavailable` | 503 | The service or requested feature is unavailable. |

## Notes

- API key permission: `desktop`.

## Examples

```sh tab="heaven CLI"
heaven desktop COMPUTER
```

```sh tab="SSH"
ssh cli@heaven.dev desktop COMPUTER
```

```sh tab="cURL"
curl "https://heaven.dev/v1/computer/?view=desktop&computer=my-site" \
  -H "Authorization: Bearer $HEAVEN_API_KEY"
```

```json tab="MCP"
{ "tool": "desktop",
  "arguments": { "computer": "my-site" } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "url": "https://my-site.heaven.dev:6080/"
  }
}
```
