[ceph.git] / ceph / doc / radosgw / swift.rst

.. _radosgw swift:

===============================
 Ceph Object Gateway Swift API
===============================

Ceph supports a RESTful API that is compatible with the basic data access model of the `Swift API`_.

API
---

.. toctree::
   :maxdepth: 1

   Authentication <swift/auth>
   Service Ops <swift/serviceops>
   Container Ops <swift/containerops>
   Object Ops <swift/objectops>
   Temp URL Ops <swift/tempurl>
   Tutorial <swift/tutorial>
   Java <swift/java>
   Python <swift/python>
   Ruby <swift/ruby>


Features Support
----------------

The following table describes the support status for current Swift functional features:

+---------------------------------+-----------------+----------------------------------------+
| Feature                         | Status          | Remarks                                |
+=================================+=================+========================================+
| **Authentication**              | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Get Account Metadata**        | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Swift ACLs**                  | Supported       | Supports a subset of Swift ACLs        |
+---------------------------------+-----------------+----------------------------------------+
| **List Containers**             | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Delete Container**            | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Create Container**            | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Get Container Metadata**      | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Update Container Metadata**   | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Delete Container Metadata**   | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **List Objects**                | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Static Website**              | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Create Object**               | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Create Large Object**         | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Delete Object**               | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Get Object**                  | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Copy Object**                 | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Get Object Metadata**         | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Update Object Metadata**      | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Expiring Objects**            | Supported       |                                        |
+---------------------------------+-----------------+----------------------------------------+
| **Temporary URLs**              | Partial Support | No support for container-level keys    |
+---------------------------------+-----------------+----------------------------------------+
| **Object Versioning**           | Partial Support | No support for ``X-History-Location``  |
+---------------------------------+-----------------+----------------------------------------+
| **CORS**                        | Not Supported   |                                        |
+---------------------------------+-----------------+----------------------------------------+

.. _Swift API: https://developer.openstack.org/api-ref/object-store/index.html
Commit	Line	Data
20effc67 TL	1	.. _radosgw swift:
20effc67 TL	2
7c673cae FG	3	===============================
	4	Ceph Object Gateway Swift API
	5	===============================
	6
	7	Ceph supports a RESTful API that is compatible with the basic data access model of the `Swift API`_.
	8
	9	API
	10	---
	11
	12	.. toctree::
	13	:maxdepth: 1
	14
	15	Authentication <swift/auth>
	16	Service Ops <swift/serviceops>
	17	Container Ops <swift/containerops>
	18	Object Ops <swift/objectops>
	19	Temp URL Ops <swift/tempurl>
	20	Tutorial <swift/tutorial>
	21	Java <swift/java>
	22	Python <swift/python>
	23	Ruby <swift/ruby>
	24
	25
	26	Features Support
	27	----------------
	28
	29	The following table describes the support status for current Swift functional features:
	30
	31	+---------------------------------+-----------------+----------------------------------------+
	32	\| Feature \| Status \| Remarks \|
	33	+=================================+=================+========================================+
	34	\| Authentication \| Supported \| \|
	35	+---------------------------------+-----------------+----------------------------------------+
	36	\| Get Account Metadata \| Supported \| \|
	37	+---------------------------------+-----------------+----------------------------------------+
	38	\| Swift ACLs \| Supported \| Supports a subset of Swift ACLs \|
	39	+---------------------------------+-----------------+----------------------------------------+
	40	\| List Containers \| Supported \| \|
	41	+---------------------------------+-----------------+----------------------------------------+
	42	\| Delete Container \| Supported \| \|
	43	+---------------------------------+-----------------+----------------------------------------+
	44	\| Create Container \| Supported \| \|
	45	+---------------------------------+-----------------+----------------------------------------+
	46	\| Get Container Metadata \| Supported \| \|
	47	+---------------------------------+-----------------+----------------------------------------+
	48	\| Update Container Metadata \| Supported \| \|
	49	+---------------------------------+-----------------+----------------------------------------+
	50	\| Delete Container Metadata \| Supported \| \|
	51	+---------------------------------+-----------------+----------------------------------------+
	52	\| List Objects \| Supported \| \|
	53	+---------------------------------+-----------------+----------------------------------------+
	54	\| Static Website \| Supported \| \|
	55	+---------------------------------+-----------------+----------------------------------------+
	56	\| Create Object \| Supported \| \|
	57	+---------------------------------+-----------------+----------------------------------------+
	58	\| Create Large Object \| Supported \| \|
	59	+---------------------------------+-----------------+----------------------------------------+
	60	\| Delete Object \| Supported \| \|
	61	+---------------------------------+-----------------+----------------------------------------+
	62	\| Get Object \| Supported \| \|
	63	+---------------------------------+-----------------+----------------------------------------+
	64	\| Copy Object \| Supported \| \|
	65	+---------------------------------+-----------------+----------------------------------------+
	66	\| Get Object Metadata \| Supported \| \|
67	+---------------------------------+-----------------+----------------------------------------+
68	\| Update Object Metadata \| Supported \| \|
69	+---------------------------------+-----------------+----------------------------------------+
70	\| Expiring Objects \| Supported \| \|
71	+---------------------------------+-----------------+----------------------------------------+
11fdf7f2 TL	72	\| Temporary URLs \| Partial Support \| No support for container-level keys \|
	73	+---------------------------------+-----------------+----------------------------------------+
	74	\| Object Versioning \| Partial Support \| No support for ``X-History-Location`` \|
7c673cae FG	75	+---------------------------------+-----------------+----------------------------------------+
	76	\| CORS \| Not Supported \| \|
	77	+---------------------------------+-----------------+----------------------------------------+
	78
11fdf7f2	79	.. _Swift API: https://developer.openstack.org/api-ref/object-store/index.html