Marfa Cloud

Start a link to Marfa Cloud

Starts linking this instance to Marfa Cloud and returns the link, with the code to approve it on Marfa Cloud. Once linked, the sign-in address moves to the Marfa Cloud address unless you keep it. Requires config.manage.

POST
/cloud/link

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

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

What a link does with the sign-in address.

sign_in_address?string

move makes the Marfa Cloud address the sign-in address once linked, which signs everyone out. keep leaves the sign-in address as it is.

Default"move"
Value in"move""keep"
confirm_sign_in_address_change?boolean

true to confirm the move of the sign-in address. Without it, a move by a recent sign-in on an instance with an owner is refused.

Defaultfalse

Response body

About errors

Returns the link, which is linking.

application/json
  1. response

This instance's link to Marfa Cloud, which gives it a public name and address.

state*string

not_linked: no link, or Marfa Cloud ended it, as ended says. linking: waiting for approval on Marfa Cloud. linked: approved, with a name and address. failed: the link ended without linking, as failure says.

Value in"not_linked""linking""linked""failed"
service_told?boolean

false while Marfa Cloud hasn't been told of an unlink, which Marfa keeps trying to tell it. Present only then, while state is not_linked.

ended?

Why the last link ended without an unlink here. Present while state is not_linked after Marfa Cloud ended the link.

linking?

How to approve the link. Present while state is linking.

name?string

The name Marfa Cloud gave this instance. Present while state is linked.

address?string

The address Marfa Cloud gave this instance. Present while state is linked.

Formaturi
linked_at?string

When Marfa Cloud linked this instance, in UTC. Present while state is linked.

Formatdate-time
connector?

The connector that carries traffic through Marfa Cloud. Present while state is linked.

sign_in_address?

Where the sign-in address stands. Present while state is linking or linked, while failed if the sign-in address is the Marfa Cloud address, and while not linked if the link ended with the sign-in address still at its Marfa Cloud address.

failure?

Why the link failed. Present while state is failed.

  • validation_error: the body names a field Marfa doesn't know or a value of the wrong kind, or the query has a parameter.
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.

Caller lacks the required management permission.

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.

  • cloud_link_exists: a link is linking or linked.
  • conflict: the instance changed during the start. Send it again.
  • instance_changed: X-Marfa-Instance-Id names another instance.
  • no_public_listener: this server runs with only its control socket.
  • sign_in_address_change_unconfirmed: the body lacks confirm_sign_in_address_change: true. details.consequences lists the effects.
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.

  • cloud_unavailable: Marfa Cloud couldn't be reached, didn't answer in time, or didn't start the link. details.reason says which. Nothing was kept. Try again later.
  • write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again.
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/cloud/link' \  -H 'Content-Type: application/json' \  -d '{}'
About errors
{  "state": "linking",  "linking": {    "user_code": "WDJB-MJHT",    "approval_url": "https://cloud.marfa.so/link",    "expires_at": "2026-11-21T09:45:00.000Z"  },  "sign_in_address": {    "state": "pending",    "address": "https://marfa.example.com"  }}