Connector state

Replace a connector's state

Replaces the whole state document of the connector's source. Only the process holding a live hold can write it.

PUT
/connectors/{id}/state

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
problems?

The source's current problems. Leave it out to preserve the current map; send {} to clear it.

state*

The new document, a JSON object of at most 512 KiB serialized. It replaces the whole document.

Response body

About errors

Returns the document as written.

application/json
  1. response
problems*

The source's current problems, by opaque key; {} if there are none.

state*

The document as written.

updated_at*string

When it was written.

  • missing_required_field: process or state is missing.
  • validation_error: process isn't 1 to 100 characters, state isn't a JSON object or is over 512 KiB serialized, a problems map is over its entry, message or serialized size limits, 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 PUT 'http://localhost:8600/connectors/string/state' \  -H 'Content-Type: application/json' \  -d '{  "process": "string",  "state": {    "property1": null,    "property2": null  }}'
About errors
{  "problems": {},  "state": {    "cursor": "page-7"  },  "updated_at": "2026-10-03T10:05:20.601Z"}