Unlink from Marfa Cloud
Ends the link to Marfa Cloud, or cancels one that is linking, and tells Marfa Cloud. If the sign-in address is the Marfa Cloud address, it moves back to the one before. Requires config.manage.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
confirm_sign_in_address_change?booleantrue to confirm that the sign-in address moves back from the Marfa Cloud address, which signs everyone out. Needed only when the sign-in address is the Marfa Cloud address.
falseX-Marfa-Instance-Id?stringThe 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.
^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Returns not_linked. An instance with no link answers the same.
application/json- response
What an unlink did.
state*"not_linked"Always not_linked.
"not_linked"service_told?booleantrue if Marfa Cloud was told, or took the cancel of a link that was linking. false if it couldn't be reached, and Marfa keeps trying. Present when a link was linking or linked.
validation_error: the query has a parameter this endpoint doesn't take, orconfirm_sign_in_address_changeis nottrueorfalse.
application/json- 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_atsays when it expired.insufficient_user_authentication: your app's owner signed in more than fifteen minutes ago. Send them throughGET /oauth/authorizewithmax_age.
application/json- response
An error response.
error*What went wrong.
forbidden: you don't holdconfig.manage, whichdetails.required_scopenames.app_sign_in_required: the sign-in address moves back, which needs a recent sign-in, and you are an API key. A person unlinks from an app they signed in to, or with the private local command.
application/json- response
An error response.
error*What went wrong.
conflict: the link changed while it was unlinked. Send it again.instance_changed:X-Marfa-Instance-Idnames another instance.sign_in_address_change_unconfirmed: the query lacksconfirm_sign_in_address_change=true.details.consequenceslists the effects.sign_in_address_check_failed: the address to put back did not answer as this instance.
application/json- 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- 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- 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- 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- 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- response
An error response.
error*What went wrong.
curl -X DELETE 'http://localhost:8600/cloud/link'{ "state": "not_linked", "service_told": true}