Connector hosts

Get your connector host

Returns the host whose key you are, with each connector assigned to it, and records that the host was seen. Only a connector host's own key reads it.

GET
/connector-hosts/self

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Response body

About errors

Returns the host and its connectors.

application/json
  1. response

What a connector host runs, as its own key reads it.

id*string

The ID of the host.

name*string

The host's name.

connectors*array<>

The connectors assigned to the host, by plugin name.

  • 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 is not a connector host's own key.
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/connector-hosts/self'
About errors
{  "id": "01a1fa31-0d2e-7c4a-9b51-3f2c8e6d1a07",  "name": "Studio Mac",  "connectors": [    {      "plugin": "rss",      "version": "1.0.0",      "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",      "connector": {        "source": "rss",        "source_name": "RSS",        "source_mark": "lucide:rss",        "kinds": [          {            "name": "entry",            "type": "rss.entry",            "direction": "in"          }        ],        "settings": [          {            "name": "feed_url",            "label": "Feed address",            "kind": "text",            "required": true          }        ],        "runs": {          "on": "host"        }      },      "registration_id": "01a1fa32-7c10-7a55-a0e4-1b8d3f6c2e90",      "key_minted": true,      "paused": false,      "run_requested_at": null    }  ]}