Connector state

Write connector agreements

Writes and clears the connector's agreements, its records of what it and its vendor last agreed about each item. Only the process holding a live hold can write them.

POST
/connectors/{id}/agreements

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path parameters

id*string

The ID of the connector.

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
process*string

The name the process took the connector's hold under.

Length1 <= length <= 100
set?array<>

Agreements to write. Each replaces the item's current agreement. Leave it out to write none.

Itemsitems <= 500
clear?array<>

The IDs of items whose agreements to remove. Leave it out to remove none.

Itemsitems <= 500

Response body

About errors

Returns how many agreements Marfa wrote and removed, and the IDs it skipped. Writing an agreement doesn't change the item, its updated_at or its version, and sends no event.

application/json
  1. response
written*integer

How many agreements Marfa wrote.

cleared*integer

How many agreements Marfa removed.

skipped*array<string>

The IDs Marfa skipped, in the order named, set first. An ID is skipped if no stored item has it or its type is one you can't read. A trashed item counts as stored.

  • missing_required_field: process is missing, or an entry in set lacks a field.
  • validation_error: a list has more than 500 entries, a record is over 16 KiB serialized, an item is named twice across set and clear, a field has the wrong type, or the body has a top-level field 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.

  • forbidden: your credential isn't the connector's own key. Management permission does not authorize connector activity.
application/json
  1. response

An error response.

error*

What went wrong.

  • connector_not_found: no connector has this ID.
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.

  • connector_held: process doesn't hold the connector. details.expires_at is when another process's hold ends, and is absent when no process holds a live hold. Nothing is written.
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/connectors/string/agreements' \  -H 'Content-Type: application/json' \  -d '{  "process": "string"}'
About errors
{  "written": 1,  "cleared": 0,  "skipped": [    "01a1012c-0b4e-7d95-9c27-5a8e1f3b6d40"  ]}