3 ============================
4 Ceph Object Gateway S3 API
5 ============================
7 Ceph supports a RESTful API that is compatible with the basic data access model of the `Amazon S3 API`_.
16 Authentication <s3/authentication>
17 Service Ops <s3/serviceops>
18 Bucket Ops <s3/bucketops>
19 Object Ops <s3/objectops>
32 The following table describes the support status for current Amazon S3 functional features:
34 +---------------------------------+-----------------+----------------------------------------+
35 | Feature | Status | Remarks |
36 +=================================+=================+========================================+
37 | **List Buckets** | Supported | |
38 +---------------------------------+-----------------+----------------------------------------+
39 | **Delete Bucket** | Supported | |
40 +---------------------------------+-----------------+----------------------------------------+
41 | **Create Bucket** | Supported | Different set of canned ACLs |
42 +---------------------------------+-----------------+----------------------------------------+
43 | **Bucket Lifecycle** | Supported | |
44 +---------------------------------+-----------------+----------------------------------------+
45 | **Bucket Replication** | Partial | Only permitted across zones |
46 +---------------------------------+-----------------+----------------------------------------+
47 | **Policy (Buckets, Objects)** | Supported | ACLs & bucket policies are supported |
48 +---------------------------------+-----------------+----------------------------------------+
49 | **Bucket Website** | Supported | |
50 +---------------------------------+-----------------+----------------------------------------+
51 | **Bucket ACLs (Get, Put)** | Supported | Different set of canned ACLs |
52 +---------------------------------+-----------------+----------------------------------------+
53 | **Bucket Location** | Supported | |
54 +---------------------------------+-----------------+----------------------------------------+
55 | **Bucket Notification** | Supported | See `S3 Notification Compatibility`_ |
56 +---------------------------------+-----------------+----------------------------------------+
57 | **Bucket Object Versions** | Supported | |
58 +---------------------------------+-----------------+----------------------------------------+
59 | **Get Bucket Info (HEAD)** | Supported | |
60 +---------------------------------+-----------------+----------------------------------------+
61 | **Bucket Request Payment** | Supported | |
62 +---------------------------------+-----------------+----------------------------------------+
63 | **Put Object** | Supported | |
64 +---------------------------------+-----------------+----------------------------------------+
65 | **Delete Object** | Supported | |
66 +---------------------------------+-----------------+----------------------------------------+
67 | **Get Object** | Supported | |
68 +---------------------------------+-----------------+----------------------------------------+
69 | **Object ACLs (Get, Put)** | Supported | |
70 +---------------------------------+-----------------+----------------------------------------+
71 | **Get Object Info (HEAD)** | Supported | |
72 +---------------------------------+-----------------+----------------------------------------+
73 | **POST Object** | Supported | |
74 +---------------------------------+-----------------+----------------------------------------+
75 | **Copy Object** | Supported | |
76 +---------------------------------+-----------------+----------------------------------------+
77 | **Multipart Uploads** | Supported | |
78 +---------------------------------+-----------------+----------------------------------------+
79 | **Object Tagging** | Supported | See :ref:`tag_policy` for Policy verbs |
80 +---------------------------------+-----------------+----------------------------------------+
81 | **Bucket Tagging** | Supported | |
82 +---------------------------------+-----------------+----------------------------------------+
83 | **Storage Class** | Supported | See :ref:`storage_classes` |
84 +---------------------------------+-----------------+----------------------------------------+
86 Unsupported Header Fields
87 -------------------------
89 The following common request header fields are not supported:
91 +----------------------------+------------+
93 +============================+============+
94 | **Server** | Response |
95 +----------------------------+------------+
96 | **x-amz-delete-marker** | Response |
97 +----------------------------+------------+
98 | **x-amz-id-2** | Response |
99 +----------------------------+------------+
100 | **x-amz-version-id** | Response |
101 +----------------------------+------------+
103 .. _Amazon S3 API: http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html
104 .. _S3 Notification Compatibility: ../s3-notification-compatibility