Plugins

Run a connector now

Stores the time you asked the plugin's connector to run, which it reads and follows. A run the connector reports naming that time as its run_requested_at clears it.

POST
/plugins/{name}/connector/run

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path parameters

name*string

The plugin's name.

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}$

Response body

About errors

Returns the connector's state.

application/json
  1. response

What the owner wants of a plugin's connector, which the connector reads each run.

plugin*string

The plugin whose connector this is.

source*string

The 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*boolean

true 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.

Formatdate-time
mapping_version*integer

The version of the connector's mapping, 0 until one is saved.

Range0 <= value
rewrites*integer

How many rewrite requests wait on the connector.

Range0 <= value
previews*integer

How many mapping previews wait on the connector.

Range0 <= value
  • validation_error: the query has a parameter 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: you lack connectors.manage (details.required_scope).

application/json
  1. 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
  1. response

An error response.

error*

What went wrong.

  • connector_paused: the connector is paused. Resume it first.
  • instance_changed: another instance answers at this address.
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.

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/plugins/string/connector/run'
About errors
{  "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}