Items

Settle tombstones

Settles tombstones, moving their settled_at later, never earlier, and returns them. A connector calls it after changing the vendor's copy to carry out a purge, so that change doesn't bring the item back as a new item.

POST
/items/tombstones

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}$

Request body

application/json
  1. body
type*string

The type the links are held in and the tombstones are kept under.

links?array<>

Link values to name. type must name a link_field. Links held by a subtype's items aren't included.

source?string

The source the source_ids are natural keys under.

Length1 <= length
source_ids?array<>

The source_id values to name under source.

settled_at*string

The time of the vendor's own change that carried out the purge, as an RFC 3339 time. A tombstone takes it only if it is later than the tombstone's current settled_at.

Response body

About errors

Returns the named tombstones as they now stand. A key with no tombstone under type is left out.

application/json
  1. response
data*array<>

The named tombstones as they stand after the write, in the order named. A key with no tombstone under type is left out.

  • missing_required_field: type or settled_at is missing.
  • validation_error: type or settled_at is malformed, the body doesn't name exactly one of links or source with source_ids, or has more than 500 values, an empty value, an undeclared key, or links for a type with no link_field.
  • unknown_type: type isn't registered.
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.

  • type_not_permitted: you don't have write on type.
  • forbidden: source is not your credential's own or one of your key's sources. details.source names it.
application/json
  1. response

An error response.

error*

What went wrong.

request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.

application/json
  1. response

An error response.

error*

What went wrong.

instance_changed: X-Marfa-Instance-Id names another instance. Nothing is written. Rebuild the working copy from the instance at this address.

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/items/tombstones' \  -H 'Content-Type: application/json' \  -d '{  "type": "string",  "settled_at": "string"}'
About errors
{  "data": [    {      "key": "deal-1041",      "purged_at": "2026-10-03T09:30:00.000Z",      "settled_at": "2026-10-05T14:12:08.000Z"    }  ]}