actions

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

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.

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

Path parameters

instance_idstring required

Response

Successful Response

status'queued' | 'already_queued' | 'removed'
job_idstring nullable required
instance_idstring required
messagestring required
job_urlstring nullable
checkout_urlstring nullable

A free instance's upgrade: open in a browser and pay the plan's first month; the upgrade follows the payment.

verifiedboolean nullable

Registry credentials only: whether the registry took them. Null when there was no image of yours there to try them on.

warningstring nullable

Registry credentials only: why the registry refused them, when it did. They are saved either way.

cidrsstring[] nullable

The allowlist as normalised (allowlist only).

settingsobject 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.

Changes

No recorded changes to this operation across all 1 revision of this API.