Plugins

Update a connector's settings

Sets each setting the body names, or removes its value for null, so the setting reads its default. Marfa seals a secret with the settings key beside the database and never returns it.

PATCH
/plugins/{name}/connector/settings

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

Request body

application/json
  1. body

Each setting to change, by name.

[key: string]?unknown

The setting's new value, or null to remove the value set.

Response body

About errors

Returns the connector's settings after the change.

application/json
  1. response

The settings of a plugin's connector.

plugin*string

The 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 body isn't an object, names a setting the connector doesn't declare, or gives a value that doesn't fit its setting: text of 1 to 65,536 characters, a secret's with no white space at either end, a number, true or false, or one of its choices. details.errors names each setting, never a secret's value, and nothing is stored.
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.
application/json
  1. 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
  1. response

An error response.

error*

What went wrong.

request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.

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

request_too_large: the request body is larger than this instance accepts.

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 PATCH 'http://localhost:8600/plugins/string/connector/settings' \  -H 'Content-Type: application/json' \  -d '{  "feed_url": "https://example.com/feed.xml",  "token": "a secret value"}'
About errors
{  "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": []}