Health and maintenance

List housekeeping jobs

Returns every housekeeping job Marfa runs: its interval, when it's next due, whether a run holds it, and what its last run did. A job a server setting switches off isn't listed. Requires instance.read.

GET
/housekeeping

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Response body

About errors

Returns every housekeeping job, in one page.

application/json
  1. response

A page holding every housekeeping job.

data*array<>

Every housekeeping job.

next_cursor*|

Always null: Marfa returns every housekeeping job in one page.

  • validation_error: the query has a parameter this endpoint doesn't take.
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.

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.

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 GET 'http://localhost:8600/housekeeping'
About errors
{  "data": [    {      "name": "enrichment-sweep",      "interval_seconds": 30,      "next_run_at": "2026-10-03T10:22:35.626Z",      "running_since": null,      "last_started_at": null,      "last_finished_at": null,      "last_outcome": null,      "last_error": null,      "last_result": null    },    {      "name": "audit-cleanup",      "interval_seconds": 86400,      "next_run_at": "2026-10-03T10:16:10.512Z",      "running_since": null,      "last_started_at": null,      "last_finished_at": null,      "last_outcome": null,      "last_error": null,      "last_result": null    }  ],  "next_cursor": null}