Blobs

Upload a blob

Stores the request body as a blob and returns its sha256: hash. Uploading bytes Marfa already holds returns the same hash, and there is no size limit. To read the blob back, first write its hash into an item, edge or extension.

POST
/blobs

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

The bytes to store, sent as they are, not as multipart/form-data. Set Content-Type to their MIME type.

body*fileapplication/octet-stream
Formatbinary

Response body

About errors

Returns the blob's hash, mime_type and size_bytes. If Marfa already held these bytes, mime_type is the type of the first upload, not the one you sent.

application/json
  1. response
hash*string

The blob's hash: sha256: and 64 hexadecimal characters.

mime_type*string

The MIME type Marfa serves the blob with: the Content-Type of the first upload of these bytes, without parameters such as charset.

size_bytes*number

The blob's size in bytes.

  • validation_error: the body is empty, or is multipart/form-data.
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.

  • type_not_permitted: your credential has no write on any registered type. Marfa refuses the upload before it reads the body.
application/json
  1. response

An error response.

error*

What went wrong.

  • request_timeout: no bytes arrived for 60 seconds. Marfa stores nothing. An upload has no other time limit while bytes keep arriving.
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.

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.

  • blob_store_unavailable: a store hasn't finished an earlier write or delete of these bytes, so Marfa can't place them yet. Marfa stores nothing. 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/blobs' \  -H 'Content-Type: application/octet-stream' \  -d 'string'
About errors
{  "hash": "sha256:3c560b4bf3ab13ccefa449c14ff8c7d8ea94a27bd827db9451e9bead83c2db1a",  "mime_type": "text/plain",  "size_bytes": 42}