Health and maintenance

Start an update

Starts an update to the newest release where Marfa installed this server as a service, and returns the update status. Marfa checks the download, swaps the programs, and restarts the server. Requires instance.maintain.

POST
/update

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Header parameters

X-Marfa-Instance-Id?string

The ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.

Match^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response body

About errors

Returns the update status. An update already under way answers the same, and is not started again.

application/json
  1. response

Which release this server runs, the newest one Marfa found, and how this server moves to it.

release*string

The release this server runs.

check_enabled*boolean

true if Marfa checks for new releases. See the stored setting update_check_enabled.

checked_at*|

When a check last found the newest release, in UTC, or null if none has.

check_error*|

Why the latest check failed, or null if it did not. A failed check keeps latest as it was.

latest*|

The newest published release Marfa found, or null if it has found none or the check is off.

available*boolean

true if latest is newer than version.

method*string

How this server moves to a newer release. server: it can update itself when you start an update. manual: someone takes the step in step on its host.

Value in"server""manual"
step*|

What to do on the host to move to latest, in plain words, when available is true and method is manual; otherwise null.

progress*

The update under way, if any.

last*|

How the latest update ended, or null if none has.

  • validation_error: a query parameter is unknown.
application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

Caller lacks the required management permission.

application/json
  1. response

An error response.

error*

What went wrong.

  • update_not_ready: no release newer than the running one has been found, or the release check is off.
  • update_unavailable: this server can't update itself. details.step says what to do on its host, and nothing was changed.
  • instance_changed: X-Marfa-Instance-Id names another instance. Nothing is written.
application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

request_too_large: the request body is larger than this instance accepts.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X POST 'http://localhost:8600/update'
About errors
{  "release": "0.0.74",  "check_enabled": true,  "checked_at": "2026-11-16T15:00:00.000Z",  "check_error": null,  "latest": {    "published_at": "2026-11-16T09:30:00.000Z",    "release": "0.0.75"  },  "available": true,  "method": "server",  "step": null,  "progress": {    "state": "fetching",    "release": "0.0.75"  },  "last": null}