Get a connector's state
Returns what the owner wants of a plugin's connector: whether it is paused, a run asked for, and how many rewrites and previews wait on it. Needs connectors.manage, or the connector's own key.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
name*stringThe plugin's name.
Returns the connector's state.
application/json- response
What the owner wants of a plugin's connector, which the connector reads each run.
plugin*stringThe plugin whose connector this is.
source*stringThe source the connector holds.
host*|The ID of the host the connector is assigned to, or null.
registration*|The ID of the registration the connector's current key made, or null.
paused*booleantrue if the owner paused the connector. The connector stops itself; Marfa still takes its writes.
run_requested_at*|When the owner last asked the connector to run now, in UTC, until the connector reports a run that names this time as its run_requested_at. null if no run is waiting.
date-timemapping_version*integerThe version of the connector's mapping, 0 until one is saved.
0 <= valuerewrites*integerHow many rewrite requests wait on the connector.
0 <= valuepreviews*integerHow many mapping previews wait on the connector.
0 <= valuevalidation_error: the query has a parameter 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: you don't have connectors.manage and aren't the connector's own key (details.required_scope).
application/json- response
An error response.
error*What went wrong.
plugin_not_found: no plugin of this name is installed.plugin_connector_not_found: the plugin has no connector.
application/json- 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- 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.
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 GET 'http://localhost:8600/plugins/string/connector'{ "plugin": "rss", "source": "rss", "host": "01a1fa31-0d2e-7c4a-9b51-3f2c8e6d1a07", "registration": "01a1fa32-7c10-7a55-a0e4-1b8d3f6c2e90", "paused": false, "run_requested_at": "2026-10-03T09:30:00.000Z", "mapping_version": 1, "rewrites": 0, "previews": 1}