# Reinstall a Computer

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

Replace a Computer's disk with a fresh image and start it with its setup script. The new disk replaces files, installed software and databases. Existing snapshots remain available to restore or copy. Use `dry_run: true` to see what a reset would erase.

`POST /v1/computer/modify`

## Parameters

- `computer` (string, required): Computer name or ID.
- `image` (string): Image to reinstall. Defaults to the Computer's current image.
- `setup_script` (string): Replacement script to run when the fresh disk starts. Heaven keeps it for later resets. The saved script is used by default. Treated as a secret and never included in errors.
- `dry_run` (boolean): Preview what the reset would erase and what you can recover.
- `wait` (boolean or string): Wait for the operation to finish. Use true for up to 10m or give a shorter duration such as 2m. Accepted work continues after the wait ends.

## Returns

- `data` (object, always present): An operation and its request ID. A preview of the requested change.
  - `alternative-1` (object): An operation and its request ID.
    - `name` (string): Computer's name after creation, copying or reset. May be omitted.
    - `notes` (string[]): Other effects, including settings or integrations excluded from a copy. May be omitted.
    - `operation` (object, always present): Current operation state.
      - `by` (string): Requester's email address, or user ID if no email is recorded. Omitted for your own requests. May be omitted.
      - `completed_at` (string (date-time)): When the operation reached its final state. Absent while unfinished. May be omitted.
      - `computer_id` (string, always present): Computer's stable ID.
      - `created_at` (string (date-time)): When Heaven accepted the change. May be omitted.
      - `error_code` (string): Recorded failure code. May be omitted.
      - `id` (string, always present): Operation ID for `operation view`.
      - `kind` (string, always present): Change being tracked.
      - `message` (string): An explanation of the recorded failure and any next action. May be omitted.
      - `state` (string, always present): `accepted` means saved and unfinished. `complete` means the change finished. `failed` means it could not finish. `superseded` means a newer change replaced it before completion. Values: `"accepted"`, `"complete"`, `"failed"`, `"superseded"`.
    - `pool_note` (string): How stopping this Computer affects its pool. May be omitted.
    - `renamed` (object): Addresses affected by a rename. May be omitted.
      - `https` (string, always present): Website URL using the new name.
      - `mail` (string, always present): Domain under which the Computer receives mail.
      - `names` (object[]): Custom names created with the Computer and whether they followed its rename. May be omitted.
        - `items` (object): A custom name affected by a Computer rename.
          - `from` (string, always present): Previous custom name.
          - `moved` (boolean, always present): Whether the name moved. False means the destination was occupied and the old custom name was retained.
          - `to` (string, always present): Name corresponding to the Computer's new name.
      - `note` (string, always present): What happened to old addresses and when the guest hostname changes.
      - `ports` (string[]): Published port addresses that use the new name. May be omitted.
      - `ssh` (string, always present): SSH command using the new name.
    - `request_id` (string, always present): Request ID identifying this change across retries.
    - `ssh_dest` (string): SSH destination in `NAME@DOMAIN` form. May be omitted.
    - `url` (string): Computer's website address. May be omitted.
  - `alternative-2` (object): A preview of the requested change.
    - `changes` (string[]): Proposed effects and losses. May be omitted.
    - `dry_run` (boolean, always present): True for a preview; no changes are made.
    - `message` (string, always present): What the request would do.

## 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. |
| `payment_required` | 402 | Payment or credit is required. |
| `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: `reset`.
- A key limited to a command list must also allow `delete`.

## Examples

```sh tab="heaven CLI"
heaven reset COMPUTER
  [--image IMAGE]
  [--setup-script SCRIPT]
  [--request-id ID]
  [--dry-run]
  [--wait[=DURATION]]
```

```sh tab="SSH"
ssh cli@heaven.dev reset COMPUTER
  [--image IMAGE]
  [--setup-script SCRIPT]
  [--request-id ID]
  [--dry-run]
  [--wait[=DURATION]]
```

```sh tab="cURL"
curl https://heaven.dev/v1/computer/modify \
  -H "Authorization: Bearer $HEAVEN_API_KEY" \
  --json '{"action": "reset", "computer": "my-site"}'
```

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

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "name": "my-site",
    "operation": {
      "computer_id": "3f1c9e2a-7b4d-4c8e-9a6f-2d5b8e1c7a90",
      "created_at": "2026-11-16T12:00:00Z",
      "id": "026776bd-32a6-4efb-af42-6246c41db290",
      "kind": "reset",
      "state": "accepted"
    },
    "request_id": "11c77db5-1ed4-4455-a42f-77b79afd89bc",
    "ssh_dest": "my-site@heaven.dev",
    "url": "https://my-site.heaven.dev"
  }
}
```
