Replace the password
Replaces the owner's password once current_password proves right, and ends every browser sign-in. Keys and apps keep their access. Requires sign_ins.manage.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
X-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}$application/json- body
current_password*stringThe owner's current password. If it is wrong, Marfa answers 401 unauthorized and changes nothing.
1 <= length <= 1024new_password*stringThe new password, counted in characters.
8 <= length <= 128Returns ok: true. The password has changed and every browser sign-in has ended.
application/json- response
Confirms that the request succeeded.
ok*trueAlways true.
truemissing_required_field:current_passwordornew_passwordis missing.validation_error:new_passwordis shorter than 8 or longer than 128 characters,current_passwordis empty or longer than 1024 characters, or the body has another field. Nothing changes.
application/json- response
An error response.
error*What went wrong.
unauthorized: the request has no credential, its credential is not valid, or current_password is wrong. Nothing changes. For a key that has expired, details.expired_at says when it expired.
application/json- response
An error response.
error*What went wrong.
forbidden: the credential lackssign_ins.manage.details.required_scopenames it.
application/json- 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- 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.
request_too_large: the request body is larger than this instance accepts.
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 PUT 'http://localhost:8600/owner/password' \ -H 'Content-Type: application/json' \ -d '{ "current_password": "string", "new_password": "stringst"}'{ "ok": true}