Connector state

Get a connector's own settings

Returns each setting of the plugin's connector, every secret's value included. Only the key its connector host minted gets an answer, checked as Marfa answers. Read it at the start of each run.

GET
/connectors/{id}/settings

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path parameters

id*string

The ID of the connector.

Response body

About errors

Returns the connector's settings, its secrets included.

application/json
  1. response

The settings of a plugin's connector, its secrets included, as its own key reads them.

plugin*string

The plugin whose connector this is.

settings*array<>

Each setting the connector declares, in its order.

missing*array<string>

The name of each required setting with no value Marfa can read and no default. Tell the owner, and don't run without them.

  • 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: your credential isn't the connector's own key. No other key, app or permission reads a connector's secrets.
application/json
  1. response

An error response.

error*

What went wrong.

  • connector_not_found: no connector has this ID, or its key isn't one a connector host minted for a plugin's connector.
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 GET 'http://localhost:8600/connectors/string/settings'
About errors
{  "plugin": "rss",  "settings": [    {      "name": "feed_url",      "kind": "text",      "secret": false,      "required": true,      "value": "https://example.com/feed.xml",      "set": true,      "unreadable": false    },    {      "name": "token",      "kind": "text",      "secret": true,      "required": true,      "value": "a secret value",      "set": true,      "unreadable": false    }  ],  "missing": []}