Items

Upsert items in bulk

Creates or updates up to 5,000 items in one call, matching existing items on (source, source_id). The batch is atomic by default: one failed entry rolls it all back. Returns each entry's outcome.

POST
/items/bulk

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
items*array<>

The entries to write, at most 5,000. An entry with a key this operation doesn't declare is refused as validation_error, and details.unknown_body_fields names each key.

mode?string

upsert (the default) updates the item an entry matches. create_only skips it, reporting skipped with reason duplicate_source, or duplicate_id if it matched by id.

Value in"upsert""create_only"
atomic?boolean

Whether one failed entry rolls back the whole batch. Defaults to true. With false, that entry is errored and the rest are written.

enable_fanout?boolean

Whether each write also calls outbound webhooks. Defaults to false. Marfa logs the events either way.

retype?boolean

true moves an item to the entry's type when the entry resolves an existing item of another type. You need write on both types. Defaults to false.

Response body

About errors

Returns counts and a results entry for each item, in order: created, updated, skipped or errored. Under upsert, an entry is skipped with reason trashed where it matches a trashed item, or unchanged where it would leave its item as it is. Under create_only, a matching entry is skipped with reason duplicate_source or duplicate_id.

application/json
  1. response

What a bulk write did with each entry.

counts*

How many entries had each outcome.

results*array<>

One result per entry, in the order you sent them.

  • validation_error: the body is malformed, has an undeclared key or has over 5,000 entries.
  • missing_required_field: a required field is missing.
  • invalid_properties: an entry's properties hold a whole number a 64-bit float can't keep.
  • bulk_atomic_rollback: an atomic entry was refused and nothing was written (details.code, details.index). The status is the refusal's own.
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 an entry's type, or on the type its natural key matches, or your credential reaches no type.
  • forbidden: an entry names a source your key doesn't claim or the instance's source allow-list excludes, or moves a natural key under a source your key doesn't write under.
  • bulk_atomic_rollback: one of these under atomic.
application/json
  1. response

An error response.

error*

What went wrong.

  • bulk_atomic_rollback: with atomic true, an entry names an item or edge type that isn't there, such as an item an edge points to. details.code is item_not_found or edge_type_not_found.
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.

  • bulk_atomic_rollback: with atomic true, an entry's item has moved or is taken. details.code names the cause, such as version_conflict, link_taken, type_mismatch (the natural key matched an item of another type) or id_reused (the entry's id belongs to an item it doesn't describe).
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/bulk' \  -H 'Content-Type: application/json' \  -d '{  "items": [    {      "type": "string"    }  ]}'
About errors
{  "counts": {    "created": 1,    "updated": 0,    "skipped": 1,    "errored": 0  },  "results": [    {      "index": 0,      "outcome": "created",      "id": "01a1011c-a927-72fe-aafd-8a149cf388d9"    },    {      "index": 1,      "outcome": "skipped",      "id": "01a1011c-2f86-76b6-9594-050c109f4957",      "reason": "unchanged"    }  ]}