1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
Blobs Server-side HTTP API
==========================
Soledad Server provides two different REST APIs for interacting with blobs:
* A :ref:`blobs-http-api`, providing the *Blobs* service for Soledad
Client (i.e. actual users of the infrastructure).
* A :ref:`incoming-http-api`, providing the delivery part of the
:ref:`incoming-box` service, currently used for the MX mail delivery.
Authentication is handled differently for each of the endpoints, see
:ref:`authentication` for more details.
.. _blobs-http-api:
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 ``namespace``, ``filter_flag``, ``order_by``
a flag.
``/blobs/{uuid}/{blob_id}`` ``GET`` Get the contents of a blob. ``namespace``
``/blobs/{uuid}/{blob_id}`` ``PUT`` Create a blob. The content of the ``namespace``
blob should be sent in the body
of the request.
``/blobs/{uuid}/{blob_id}`` ``POST`` Set the flags for a blob. A list ``namespace``
of flags should be sent in the
body of the request.
``/blobs/{uuid}/{blob_id}`` ``DELETE`` Delete a blob. ``namespace``
``/stream/{uuid}`` ``POST`` Stream a set of blobs. ``namespace``, ``direction``
=========================== ========== ================================= ============================================
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.
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
``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.
When downloading blobs (that is, when using the ``GET`` HTTP method), you can
send the ``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 (``download``). The
``namespace`` parameter is also accepted when streaming and all blobs in the
same stream are considered to be from the same namespace.
.. _incoming-http-api:
Local Incoming Box HTTP API
---------------------------
The *local endpoint* provides the following REST API for interacting with the
:ref:`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``.
|
