---
title: "Put an instance to sleep: its data, address and connection details are kept, nothing answers until it is woken"
method: POST
path: "/instances/{instance_id}/actions/sleep"
tags: ["actions"]
---

# Put an instance to sleep: its data, address and connection details are kept, nothing answers until it is woken

`POST /instances/{instance_id}/actions/sleep`

## Request

- Base URL: `https://app.lathe.live/api/v1`
- URL: `https://app.lathe.live/api/v1/instances/{instance_id}/actions/sleep`
- Auth: none declared

Its engines stop in order, a copy of its whole disk is taken, and its machine is shut down; its address, its
firewall and its connection details are kept. A client that connects while it sleeps waits and times out.
Wake it with `actions/wake`, which takes about a minute. The price is the same asleep or awake. On a paid plan
the daily backups start again at the wake, and the copy taken at the sleep is kept as an undo snapshot.

## Path parameters

- `instance_id` string, required

## Response `202`

Successful Response

- Accepted
  - `status` 'queued' | 'already_queued' | 'removed'
  - `job_id` string, nullable, required
  - `instance_id` string, required
  - `message` string, required
  - `job_url` string, nullable
  - `checkout_url` string, nullable: A free instance's upgrade: open in a browser and pay the plan's first month; the upgrade follows the payment.
  - `verified` boolean, nullable: Registry credentials only: whether the registry took them. Null when there was no image of yours there to try them on.
  - `warning` string, nullable: Registry credentials only: why the registry refused them, when it did. They are saved either way.
  - `cidrs` string[], nullable: The allowlist as normalised (allowlist only).
  - `settings` object, nullable: Engine settings only: the whole engine as it will be once the job has run, secrets masked. A read before the job finishes still answers the previous values, so an `add` reads its result here.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/lathe/apis/lathe-customer-api.md) · [All operations](https://skmtc.dev/lathe/apis/lathe-customer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/lathe/apis/lathe-customer-api/revisions/68cfd9bb71c1?raw)