Health and maintenance

List attention items

Returns what needs the owner's attention. Requires instance.read. A check that fails or runs out of time appears as an unavailable item beside the known concerns. An empty list means every check completed without a concern.

GET
/attention

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Response body

About errors

Returns concerns and any checks whose state is unknown.

application/json
  1. response

The current attention inventory, without pagination.

data*array<>

Every known concern and unavailable check; empty when all checks report no concerns.

  • validation_error: a query field 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.

  • forbidden: the credential lacks instance.read. details.required_scope names it.
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/attention'
About errors
{  "data": [    {      "kind": "backup",      "reference": "parts_damaged",      "title": "Parts of backups are damaged",      "description": "1 part in the backup folder does not hold the bytes its name gives or cannot be read. A restore of a backup that names one is refused. The next backup stores again each damaged part it names; `marfa backups run` takes one now. A part that only older backups name stays damaged until those backups are gone."    }  ]}