Rewrite a connector's items
Counts the connector's items on each kind's target type. Without dry_run, also stores a numbered request to rewrite them, which the connector reads from the mapping's rewrites and clears. Needs connectors.manage.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
name*stringThe plugin's name.
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
A rewrite of the connector's existing items.
dry_run?booleanCount the items without asking for the rewrite.
kinds?array<string>The kinds to rewrite. Without it, every enabled kind.
Returns the counts.
application/json- response
How many items a rewrite touches.
dry_run*booleanWhether the rewrite was only counted.
number?integerThe stored request's number. Absent on a dry run, which stores none.
1 <= valueversion*integerThe mapping's version.
0 <= valuekinds*Each kind counted, by name.
validation_error: the body names a kind the connector doesn't bring, or a member of the wrong shape.details.errorsnames each path.
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 (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: another instance answers 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.
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/plugins/string/connector/mapping/rewrite' \ -H 'Content-Type: application/json' \ -d '{ "dry_run": true}'{ "dry_run": true, "version": 3, "kinds": { "issue": { "target_type": "common.ticket", "count": 412 } }}