summaryrefslogtreecommitdiffstats
path: root/doc/api/index.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
commite6918187568dbd01842d8d1d2c808ce16a894239 (patch)
tree64f88b554b444a49f656b6c656111a145cbbaa28 /doc/api/index.rst
parentInitial commit. (diff)
downloadceph-upstream/18.2.2.tar.xz
ceph-upstream/18.2.2.zip
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/api/index.rst')
-rw-r--r--doc/api/index.rst47
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/api/index.rst b/doc/api/index.rst
new file mode 100644
index 000000000..7007b0dc1
--- /dev/null
+++ b/doc/api/index.rst
@@ -0,0 +1,47 @@
+===================
+ API Documentation
+===================
+
+Ceph RESTful API
+================
+
+See :ref:`mgr ceph api`.
+
+Ceph Storage Cluster APIs
+=========================
+
+See :ref:`rados api`
+
+
+Ceph File System APIs
+=====================
+
+See :ref:`cephfs api`
+
+
+Ceph Block Device APIs
+======================
+
+See :ref:`rbd api py`
+
+Ceph RADOS Gateway APIs
+=======================
+
+See :ref:`radosgw api`
+
+Ceph Object Store APIs
+======================
+
+- See :ref:`S3-compatible API <radosgw s3>`.
+- See :ref:`Swift-compatible API <radosgw swift>`.
+- See :ref:`Admin Ops API<radosgw admin ops>`.
+
+Ceph MON Command API
+====================
+
+- See :doc:`Mon command API <mon_command_api>`.
+
+.. toctree::
+ :hidden:
+
+ mon_command_api