Get a connector's settings
Returns each setting a plugin's connector declares, with the value set or its default. A secret's value is never returned: set says whether one is set.
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 settings.
application/json- response
The settings of a plugin's connector.
plugin*stringThe plugin's name.
settings*array<>Each setting the plugin's connector declares, in its order.
missing*array<string>The name of each required setting with no value Marfa can read and no default. The connector can't run until each is set.
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 lackconnectors.manage.
application/json- response
An error response.
error*What went wrong.
plugin_not_found: no plugin of this name is installed.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/settings'{ "plugin": "rss", "settings": [ { "name": "feed_url", "label": "Feed", "kind": "text", "choices": null, "secret": false, "required": true, "default": null, "value": "https://example.com/feed.xml", "set": true, "unreadable": false }, { "name": "token", "label": "Token", "kind": "text", "choices": null, "secret": true, "required": true, "default": null, "value": null, "set": true, "unreadable": false } ], "missing": []}