Get a connector's mapping
Returns the owner's mapping of each kind a plugin's connector brings. Until one is saved, each kind takes its default at version 0. 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 mapping.
application/json- response
A plugin connector's mapping.
version*integerThe mapping's version. 0 until a mapping is saved.
0 <= valuekinds*Each kind the plugin's connector brings, by name.
rewrites*array<>Each rewrite the owner asked for that the connector has not cleared, oldest first.
validation_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.
reach_changed: the reach in X-Marfa-Reach has changed. Rebuild the working copy.
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/mapping'{ "version": 3, "kinds": { "issue": { "enabled": true, "target_type": "common.ticket", "tier": "feed", "status_overrides": { "closed": "completed" }, "fields": { "title": { "from": "title" }, "reporter": { "fixed": "tracker" }, "body": { "template": "{{ body }}" } } } }, "rewrites": []}