Connector hosts

Redeem a one-time link

Gives a connector host its own key, in exchange for the code of its one-time link. Send no credential. A host that held a key loses it.

POST
/connector-hosts/redeem

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
code*string

The code of the host's one-time link.

Response body

About errors

Returns the host's key.

application/json
  1. response

The key a redeemed link gives its connector host.

host*

The host the link was made for.

key*string

The host's own key, which reaches only GET /connector-hosts/self and POST /connector-hosts/self/connectors/{plugin}/key. Marfa doesn't show it again.

key_id*string

The ID of the host's key.

  • validation_error: the body has a key other than code, or code is not text.
application/json
  1. response

An error response.

error*

What went wrong.

connector_link_not_found: the code redeems no link: it was used or replaced, it ended, its host was removed, or Marfa never made it.

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/redeem' \  -H 'Content-Type: application/json' \  -d '{  "code": "string"}'
About errors
{  "host": {    "id": "01a1fa31-0d2e-7c4a-9b51-3f2c8e6d1a07",    "name": "Studio Mac"  },  "key": "marfa_k1_0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a",  "key_id": "01a1fa31-4b7f-7e21-8c3d-5a9b0f2e6c18"}