Name a source
Sets or clears a source's name and mark, and returns the source. A field left out keeps its value. You can change your own source and those you claim; any other needs keys.manage.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
source*stringThe source code, such as github. Percent-encode it as one path segment.
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
name?|The name to show for the source, or null to clear it. Marfa trims spaces from each end.
1 <= length <= 200mark?|An icon ID from the same sets as a type's icon, or null to clear it.
Returns the source as it now reads.
application/json- response
A source code with the name and mark it's shown by.
source*stringThe source code, as items carry it in source.
name*stringThe name to show for the source.
name_from*stringWhere name comes from: set on the source, the app signed in under it, the label of the key that holds it, or the code itself.
"set""app""key""code"mark?stringThe icon ID set for the source, from the same sets as a type's icon. Absent until someone sets one.
missing_required_field:sourceis missing.validation_error:sourceis empty, padded, or over 200 characters excluding a leadingrestored:,nameis empty, too long or holds a control character, the body has a field this endpoint doesn't take, or the query has a parameter it doesn't take.invalid_schema:markisn't the ID of an icon in a pinned set (details.errorsnames it).
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_at says when it expired.
application/json- response
An error response.
error*What went wrong.
forbidden: the source isn't your own or one you claim, and you don't hold keys.manage (details.required_scope).
application/json- 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- 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 PATCH 'http://localhost:8600/sources/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "source": "crm", "name": "CRM", "name_from": "set"}