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|
||Get a list of blobs. filtered by a flag.||
||Get the contents of a blob.||
||Create a blob. The content of the blob should be sent in the body of the request.||
||Set the flags for a blob. A list of flags should be sent in the body of the request.||
||Delete a blob.||
||Stream a set of blobs.||
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
namespace is used.
When listing blobs, results can be filtered and ordered by using different
query string parameters. Listing results can be filtered by flags using the
filter_flag query string parameter. Currently valid values for flags
FAILED. Also, results can
be ordered by date using the
order_by query string parameters. The possible
+date for increasing order, or
-date for decreasing order.
When downloading blobs (that is, when using the
GET HTTP method), you can
Range HTTP header in the request, which will result in the server
returning only the requested range of the blob.
When streaming, the
direction parameter is mandatory and indicates whether
this is an upstream (
upload) or a downstream (
namespace parameter is also accepted when streaming and all blobs in the
same stream are considered to be from the same namespace.
Local Incoming Box HTTP API¶
The local endpoint provides the following REST API for interacting with the Incoming Box service.
||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