Health and maintenance

Run a housekeeping job

Runs a housekeeping job now, waits for it to finish, and returns what the run did. A failed run still returns 200, with the failure in outcome and error. Requires instance.maintain.

POST
/housekeeping/{name}/run

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path parameters

name*string

The housekeeping job's name, as GET /housekeeping lists it.

Match^[a-z][a-z0-9-]*$

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

application/json
  1. response

One run of a housekeeping job.

name*string

The job's name.

started_at*string

When the run started, in UTC.

finished_at*string

When the run finished, in UTC.

outcome*string

How the run ended.

Value in"succeeded""failed""held"
result*|

What the run reported, or null if it reported nothing.

error*|

The error the run hit, or null if it had none.

  • validation_error: name isn't lowercase letters, digits and hyphens starting with a letter, or 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.

  • housekeeping_job_not_found: this instance runs no housekeeping job with this name.
application/json
  1. response

An error response.

error*

What went wrong.

  • housekeeping_job_running: the housekeeping job is already running. Try again when the run finishes.
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/housekeeping/string/run'
About errors
{  "name": "trash-purge",  "started_at": "2026-10-03T10:18:35.142Z",  "finished_at": "2026-10-03T10:19:35.920Z",  "outcome": "succeeded",  "result": {    "deleted": 0  },  "error": null}