Connector hosts

Create a one-time link

Creates a fresh one-time link for a connector host, to move it to a new machine. The link replaces any the host has not redeemed; redeeming it revokes the host's key.

POST
/connector-hosts/{id}/link

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 host.

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

Response body

About errors

Returns the host and its new link.

application/json
  1. response

A connector host and a one-time link that gives it its own key.

host*

The connector host the link is for.

link*string

The one-time link: the instance's sign-in address, /connect# and the code. Give it to the host program once.

code*string

The link's code, which POST /connector-hosts/redeem takes once within 15 minutes. Marfa doesn't show it again.

expires_at*string

When the link ends, in UTC.

Formatdate-time
  • 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: you lack connectors.manage.
application/json
  1. response

An error response.

error*

What went wrong.

connector_host_not_found: no connector host has this ID.

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 POST 'http://localhost:8600/connector-hosts/string/link'
About errors
{  "host": {    "id": "01a1fa31-0d2e-7c4a-9b51-3f2c8e6d1a07",    "name": "Studio Mac",    "created_at": "2026-11-21T10:00:00.000Z",    "updated_at": "2026-11-21T10:00:00.000Z",    "last_seen_at": null,    "linked": false,    "link_expires_at": "2026-11-21T10:15:00.000Z",    "connectors": []  },  "link": "https://marfa.example.com/connect#marfa_l1_4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f",  "code": "marfa_l1_4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f",  "expires_at": "2026-11-21T10:15:00.000Z"}