Blobs Server-side HTTP API¶
Soledad Server provides two different REST APIs for interacting with blobs:
- A Public Blobs HTTP API, providing the Blobs service for Soledad Client (i.e. actual users of the infrastructure).
- A Local Incoming Box HTTP API, providing the delivery part of the Incoming Box service, currently used for the MX mail delivery.
Authentication is handled differently for each of the endpoints, see Authentication for more details.
Public Blobs HTTP API¶
The public endpoint provides the following REST API for interacting with the Blobs service:
path | method | action | accepted query string fields |
---|---|---|---|
/blobs/{uuid} |
GET |
Get a list of blobs. filtered by a flag. | namespace , filter_flag , order_by |
/blobs/{uuid}/{blob_id} |
GET |
Get the contents of a blob. | namespace |
/blobs/{uuid}/{blob_id} |
PUT |
Create a blob. The content of the blob should be sent in the body of the request. | namespace |
/blobs/{uuid}/{blob_id} |
POST |
Set the flags for a blob. A list of flags should be sent in the body of the request. | namespace |
/blobs/{uuid}/{blob_id} |
DELETE |
Delete a blob. | namespace |
When listing blobs, results can be filtered and ordered by using different query string parameters. See the table above for accepted query string fields for each action.
The Blobs service supports namespaces. All requests can be modified by the
namespace
query string parameter, and the results will be restricted to
a certain namespace. When no namespace explicitelly given, the default
namespace is used.
Listing results can be filtered by flags using the filter_flag
query string
parameter. Currently valid values for flags PENDING
, PROCESSING
,
PROCESSED
, and FAILED
.
Also, results can be ordered by date using the order_by
query string
parameters. The possible values for order_by
are date
or +date
for
increasing order, or -date
for decreasing order.
Local Incoming Box HTTP API¶
The local endpoint provides the following REST API for interacting with the Incoming Box service.
path | method | action |
---|---|---|
/incoming/{uuid}/{blob_id} |
PUT |
Create an incoming blob. The content of the blob should be sent in the body of the request. |
All blobs created using this API are inserted under the namespace MX
and
flagged as PENDING
.