Take a connector hold
Takes the connector's hold for process, or renews it if process already holds it. Only the process holding a live hold can replace the state document or write agreements.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
id*stringThe ID of the connector.
X-Marfa-Instance-Id?stringThe 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.
^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$application/json- body
process*stringA name the process chose for itself, such as a UUID made at start. Marfa treats it as opaque.
1 <= length <= 100Returns the hold. It lapses at expires_at unless the process renews it first.
application/json- response
expires_at*stringWhen the hold lapses: the hold window after Marfa took or renewed it. The window is three minutes unless the instance sets another.
ttl_seconds*integerThe hold window in seconds, so you can schedule the next renewal without reading Marfa's clock.
renewed*booleantrue if this process's hold was still live when the call arrived; false on a first take or after a lapse. If it's false and you believed you held the connector, read the state and agreements again before writing.
missing_required_field:processis missing.validation_error:processisn't 1 to 100 characters, or the body has a top-level field this endpoint doesn't take.
application/json- 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- 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- response
An error response.
error*What went wrong.
connector_not_found: no connector has this ID.
application/json- 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- response
An error response.
error*What went wrong.
connector_held: another process holds the connector untildetails.expires_at. The hold doesn't move.
application/json- 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- response
An error response.
error*What went wrong.
request_too_large: the request body is larger than this instance accepts.
application/json- 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- 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- 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- 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- response
An error response.
error*What went wrong.
curl -X POST 'http://localhost:8600/connectors/string/hold' \ -H 'Content-Type: application/json' \ -d '{ "process": "string"}'{ "expires_at": "2026-10-03T10:25:00.150Z", "ttl_seconds": 180, "renewed": false}