1 Pithos v2 Developer Guide
2 =========================
7 Pithos is a storage service implemented by GRNET (http://www.grnet.gr). Data is stored as objects, organized in containers, belonging to an account. This hierarchy of storage layers has been inspired by the OpenStack Object Storage (OOS) API and similar CloudFiles API by Rackspace. The Pithos API follows the OOS API as closely as possible. One of the design requirements has been to be able to use Pithos with clients built for the OOS, without changes.
9 However, to be able to take full advantage of the Pithos infrastructure, client software should be aware of the extensions that differentiate Pithos from OOS. Pithos objects can be updated, or appended to. Pithos will store sharing permissions per object and enforce corresponding authorization policies. Automatic version management, allows taking account and container listings back in time, as well as reading previous instances of objects.
11 The storage backend of Pithos is block oriented, permitting efficient, deduplicated data placement. The block structure of objects is exposed at the API layer, in order to encourage external software to implement advanced data management operations.
13 This document's goals are:
15 * Define the Pithos ReST API that allows the storage and retrieval of data and metadata via HTTP calls
16 * Specify metadata semantics and user interface guidelines for a common experience across client software implementations
18 The present document is meant to be read alongside the OOS API documentation. Thus, it is suggested that the reader is familiar with associated technologies, the OOS API as well as the first version of the Pithos API. This document refers to the second version of Pithos. Information on the first version of the storage API can be found at http://code.google.com/p/gss.
20 Whatever marked as to be determined (**TBD**), should not be considered by implementors.
25 ========================= ================================
27 ========================= ================================
28 0.8 (Dec 2, 2011) Update allowed versioning values.
29 \ Change policy/meta formatting in JSON/XML replies.
30 \ Document that all non-ASCII characters in headers should be URL-encoded.
31 0.7 (Nov 21, 2011) Suggest upload/download methods using hashmaps.
32 \ Propose syncing algorithm.
33 \ Support cross-account object copy and move.
34 \ Pass token as a request parameter when using ``POST`` via an HTML form.
35 \ Optionally use source account to update object from another object.
36 \ Use container ``POST`` to upload missing blocks of data.
37 \ Report policy in account headers.
38 \ Add insufficient quota reply.
39 \ Use special meta to always report Merkle hash.
40 0.6 (Sept 13, 2011) Reply with Merkle hash as the ETag when updating objects.
41 \ Include version id in object replace/change replies.
42 \ Change conflict (409) replies format to text.
43 \ Tags should be migrated to a meta value.
44 \ Container ``PUT`` updates metadata/policy.
45 \ Report allowed actions in shared object replies.
46 \ Provide ``https://hostname/login`` for Shibboleth authentication.
47 \ Use ``hashmap`` parameter in object ``GET``/``PUT`` to use hashmaps.
48 0.5 (July 22, 2011) Object update from another object's data.
49 \ Support object truncate.
50 \ Create object using a standard HTML form.
51 \ Purge container/object history.
52 \ List other accounts that share objects with a user.
53 \ List shared containers/objects.
54 \ Update implementation guidelines.
55 \ Check preconditions when creating/updating objects.
56 0.4 (July 01, 2011) Object permissions and account groups.
57 \ Control versioning behavior and container quotas with container policy directives.
58 \ Support updating/deleting individual metadata with ``POST``.
59 \ Create object using hashmap.
60 0.3 (June 14, 2011) Large object support with ``X-Object-Manifest``.
61 \ Allow for publicly available objects via ``https://hostname/public``.
62 \ Support time-variant account/container listings.
63 \ Add source version when duplicating with ``PUT``/``COPY``.
64 \ Request version in object ``HEAD``/``GET`` requests (list versions with ``GET``).
65 0.2 (May 31, 2011) Add object meta listing and filtering in containers.
66 \ Include underlying storage characteristics in container meta.
67 \ Support for partial object updates through ``POST``.
68 \ Expose object hashmaps through ``GET``.
69 \ Support for multi-range object ``GET`` requests.
70 0.1 (May 17, 2011) Initial release. Based on OpenStack Object Storage Developer Guide API v1 (Apr. 15, 2011).
71 ========================= ================================
73 Pithos Users and Authentication
74 -------------------------------
76 Pithos keeps separate databases for users and objects.
78 Each user is uniquely identified by the ``Uniq`` field. This should be used as the user's account in the API. The API uses the ``Token`` field to authenticate a user, thus allowing cross-account requests. All API requests require a token.
80 User entries can be modified/added via the management interface available at ``https://hostname/admin``.
82 Pithos is also compatible with Shibboleth (http://shibboleth.internet2.edu/). The connection between Shibboleth and Pithos is done by ``https://hostname/login``. An application that wishes to connect to Pithos, but does not have a token, should redirect the user to the login URI.
84 The login URI accepts the following parameters:
86 ====================== =========================
87 Request Parameter Name Value
88 ====================== =========================
89 next The URI to redirect to when the process is finished
90 renew Force token renewal (no value parameter)
91 ====================== =========================
93 The login process starts by redirecting the user to an external URI (controlled by Shibboleth), where the actual authentication credentials are entered. Then, the user is redirected back to the login URI from Shibboleth, with various identification information in the request headers.
95 If the user does not exist in the database, Pithos adds the user and creates a random token. If the user exists, the token has not expired and ``renew`` is not set, the existing token is reused. Finally, the login URI redirects to the URI provided with ``next``, adding the ``user`` and ``token`` parameters, which contain the ``Uniq`` and ``Token`` fields respectively.
100 The URI requests supported by the Pithos API follow one of the following forms:
102 * Top level: ``https://hostname/v1/``
103 * Account level: ``https://hostname/v1/<account>``
104 * Container level: ``https://hostname/v1/<account>/<container>``
105 * Object level: ``https://hostname/v1/<account>/<container>/<object>``
107 All requests must include an ``X-Auth-Token`` - as a header, or a parameter.
109 The allowable request operations and respective return codes per level are presented in the remainder of this chapter. Common to all requests are the following return codes.
111 ========================= ================================
112 Return Code Description
113 ========================= ================================
114 400 (Bad Request) The request is invalid
115 401 (Unauthorized) Missing or invalid token
116 403 (Forbidden) Request not allowed
117 404 (Not Found) The requested resource was not found
118 503 (Service Unavailable) The request cannot be completed because of an internal error
119 ========================= ================================
126 ========= ==================
127 Operation Description
128 ========= ==================
129 GET Authentication (for compatibility with the OOS API) or list allowed accounts
130 ========= ==================
135 If the ``X-Auth-User`` and ``X-Auth-Key`` headers are given, a dummy ``X-Auth-Token`` and ``X-Storage-Url`` will be replied, which can be used as a guest token/namespace for testing Pithos.
137 ================ =====================
138 Return Code Description
139 ================ =====================
140 204 (No Content) The request succeeded
141 ================ =====================
143 If an ``X-Auth-Token`` is already present, the operation will be interpreted as a request to list other accounts that share objects to the user.
145 ====================== =========================
146 Request Parameter Name Value
147 ====================== =========================
148 limit The amount of results requested (default is 10000)
149 marker Return containers with name lexicographically after marker
150 format Optional extended reply type (can be ``json`` or ``xml``)
151 ====================== =========================
153 The reply is a list of account names.
154 If a ``format=xml`` or ``format=json`` argument is given, extended information on the accounts will be returned, serialized in the chosen format.
155 For each account, the information will include the following (names will be in lower case and with hyphens replaced with underscores):
157 =========================== ============================
159 =========================== ============================
160 name The name of the account
161 last_modified The last account modification date (regardless of ``until``)
162 =========================== ============================
164 Example ``format=json`` reply:
168 [{"name": "user", "last_modified": "2011-12-02T08:10:41.565891+00:00"}, ...]
170 Example ``format=xml`` reply:
174 <?xml version="1.0" encoding="UTF-8"?>
178 <last_modified>2011-12-02T08:10:41.565891+00:00</last_modified>
180 <account>...</account>
183 =========================== =====================
184 Return Code Description
185 =========================== =====================
186 200 (OK) The request succeeded
187 204 (No Content) The user has no access to other accounts (only for non-extended replies)
188 =========================== =====================
190 Will use a ``200`` return code if the reply is of type JSON/XML.
197 ========= ==================
198 Operation Description
199 ========= ==================
200 HEAD Retrieve account metadata
202 POST Update account metadata
203 ========= ==================
208 ==================== ===========================
209 Request Header Name Value
210 ==================== ===========================
211 If-Modified-Since Retrieve if account has changed since provided timestamp
212 If-Unmodified-Since Retrieve if account has not changed since provided timestamp
213 ==================== ===========================
217 ====================== ===================================
218 Request Parameter Name Value
219 ====================== ===================================
220 until Optional timestamp
221 ====================== ===================================
223 Cross-user requests are not allowed to use ``until`` and only include the account modification date in the reply.
225 ========================== =====================
226 Reply Header Name Value
227 ========================== =====================
228 X-Account-Container-Count The total number of containers
229 X-Account-Bytes-Used The total number of bytes stored
230 X-Account-Until-Timestamp The last account modification date until the timestamp provided
231 X-Account-Group-* Optional user defined groups
232 X-Account-Policy-* Account behavior and limits
233 X-Account-Meta-* Optional user defined metadata
234 Last-Modified The last account modification date (regardless of ``until``)
235 ========================== =====================
239 ================ =====================
240 Return Code Description
241 ================ =====================
242 204 (No Content) The request succeeded
243 ================ =====================
249 ==================== ===========================
250 Request Header Name Value
251 ==================== ===========================
252 If-Modified-Since Retrieve if account has changed since provided timestamp
253 If-Unmodified-Since Retrieve if account has not changed since provided timestamp
254 ==================== ===========================
258 ====================== =========================
259 Request Parameter Name Value
260 ====================== =========================
261 limit The amount of results requested (default is 10000)
262 marker Return containers with name lexicographically after marker
263 format Optional extended reply type (can be ``json`` or ``xml``)
264 shared Show only shared containers (no value parameter)
265 until Optional timestamp
266 ====================== =========================
268 The reply is a list of container names. Account headers (as in a ``HEAD`` request) will also be included.
269 Cross-user requests are not allowed to use ``until`` and only include the account/container modification dates in the reply.
271 If a ``format=xml`` or ``format=json`` argument is given, extended information on the containers will be returned, serialized in the chosen format.
272 For each container, the information will include all container metadata (names will be in lower case and with hyphens replaced with underscores):
274 =========================== ============================
276 =========================== ============================
277 name The name of the container
278 count The number of objects inside the container
279 bytes The total size of the objects inside the container
280 last_modified The last container modification date (regardless of ``until``)
281 x_container_until_timestamp The last container modification date until the timestamp provided
282 x_container_policy_* Container behavior and limits
283 x_container_meta_* Optional user defined metadata
284 =========================== ============================
286 Example ``format=json`` reply:
293 "last_modified": "2011-12-02T08:10:41.565891+00:00",
294 "x_container_policy": {"quota": "53687091200", "versioning": "auto"},
295 "x_container_meta": {"a": "b", "1": "2"}}, ...]
297 Example ``format=xml`` reply:
301 <?xml version="1.0" encoding="UTF-8"?>
302 <account name="user">
307 <last_modified>2011-12-02T08:10:41.565891+00:00</last_modified>
309 <key>quota</key><value>53687091200</value>
310 <key>versioning</key><value>auto</value>
311 </x_container_policy>
313 <key>a</key><value>b</value>
314 <key>1</key><value>2</value>
317 <container>...</container>
320 For more examples of container details returned in JSON/XML formats refer to the OOS API documentation. In addition to the OOS API, Pithos returns all fields. Policy and metadata values are grouped and returned as key-value pairs.
322 =========================== =====================
323 Return Code Description
324 =========================== =====================
325 200 (OK) The request succeeded
326 204 (No Content) The account has no containers (only for non-extended replies)
327 304 (Not Modified) The account has not been modified
328 412 (Precondition Failed) The condition set can not be satisfied
329 =========================== =====================
331 Will use a ``200`` return code if the reply is of type JSON/XML.
337 ==================== ===========================
338 Request Header Name Value
339 ==================== ===========================
340 X-Account-Group-* Optional user defined groups
341 X-Account-Meta-* Optional user defined metadata
342 ==================== ===========================
346 ====================== ============================================
347 Request Parameter Name Value
348 ====================== ============================================
349 update Do not replace metadata/groups (no value parameter)
350 ====================== ============================================
352 No reply content/headers.
354 The operation will overwrite all user defined metadata, except if ``update`` is defined.
355 To create a group, include an ``X-Account-Group-*`` header with the name in the key and a comma separated list of user names in the value. If no ``X-Account-Group-*`` header is present, no changes will be applied to groups. The ``update`` parameter also applies to groups. To delete a specific group, use ``update`` and an empty header value.
357 ================ ===============================
358 Return Code Description
359 ================ ===============================
360 202 (Accepted) The request has been accepted
361 ================ ===============================
369 ========= ============================
370 Operation Description
371 ========= ============================
372 HEAD Retrieve container metadata
374 PUT Create/update container
375 POST Update container metadata
376 DELETE Delete container
377 ========= ============================
383 ==================== ===========================
384 Request Header Name Value
385 ==================== ===========================
386 If-Modified-Since Retrieve if container has changed since provided timestamp
387 If-Unmodified-Since Retrieve if container has not changed since provided timestamp
388 ==================== ===========================
392 ====================== ===================================
393 Request Parameter Name Value
394 ====================== ===================================
395 until Optional timestamp
396 ====================== ===================================
398 Cross-user requests are not allowed to use ``until`` and only include the container modification date in the reply.
400 =========================== ===============================
401 Reply Header Name Value
402 =========================== ===============================
403 X-Container-Object-Count The total number of objects in the container
404 X-Container-Bytes-Used The total number of bytes of all objects stored
405 X-Container-Block-Size The block size used by the storage backend
406 X-Container-Block-Hash The hash algorithm used for block identifiers in object hashmaps
407 X-Container-Until-Timestamp The last container modification date until the timestamp provided
408 X-Container-Object-Meta A list with all meta keys used by objects (**TBD**)
409 X-Container-Policy-* Container behavior and limits
410 X-Container-Meta-* Optional user defined metadata
411 Last-Modified The last container modification date (regardless of ``until``)
412 =========================== ===============================
414 The keys returned in ``X-Container-Object-Meta`` are all the unique strings after the ``X-Object-Meta-`` prefix, formatted as a comma-separated list. See container ``PUT`` for a reference of policy directives. (**TBD**)
416 ================ ===============================
417 Return Code Description
418 ================ ===============================
419 204 (No Content) The request succeeded
420 ================ ===============================
426 ==================== ===========================
427 Request Header Name Value
428 ==================== ===========================
429 If-Modified-Since Retrieve if container has changed since provided timestamp
430 If-Unmodified-Since Retrieve if container has not changed since provided timestamp
431 ==================== ===========================
435 ====================== ===================================
436 Request Parameter Name Value
437 ====================== ===================================
438 limit The amount of results requested (default is 10000)
439 marker Return containers with name lexicographically after marker
440 prefix Return objects starting with prefix
441 delimiter Return objects up to the delimiter (discussion follows)
442 path Assume ``prefix=path`` and ``delimiter=/``
443 format Optional extended reply type (can be ``json`` or ``xml``)
444 meta Return objects having the specified meta keys (can be a comma separated list)
445 shared Show only shared objects (no value parameter)
446 until Optional timestamp
447 ====================== ===================================
449 The ``path`` parameter overrides ``prefix`` and ``delimiter``. When using ``path``, results will include objects ending in ``delimiter``.
451 The keys given with ``meta`` will be matched with the strings after the ``X-Object-Meta-`` prefix.
453 The reply is a list of object names. Container headers (as in a ``HEAD`` request) will also be included.
454 Cross-user requests are not allowed to use ``until`` and include the following limited set of headers in the reply:
456 =========================== ===============================
457 Reply Header Name Value
458 =========================== ===============================
459 X-Container-Block-Size The block size used by the storage backend
460 X-Container-Block-Hash The hash algorithm used for block identifiers in object hashmaps
461 X-Container-Object-Meta A list with all meta keys used by allowed objects (**TBD**)
462 Last-Modified The last container modification date
463 =========================== ===============================
465 If a ``format=xml`` or ``format=json`` argument is given, extended information on the objects will be returned, serialized in the chosen format.
466 For each object, the information will include all object metadata (names will be in lower case and with hyphens replaced with underscores):
468 ========================== ======================================
470 ========================== ======================================
471 name The name of the object
472 hash The ETag of the object
473 bytes The size of the object
474 content_type The MIME content type of the object
475 content_encoding The encoding of the object (optional)
476 content-disposition The presentation style of the object (optional)
477 last_modified The last object modification date (regardless of version)
478 x_object_hash The Merkle hash
479 x_object_version The object's version identifier
480 x_object_version_timestamp The object's version timestamp
481 x_object_modified_by The user that committed the object's version
482 x_object_manifest Object parts prefix in ``<container>/<object>`` form (optional)
483 x_object_sharing Object permissions (optional)
484 x_object_shared_by Object inheriting permissions (optional)
485 x_object_allowed_to Allowed actions on object (optional)
486 x_object_public Object's publicly accessible URI (optional)
487 x_object_meta_* Optional user defined metadata
488 ========================== ======================================
490 Extended replies may also include virtual directory markers in separate sections of the ``json`` or ``xml`` results.
491 Virtual directory markers are only included when ``delimiter`` is explicitly set. They correspond to the substrings up to and including the first occurrence of the delimiter.
492 In JSON results they appear as dictionaries with only a ``"subdir"`` key. In XML results they appear interleaved with ``<object>`` tags as ``<subdir name="..." />``.
493 In case there is an object with the same name as a virtual directory marker, the object will be returned.
495 Example ``format=json`` reply:
501 "hash": "d41d8cd98f00b204e9800998ecf8427e",
502 "content_type": "application/octet-stream",
503 "last_modified": "2011-12-02T08:10:41.565891+00:00",
504 "x_object_meta": {"asdf": "qwerty"},
505 "x_object_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
506 "x_object_version": 98,
507 "x_object_version_timestamp": "1322813441.565891",
508 "x_object_modified_by": "user"}, ...]
510 Example ``format=xml`` reply:
514 <?xml version="1.0" encoding="UTF-8"?>
515 <container name="pithos">
519 <hash>d41d8cd98f00b204e9800998ecf8427e</hash>
520 <content_type>application/octet-stream</content_type>
521 <last_modified>2011-12-02T08:10:41.565891+00:00</last_modified>
523 <key>asdf</key><value>qwerty</value>
525 <x_object_hash>e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855</x_object_hash>
526 <x_object_version>98</x_object_version>
527 <x_object_version_timestamp>1322813441.565891</x_object_version_timestamp>
528 <x_object_modified_by>chazapis</x_object_modified_by>
533 For more examples of container details returned in JSON/XML formats refer to the OOS API documentation. In addition to the OOS API, Pithos returns all fields. Metadata values are grouped and returned as key-value pairs.
535 =========================== ===============================
536 Return Code Description
537 =========================== ===============================
538 200 (OK) The request succeeded
539 204 (No Content) The account has no containers (only for non-extended replies)
540 304 (Not Modified) The container has not been modified
541 412 (Precondition Failed) The condition set can not be satisfied
542 =========================== ===============================
544 Will use a ``200`` return code if the reply is of type JSON/XML.
550 ==================== ================================
551 Request Header Name Value
552 ==================== ================================
553 X-Container-Policy-* Container behavior and limits
554 X-Container-Meta-* Optional user defined metadata
555 ==================== ================================
557 No reply content/headers.
559 If no policy is defined, the container will be created with the default values.
560 Available policy directives:
562 * ``versioning``: Set to ``auto`` or ``none`` (default is ``auto``)
563 * ``quota``: Size limit in KB (default is ``0`` - unlimited)
565 If the container already exists, the operation is equal to a ``POST`` with ``update`` defined.
567 ================ ===============================
568 Return Code Description
569 ================ ===============================
570 201 (Created) The container has been created
571 202 (Accepted) The request has been accepted
572 ================ ===============================
578 ==================== ================================
579 Request Header Name Value
580 ==================== ================================
581 Content-Length The size of the supplied data (optional, to upload)
582 Content-Type The MIME content type of the supplied data (optional, to upload)
583 Transfer-Encoding Set to ``chunked`` to specify incremental uploading (if used, ``Content-Length`` is ignored)
584 X-Container-Policy-* Container behavior and limits
585 X-Container-Meta-* Optional user defined metadata
586 ==================== ================================
590 ====================== ============================================
591 Request Parameter Name Value
592 ====================== ============================================
593 update Do not replace metadata/policy (no value parameter)
594 ====================== ============================================
596 No reply content/headers, except when uploading data, where the reply consists of a list of hashes for the blocks received (in a simple text format, with one hash per line).
598 The operation will overwrite all user defined metadata, except if ``update`` is defined.
599 To change policy, include an ``X-Container-Policy-*`` header with the name in the key. If no ``X-Container-Policy-*`` header is present, no changes will be applied to policy. The ``update`` parameter also applies to policy - deleted values will revert to defaults. To delete/revert a specific policy directive, use ``update`` and an empty header value. See container ``PUT`` for a reference of policy directives.
601 To upload blocks of data to the container, set ``Content-Type`` to ``application/octet-stream`` and ``Content-Length`` to a valid value (except if using ``chunked`` as the ``Transfer-Encoding``).
603 ================ ===============================
604 Return Code Description
605 ================ ===============================
606 202 (Accepted) The request has been accepted
607 ================ ===============================
613 ====================== ===================================
614 Request Parameter Name Value
615 ====================== ===================================
616 until Optional timestamp
617 ====================== ===================================
619 If ``until`` is defined, the container is "purged" up to that time (the history of all objects up to then is deleted).
621 No reply content/headers.
623 ================ ===============================
624 Return Code Description
625 ================ ===============================
626 204 (No Content) The request succeeded
627 409 (Conflict) The container is not empty
628 ================ ===============================
636 ========= =================================
637 Operation Description
638 ========= =================================
639 HEAD Retrieve object metadata
641 PUT Write object data or copy/move object
644 POST Update object metadata/data
646 ========= =================================
652 ==================== ================================
653 Request Header Name Value
654 ==================== ================================
655 If-Match Retrieve if ETags match
656 If-None-Match Retrieve if ETags don't match
657 If-Modified-Since Retrieve if object has changed since provided timestamp
658 If-Unmodified-Since Retrieve if object has not changed since provided timestamp
659 ==================== ================================
663 ====================== ===================================
664 Request Parameter Name Value
665 ====================== ===================================
666 version Optional version identifier
667 ====================== ===================================
671 ========================== ===============================
672 Reply Header Name Value
673 ========================== ===============================
674 ETag The ETag of the object
675 Content-Length The size of the object
676 Content-Type The MIME content type of the object
677 Last-Modified The last object modification date (regardless of version)
678 Content-Encoding The encoding of the object (optional)
679 Content-Disposition The presentation style of the object (optional)
680 X-Object-Hash The Merkle hash
681 X-Object-Version The object's version identifier
682 X-Object-Version-Timestamp The object's version timestamp
683 X-Object-Modified-By The user that comitted the object's version
684 X-Object-Manifest Object parts prefix in ``<container>/<object>`` form (optional)
685 X-Object-Sharing Object permissions (optional)
686 X-Object-Shared-By Object inheriting permissions (optional)
687 X-Object-Allowed-To Allowed actions on object (optional)
688 X-Object-Public Object's publicly accessible URI (optional)
689 X-Object-Meta-* Optional user defined metadata
690 ========================== ===============================
694 ================ ===============================
695 Return Code Description
696 ================ ===============================
697 200 (No Content) The request succeeded
698 ================ ===============================
704 ==================== ================================
705 Request Header Name Value
706 ==================== ================================
707 Range Optional range of data to retrieve
708 If-Range Retrieve the missing part if entity is unchanged; otherwise, retrieve the entire new entity (used together with Range header)
709 If-Match Retrieve if ETags match
710 If-None-Match Retrieve if ETags don't match
711 If-Modified-Since Retrieve if object has changed since provided timestamp
712 If-Unmodified-Since Retrieve if object has not changed since provided timestamp
713 ==================== ================================
717 ====================== ===================================
718 Request Parameter Name Value
719 ====================== ===================================
720 format Optional extended reply type (can be ``json`` or ``xml``)
721 hashmap Optional request for hashmap (no value parameter)
722 version Optional version identifier or ``list`` (specify a format if requesting a list)
723 ====================== ===================================
725 The reply is the object's data (or part of it), except if a hashmap is requested with ``hashmap``, or a version list with ``version=list`` (in both cases an extended reply format must be specified). Object headers (as in a ``HEAD`` request) are always included.
727 Hashmaps expose the underlying storage format of the object. Note that each hash is computed after trimming trailing null bytes of the corresponding block.
729 Example ``format=json`` reply:
733 {"block_hash": "sha1", "hashes": ["7295c41da03d7f916440b98e32c4a2a39351546c", ...], "block_size": 131072, "bytes": 242}
735 Example ``format=xml`` reply:
739 <?xml version="1.0" encoding="UTF-8"?>
740 <object name="file" bytes="24223726" block_size="131072" block_hash="sha1">
741 <hash>7295c41da03d7f916440b98e32c4a2a39351546c</hash>
745 Version lists include the version identifier and timestamp for each available object version. Version identifiers can be arbitrary strings, so use the timestamp to find newer versions.
747 Example ``format=json`` reply:
751 {"versions": [[85, "1322734861.248469"], [86, "1322734905.009272"], ...]}
753 Example ``format=xml`` reply:
757 <?xml version="1.0" encoding="UTF-8"?>
759 <version timestamp="1322734861.248469">85</version>
760 <version timestamp="1322734905.009272">86</version>
761 <version timestamp="...">...</version>
764 The ``Range`` header may include multiple ranges, as outlined in RFC2616. Then the ``Content-Type`` of the reply will be ``multipart/byteranges`` and each part will include a ``Content-Range`` header.
766 ========================== ===============================
767 Reply Header Name Value
768 ========================== ===============================
769 ETag The ETag of the object
770 Content-Length The size of the data returned
771 Content-Type The MIME content type of the object
772 Content-Range The range of data included (only on a single range request)
773 Last-Modified The last object modification date (regardless of version)
774 Content-Encoding The encoding of the object (optional)
775 Content-Disposition The presentation style of the object (optional)
776 X-Object-Hash The Merkle hash
777 X-Object-Version The object's version identifier
778 X-Object-Version-Timestamp The object's version timestamp
779 X-Object-Modified-By The user that comitted the object's version
780 X-Object-Manifest Object parts prefix in ``<container>/<object>`` form (optional)
781 X-Object-Sharing Object permissions (optional)
782 X-Object-Shared-By Object inheriting permissions (optional)
783 X-Object-Allowed-To Allowed actions on object (optional)
784 X-Object-Public Object's publicly accessible URI (optional)
785 X-Object-Meta-* Optional user defined metadata
786 ========================== ===============================
790 =========================== ==============================
791 Return Code Description
792 =========================== ==============================
793 200 (OK) The request succeeded
794 206 (Partial Content) The range request succeeded
795 304 (Not Modified) The object has not been modified
796 412 (Precondition Failed) The condition set can not be satisfied
797 416 (Range Not Satisfiable) The requested range is out of limits
798 =========================== ==============================
804 ==================== ================================
805 Request Header Name Value
806 ==================== ================================
807 If-Match Put if ETags match with current object
808 If-None-Match Put if ETags don't match with current object
809 ETag The MD5 hash of the object (optional to check written data)
810 Content-Length The size of the data written
811 Content-Type The MIME content type of the object
812 Transfer-Encoding Set to ``chunked`` to specify incremental uploading (if used, ``Content-Length`` is ignored)
813 X-Copy-From The source path in the form ``/<container>/<object>``
814 X-Move-From The source path in the form ``/<container>/<object>``
815 X-Source-Account The source account to copy/move from
816 X-Source-Version The source version to copy from
817 Content-Encoding The encoding of the object (optional)
818 Content-Disposition The presentation style of the object (optional)
819 X-Object-Manifest Object parts prefix in ``<container>/<object>`` form (optional)
820 X-Object-Sharing Object permissions (optional)
821 X-Object-Public Object is publicly accessible (optional)
822 X-Object-Meta-* Optional user defined metadata
823 ==================== ================================
827 ====================== ===================================
828 Request Parameter Name Value
829 ====================== ===================================
830 format Optional extended request type (can be ``json`` or ``xml``)
831 hashmap Optional hashmap provided instead of data (no value parameter)
832 ====================== ===================================
834 The request is the object's data (or part of it), except if a hashmap is provided (using ``hashmap`` and ``format`` parameters). If using a hashmap and all different parts are stored in the server, the object is created, otherwise the server returns Conflict (409) with the list of the missing parts (in a simple text format, with one hash per line).
836 Hashmaps should be formatted as outlined in ``GET``.
838 ========================== ===============================
839 Reply Header Name Value
840 ========================== ===============================
841 ETag The MD5 hash of the object (on create)
842 X-Object-Version The object's new version
843 ========================== ===============================
845 The ``X-Object-Sharing`` header may include either a ``read=...`` comma-separated user/group list, or a ``write=...`` comma-separated user/group list, or both separated by a semicolon (``;``). Groups are specified as ``<account>:<group>``. To publish the object, set ``X-Object-Public`` to ``true``. To unpublish, set to ``false``, or use an empty header value.
847 ============================== ==============================
848 Return Code Description
849 ============================== ==============================
850 201 (Created) The object has been created
851 409 (Conflict) The object can not be created from the provided hashmap, or there are conflicting permissions (a list of missing hashes, or a list of conflicting sharing paths will be included in the reply - in simple text format)
852 411 (Length Required) Missing ``Content-Length`` or ``Content-Type`` in the request
853 413 (Request Entity Too Large) Insufficient quota to complete the request
854 422 (Unprocessable Entity) The MD5 checksum of the data written to the storage system does not match the (optionally) supplied ETag value
855 ============================== ==============================
861 ==================== ================================
862 Request Header Name Value
863 ==================== ================================
864 If-Match Proceed if ETags match with object
865 If-None-Match Proceed if ETags don't match with object
866 Destination The destination path in the form ``/<container>/<object>``
867 Destination-Account The destination account to copy to
868 Content-Type The MIME content type of the object (optional)
869 Content-Encoding The encoding of the object (optional)
870 Content-Disposition The presentation style of the object (optional)
871 X-Source-Version The source version to copy from
872 X-Object-Manifest Object parts prefix in ``<container>/<object>`` form (optional)
873 X-Object-Sharing Object permissions (optional)
874 X-Object-Public Object is publicly accessible (optional)
875 X-Object-Meta-* Optional user defined metadata
876 ==================== ================================
878 Refer to ``PUT``/``POST`` for a description of request headers. Metadata is also copied, updated with any values defined. Sharing/publishing options are not copied.
880 ========================== ===============================
881 Reply Header Name Value
882 ========================== ===============================
883 X-Object-Version The object's new version
884 ========================== ===============================
888 ============================== ==============================
889 Return Code Description
890 ============================== ==============================
891 201 (Created) The object has been created
892 409 (Conflict) There are conflicting permissions (a list of conflicting sharing paths will be included in the reply - in simple text format)
893 413 (Request Entity Too Large) Insufficient quota to complete the request
894 ============================== ==============================
900 Same as ``COPY``, without the ``X-Source-Version`` request header. The ``MOVE`` operation is always applied on the latest version.
906 ==================== ================================
907 Request Header Name Value
908 ==================== ================================
909 If-Match Proceed if ETags match with object
910 If-None-Match Proceed if ETags don't match with object
911 Content-Length The size of the data written (optional, to update)
912 Content-Type The MIME content type of the object (optional, to update)
913 Content-Range The range of data supplied (optional, to update)
914 Transfer-Encoding Set to ``chunked`` to specify incremental uploading (if used, ``Content-Length`` is ignored)
915 Content-Encoding The encoding of the object (optional)
916 Content-Disposition The presentation style of the object (optional)
917 X-Source-Object Update with data from the object at path ``/<container>/<object>`` (optional, to update)
918 X-Source-Account The source account to update from
919 X-Source-Version The source version to update from (optional, to update)
920 X-Object-Bytes The updated object's final size (optional, when updating)
921 X-Object-Manifest Object parts prefix in ``<container>/<object>`` form (optional)
922 X-Object-Sharing Object permissions (optional)
923 X-Object-Public Object is publicly accessible (optional)
924 X-Object-Meta-* Optional user defined metadata
925 ==================== ================================
929 ====================== ============================================
930 Request Parameter Name Value
931 ====================== ============================================
932 update Do not replace metadata (no value parameter)
933 ====================== ============================================
935 The ``Content-Encoding``, ``Content-Disposition``, ``X-Object-Manifest`` and ``X-Object-Meta-*`` headers are considered to be user defined metadata. An operation without the ``update`` parameter will overwrite all previous values and remove any keys not supplied. When using ``update`` any metadata with an empty value will be deleted.
937 To change permissions, include an ``X-Object-Sharing`` header (as defined in ``PUT``). To publish, include an ``X-Object-Public`` header, with a value of ``true``. If no such headers are defined, no changes will be applied to sharing/public. Use empty values to remove permissions/unpublish (unpublishing also works with ``false`` as a header value). Sharing options are applied to the object - not its versions.
939 To update an object's data:
941 * Either set ``Content-Type`` to ``application/octet-stream``, or provide an object with ``X-Source-Object``. If ``Content-Type`` has some other value, it will be ignored and only the metadata will be updated.
942 * If the data is supplied in the request (using ``Content-Type`` instead of ``X-Source-Object``), a valid ``Content-Length`` header is required - except if using chunked transfers (set ``Transfer-Encoding`` to ``chunked``).
943 * Set ``Content-Range`` as specified in RFC2616, with the following differences:
945 * Client software MAY omit ``last-byte-pos`` of if the length of the range being transferred is unknown or difficult to determine.
946 * Client software SHOULD not specify the ``instance-length`` (use a ``*``), unless there is a reason for performing a size check at the server.
947 * If ``Content-Range`` used has a ``byte-range-resp-spec = *``, data will be appended to the object.
949 Optionally, truncate the updated object to the desired length with the ``X-Object-Bytes`` header.
951 A data update will trigger an ETag change. Updated ETags correspond to the single Merkle hash of the object's hashmap (refer to http://bittorrent.org/beps/bep_0030.html for more information).
953 No reply content. No reply headers if only metadata is updated.
955 ========================== ===============================
956 Reply Header Name Value
957 ========================== ===============================
958 ETag The new ETag of the object (data updated)
959 X-Object-Version The object's new version
960 ========================== ===============================
964 ============================== ==============================
965 Return Code Description
966 ============================== ==============================
967 202 (Accepted) The request has been accepted (not a data update)
968 204 (No Content) The request succeeded (data updated)
969 409 (Conflict) There are conflicting permissions (a list of conflicting sharing paths will be included in the reply - in simple text format)
970 411 (Length Required) Missing ``Content-Length`` in the request
971 413 (Request Entity Too Large) Insufficient quota to complete the request
972 416 (Range Not Satisfiable) The supplied range is invalid
973 ============================== ==============================
975 The ``POST`` method can also be used for creating an object via a standard HTML form. If the request ``Content-Type`` is ``multipart/form-data``, none of the above headers will be processed. The form should have an ``X-Object-Data`` field, as in the following example. The token is passed as a request parameter. ::
977 <form method="post" action="https://pithos.dev.grnet.gr/v1/user/folder/EXAMPLE.txt?X-Auth-Token=0000" enctype="multipart/form-data">
978 <input type="file" name="X-Object-Data">
979 <input type="submit">
982 This will create/override the object with the given name, as if using ``PUT``. The ``Content-Type`` of the object will be set to the value of the corresponding header sent in the part of the request containing the data (usually, automatically handled by the browser). Metadata, sharing and other object attributes can not be set this way.
984 ========================== ===============================
985 Reply Header Name Value
986 ========================== ===============================
987 ETag The MD5 hash of the object
988 X-Object-Version The object's new version
989 ========================== ===============================
993 ============================== ==============================
994 Return Code Description
995 ============================== ==============================
996 201 (Created) The object has been created
997 413 (Request Entity Too Large) Insufficient quota to complete the request
998 ============================== ==============================
1004 ====================== ===================================
1005 Request Parameter Name Value
1006 ====================== ===================================
1007 until Optional timestamp
1008 ====================== ===================================
1010 If ``until`` is defined, the object is "purged" up to that time (the history up to then is deleted).
1012 No reply content/headers.
1014 =========================== ==============================
1015 Return Code Description
1016 =========================== ==============================
1017 204 (No Content) The request succeeded
1018 =========================== ==============================
1020 Sharing and Public Objects
1021 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1023 Read and write control in Pithos is managed by setting appropriate permissions with the ``X-Object-Sharing`` header. The permissions are applied using prefix-based inheritance. Thus, each set of authorization directives is applied to all objects sharing the same prefix with the object where the corresponding ``X-Object-Sharing`` header is defined. For simplicity, nested/overlapping permissions are not allowed. Setting ``X-Object-Sharing`` will fail, if the object is already "covered", or another object with a longer common-prefix name already has permissions. When retrieving an object, the ``X-Object-Shared-By`` header reports where it gets its permissions from. If not present, the object is the actual source of authorization directives.
1025 A user may ``GET`` another account or container. The result will include a limited reply, containing only the allowed containers or objects respectively. A top-level request with an authentication token, will return a list of allowed accounts, so the user can easily find out which other users share objects. The ``X-Object-Allowed-To`` header lists the actions allowed on an object, if it does not belong to the requesting user.
1027 Objects that are marked as public, via the ``X-Object-Public`` meta, are also available at the corresponding URI returned for ``HEAD`` or ``GET``. Requests for public objects do not need to include an ``X-Auth-Token``. Pithos will ignore request parameters and only include the following headers in the reply (all ``X-Object-*`` meta is hidden):
1029 ========================== ===============================
1030 Reply Header Name Value
1031 ========================== ===============================
1032 ETag The ETag of the object
1033 Content-Length The size of the data returned
1034 Content-Type The MIME content type of the object
1035 Content-Range The range of data included (only on a single range request)
1036 Last-Modified The last object modification date (regardless of version)
1037 Content-Encoding The encoding of the object (optional)
1038 Content-Disposition The presentation style of the object (optional)
1039 ========================== ===============================
1041 Public objects are not included and do not influence cross-user listings. They are, however, readable by all users.
1046 List of differences from the OOS API:
1048 * Support for ``X-Account-Meta-*`` style headers at the account level. Use ``POST`` to update.
1049 * Support for ``X-Container-Meta-*`` style headers at the container level. Can be set when creating via ``PUT``. Use ``POST`` to update.
1050 * Header ``X-Container-Object-Meta`` at the container level and parameter ``meta`` in container listings. (**TBD**)
1051 * Account and container policies to manage behavior and limits. Container behavior overrides account settings. Account quota sets the maximum bytes limit, regardless of container values.
1052 * Headers ``X-Container-Block-*`` at the container level, exposing the underlying storage characteristics.
1053 * All metadata replies, at all levels, include latest modification information.
1054 * At all levels, a ``HEAD`` or ``GET`` request may use ``If-Modified-Since`` and ``If-Unmodified-Since`` headers.
1055 * Container/object lists include all associated metadata if the reply is of type JSON/XML. Some names are kept to their OOS API equivalents for compatibility.
1056 * Option to include only shared containers/objects in listings.
1057 * Object metadata allowed, in addition to ``X-Object-Meta-*``: ``Content-Encoding``, ``Content-Disposition``, ``X-Object-Manifest``. These are all replaced with every update operation, except if using the ``update`` parameter (in which case individual keys can also be deleted). Deleting meta by providing empty values also works when copying/moving an object.
1058 * Multi-range object ``GET`` support as outlined in RFC2616.
1059 * Object hashmap retrieval through ``GET`` and the ``format`` parameter.
1060 * Object create via hashmap through ``PUT`` and the ``format`` parameter.
1061 * The object's Merkle hash is always returned in the ``X-Object-Hash`` header.
1062 * Object create using ``POST`` to support standard HTML forms.
1063 * Partial object updates through ``POST``, using the ``Content-Length``, ``Content-Type``, ``Content-Range`` and ``Transfer-Encoding`` headers. Use another object's data to update with ``X-Source-Object`` and ``X-Source-Version``. Truncate with ``X-Object-Bytes``. New ETag corresponds to the Merkle hash of the object's hashmap.
1064 * Include new version identifier in replies for object replace/change requests.
1065 * Object ``MOVE`` support.
1066 * Conditional object create/update operations, using ``If-Match`` and ``If-None-Match`` headers.
1067 * Time-variant account/container listings via the ``until`` parameter.
1068 * Object versions - parameter ``version`` in ``HEAD``/``GET`` (list versions with ``GET``), ``X-Object-Version-*`` meta in replies, ``X-Source-Version`` in ``PUT``/``COPY``.
1069 * Sharing/publishing with ``X-Object-Sharing``, ``X-Object-Public`` at the object level. Cross-user operations are allowed - controlled by sharing directives. Available actions in cross-user requests are reported with ``X-Object-Allowed-To``. Permissions may include groups defined with ``X-Account-Group-*`` at the account level. These apply to the object - not its versions.
1070 * Support for prefix-based inheritance when enforcing permissions. Parent object carrying the authorization directives is reported in ``X-Object-Shared-By``.
1071 * Copy and move between accounts with ``X-Source-Account`` and ``Destination-Account`` headers.
1072 * Large object support with ``X-Object-Manifest``.
1073 * Trace the user that created/modified an object with ``X-Object-Modified-By``.
1074 * Purge container/object history with the ``until`` parameter in ``DELETE``.
1076 Clarifications/suggestions:
1078 * All non-ASCII characters in headers should be URL-encoded.
1079 * Authentication is done by another system. The token is used in the same way, but it is obtained differently. The top level ``GET`` request is kept compatible with the OOS API and allows for guest/testing operations.
1080 * Some processing is done in the variable part of all ``X-*-Meta-*`` headers. If it includes underscores, they will be converted to dashes and the first letter of all intra-dash strings will be capitalized.
1081 * A ``GET`` reply for a level will include all headers of the corresponding ``HEAD`` request.
1082 * To avoid conflicts between objects and virtual directory markers in container listings, it is recommended that object names do not end with the delimiter used.
1083 * The ``Accept`` header may be used in requests instead of the ``format`` parameter to specify the desired request/reply format. The parameter overrides the header.
1084 * Container/object lists use a ``200`` return code if the reply is of type JSON/XML. The reply will include an empty JSON/XML.
1085 * In headers, dates are formatted according to RFC 1123. In extended information listings, the ``last_modified`` field is formatted according to ISO 8601 (for OOS API compatibility). All other fields (Pithos extensions) use integer tiemstamps.
1086 * The ``Last-Modified`` header value always reflects the actual latest change timestamp, regardless of time control parameters and version requests. Time precondition checks with ``If-Modified-Since`` and ``If-Unmodified-Since`` headers are applied to this value.
1087 * A copy/move using ``PUT``/``COPY``/``MOVE`` will always update metadata, keeping all old values except the ones redefined in the request headers.
1088 * A ``HEAD`` or ``GET`` for an ``X-Object-Manifest`` object, will include modified ``Content-Length`` and ``ETag`` headers, according to the characteristics of the objects under the specified prefix. The ``Etag`` will be the MD5 hash of the corresponding ETags concatenated. In extended container listings there is no metadata processing.
1096 Hopefully this API will allow for a multitude of client implementations, each supporting a different device or operating system. All clients will be able to manipulate containers and objects - even software only designed for OOS API compatibility. But a Pithos interface should not be only about showing containers and folders. There are some extra user interface elements and functionalities that should be common to all implementations.
1098 Upon entrance to the service, a user is presented with the following elements - which can be represented as folders or with other related icons:
1100 * The ``home`` element, which is used as the default entry point to the user's "files". Objects under ``home`` are represented in the usual hierarchical organization of folders and files.
1101 * The ``trash`` element, which contains files that have been marked for deletion, but can still be recovered.
1102 * The ``shared`` element, which contains all objects shared by the user to other users of the system.
1103 * The ``others`` element, which contains all objects that other users share with the user.
1104 * The ``groups`` element, which contains the names of groups the user has defined. Each group consists of a user list. Group creation, deletion, and manipulation is carried out by actions originating here.
1105 * The ``history`` element, which allows browsing past instances of ``home`` and - optionally - ``trash``.
1107 Objects in Pithos can be:
1109 * Moved to trash and then deleted.
1110 * Shared with specific permissions.
1111 * Made public (shared with non-Pithos users).
1112 * Restored from previous versions.
1114 Some of these functions are performed by the client software and some by the Pithos server.
1116 In the first version of Pithos, objects could also be assigned custom tags. This is no longer supported. Existing deployments can migrate tags into a specific metadata value, i.e. ``X-Object-Meta-Tags``.
1118 Implementation Guidelines
1119 ^^^^^^^^^^^^^^^^^^^^^^^^^
1121 Pithos clients should use the ``pithos`` and ``trash`` containers for active and inactive objects respectively. If any of these containers is not found, the client software should create it, without interrupting the user's workflow. The ``home`` element corresponds to ``pithos`` and the ``trash`` element to ``trash``. Use ``PUT`` with the ``X-Move-From`` header, or ``MOVE`` to transfer objects from one container to the other. Use ``DELETE`` to remove from ``pithos`` without trashing, or to remove from ``trash``. When moving objects, detect naming conflicts with the ``If-Match`` or ``If-None-Match`` headers. Such conflicts should be resolved by the user.
1123 Object names should use the ``/`` delimiter to impose a hierarchy of folders and files.
1125 The ``shared`` element should be implemented as a read-only view of the ``pithos`` container, using the ``shared`` parameter when listing objects. The ``others`` element, should start with a top-level ``GET`` to retrieve the list of accounts accessible to the user. It is suggested that the client software hides the next step of navigation - the container - if it only includes ``pithos`` and forwards the user directly to the objects.
1127 Public objects are not included in ``shared`` and ``others`` listings. It is suggested that they are marked in a visually distinctive way in ``pithos`` listings (for example using an icon overlay).
1129 A special application menu, or a section in application preferences, should be devoted to managing groups (the ``groups`` element). All group-related actions are implemented at the account level.
1131 Browsing past versions of objects should be available both at the object and the container level. At the object level, a list of past versions can be included in the screen showing details or more information on the object (metadata, permissions, etc.). At the container level, it is suggested that clients use a ``history`` element, which presents to the user a read-only, time-variable view of ``pithos`` contents. This can be accomplished via the ``until`` parameter in listings. Optionally, ``history`` may include ``trash``.
1133 Uploading and downloading data
1134 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1136 By using hashmaps to upload and download objects the corresponding operations can complete much faster.
1138 In the case of an upload, only the missing blocks will be submitted to the server:
1140 * Calculate the hash value for each block of the object to be uploaded. Use the hash algorithm and block size of the destination container.
1141 * Send a hashmap ``PUT`` request for the object.
1143 * Server responds with status ``201`` (Created):
1145 * Blocks are already on the server. The object has been created. Done.
1147 * Server responds with status ``409`` (Conflict):
1149 * Server's response body contains the hashes of the blocks that do not exist on the server.
1150 * For each hash value in the server's response (or all hashes together):
1152 * Send a ``POST`` request to the destination container with the corresponding data.
1154 * Repeat hashmap ``PUT``. Fail if the server's response is not ``201``.
1156 Consulting hashmaps when downloading allows for resuming partially transferred objects. The client should retrieve the hashmap from the server and compare it with the hashmap computed from the respective local file. Any missing parts can be downloaded with ``GET`` requests with the additional ``Range`` header.
1161 Consider the following algorithm for synchronizing a local folder with the server. The "state" is the complete object listing, with the corresponding attributes.
1165 L: local state (stored state from last sync with the server)
1166 C: current state (state computed right before sync)
1172 # No remote changes, nothing to do
1174 # Update local state to match that of the server
1177 # We have local changes
1179 # No remote changes, update the server
1183 # Both we and server have changes
1185 # We were lucky, we did the same change
1188 # We have conflicting changes
1193 * States represent file hashes (either MD5 or Merkle). Deleted or non-existing files are assumed to have a magic hash (e.g. empty string).
1194 * Updating a state (either local or remote) implies downloading, uploading or deleting the appropriate file.
1196 Recommended Practices and Examples
1197 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1199 Assuming an authentication token is obtained, the following high-level operations are available - shown with ``curl``:
1201 * Get account information ::
1204 -H "X-Auth-Token: 0000" \
1205 https://pithos.dev.grnet.gr/v1/user
1207 * List available containers ::
1210 -H "X-Auth-Token: 0000" \
1211 https://pithos.dev.grnet.gr/v1/user
1213 * Get container information ::
1216 -H "X-Auth-Token: 0000" \
1217 https://pithos.dev.grnet.gr/v1/user/pithos
1219 * Add a new container ::
1222 -H "X-Auth-Token: 0000" \
1223 https://pithos.dev.grnet.gr/v1/user/test
1225 * Delete a container ::
1227 curl -X DELETE -D - \
1228 -H "X-Auth-Token: 0000" \
1229 https://pithos.dev.grnet.gr/v1/user/test
1231 * List objects in a container ::
1234 -H "X-Auth-Token: 0000" \
1235 https://pithos.dev.grnet.gr/v1/user/pithos
1237 * List objects in a container (extended reply) ::
1240 -H "X-Auth-Token: 0000" \
1241 https://pithos.dev.grnet.gr/v1/user/pithos?format=json
1243 It is recommended that extended replies are cached and subsequent requests utilize the ``If-Modified-Since`` header.
1245 * List metadata keys used by objects in a container
1247 Will be in the ``X-Container-Object-Meta`` reply header, included in container information or object list (``HEAD`` or ``GET``). (**TBD**)
1249 * List objects in a container having a specific meta defined ::
1252 -H "X-Auth-Token: 0000" \
1253 https://pithos.dev.grnet.gr/v1/user/pithos?meta=favorites
1255 * Retrieve an object ::
1258 -H "X-Auth-Token: 0000" \
1259 https://pithos.dev.grnet.gr/v1/user/pithos/README.txt
1261 * Retrieve an object (specific ranges of data) ::
1264 -H "X-Auth-Token: 0000" \
1265 -H "Range: bytes=0-9" \
1266 https://pithos.dev.grnet.gr/v1/user/pithos/README.txt
1268 This will return the first 10 bytes. To get the first 10, bytes 30-39 and the last 100 use ``Range: bytes=0-9,30-39,-100``.
1270 * Add a new object (folder type) (**TBD**) ::
1273 -H "X-Auth-Token: 0000" \
1274 -H "Content-Type: application/directory" \
1275 https://pithos.dev.grnet.gr/v1/user/pithos/folder
1277 * Add a new object ::
1280 -H "X-Auth-Token: 0000" \
1281 -H "Content-Type: text/plain" \
1283 https://pithos.dev.grnet.gr/v1/user/pithos/folder/EXAMPLE.txt
1285 * Update an object ::
1288 -H "X-Auth-Token: 0000" \
1289 -H "Content-Length: 10" \
1290 -H "Content-Type: application/octet-stream" \
1291 -H "Content-Range: bytes 10-19/*" \
1293 https://pithos.dev.grnet.gr/v1/user/folder/EXAMPLE.txt
1295 This will update bytes 10-19 with the data specified.
1297 * Update an object (append) ::
1300 -H "X-Auth-Token: 0000" \
1301 -H "Content-Length: 10" \
1302 -H "Content-Type: application/octet-stream" \
1303 -H "Content-Range: bytes */*" \
1305 https://pithos.dev.grnet.gr/v1/user/folder/EXAMPLE.txt
1307 * Update an object (truncate) ::
1310 -H "X-Auth-Token: 0000" \
1311 -H "X-Source-Object: /folder/EXAMPLE.txt" \
1312 -H "Content-Range: bytes 0-0/*" \
1313 -H "X-Object-Bytes: 0" \
1314 https://pithos.dev.grnet.gr/v1/user/folder/EXAMPLE.txt
1316 This will truncate the object to 0 bytes.
1318 * Add object metadata ::
1321 -H "X-Auth-Token: 0000" \
1322 -H "X-Object-Meta-First: first_meta_value" \
1323 -H "X-Object-Meta-Second: second_meta_value" \
1324 https://pithos.dev.grnet.gr/v1/user/folder/EXAMPLE.txt
1326 * Delete object metadata ::
1329 -H "X-Auth-Token: 0000" \
1330 -H "X-Object-Meta-First: first_meta_value" \
1331 https://pithos.dev.grnet.gr/v1/user/folder/EXAMPLE.txt
1333 Metadata can only be "set". To delete ``X-Object-Meta-Second``, reset all metadata.
1335 * Delete an object ::
1337 curl -X DELETE -D - \
1338 -H "X-Auth-Token: 0000" \
1339 https://pithos.dev.grnet.gr/v1/user/folder/EXAMPLE.txt
projects / pithos / blob