instances

Change some of one engine's settings and leave the rest as they are; an empty value puts a key back to its default. `add` and `remove` append to and drop from a list-valued key (redirect_urls, authorized_addresses) without sending the whole list; the answer carries the engine's settings as they will be

patch/instances/{instance_id}/engines/{engine}/settings

Request

  • Base URL: https://app.lathe.live/api/v1
  • URL: https://app.lathe.live/api/v1/instances/{instance_id}/engines/{engine}/settings
  • Auth: none declared

Path parameters

instance_idstring required
enginestring required

Request body

settingsobject

Keys from the engine's settings schema; every key you leave out stays as it is.

addobject

Entries to append to a list-valued key (GET the settings for lists); an entry already there is not added twice.

removeobject

Entries to drop from a list-valued key. Applied before add, and an entry that is not there is not an error: the answer says what the key became.

confirmstring

The exact change string returned by a refused unconfirmed call. Binds the instance, action, resource and submitted values.

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.