Skip to content

Latest commit

 

History

History
90 lines (81 loc) · 9.46 KB

index.rst

File metadata and controls

90 lines (81 loc) · 9.46 KB
Raw

API

Cheatsheet

Method URI Description
GET :ref:`/ <api-utilities>` :ref:`Information about the running instance <api-utilities>`
POST :ref:`/batch <batch>` :ref:`Send multiple operations in one request <batch>`
GET :ref:`/__heartbeat__ <api-utilities>` :ref:`Return the status of dependent services <api-utilities>`
Buckets
PUT :ref:`/buckets/(bucket_id) <bucket-put>` :ref:`Create or replace a bucket <bucket-put>`
GET :ref:`/buckets/(bucket_id) <bucket-get>` :ref:`Retrieve an existing bucket <bucket-get>`
DELETE :ref:`/buckets/(bucket_id) <bucket-delete>` :ref:`Delete a bucket <bucket-delete>`
Groups
POST :ref:`/buckets/(bucket_id)/groups <groups-post>` :ref:`Create a group <groups-post>`
GET :ref:`/buckets/(bucket_id)/groups <groups-get>` :ref:`Retrieve the list of bucket's group <groups-get>`
PUT :ref:`/buckets/(bucket_id)/groups/(group_id) <group-put>` :ref:`Update a group <group-put>`
GET :ref:`/buckets/(bucket_id)/groups/(group_id) <group-get>` :ref:`Retrieve a group <group-get>`
DELETE :ref:`/buckets/(bucket_id)/groups/(group_id) <groups-post>` :ref:`Delete a group <group-delete>`
Collections
PUT :ref:`/buckets/(bucket_id)/collections/(collection_id) <collection-put>` :ref:`Create or replace a collection <collection-put>`
PATCH :ref:`/buckets/(bucket_id)/collections/(collection_id) <collection-patch>` :ref:`Update a collection <collection-patch>`
GET :ref:`/buckets/(bucket_id)/collections/(collection_id) <collection-get>` :ref:`Retreive an existing collection <collection-get>`
DELETE :ref:`/buckets/(bucket_id)/collections/(collection_id) <collection-delete>` :ref:`Delete a collection <collection-delete>`
Records
POST :ref:`/buckets/(bucket_id)/collections/(collection_id)/records <records-post>` :ref:`Upload a record <records-post>`
GET :ref:`/buckets/(bucket_id)/collections/(collection_id)/records <records-get>` :ref:`Retrieve stored records <records-get>`
PUT :ref:`/buckets/(bucket_id)/collections/(collection_id)/records/(record_id) <record-put>` :ref:`Replace a record <record-put>`
PATCH :ref:`/buckets/(bucket_id)/collections/(collection_id)/records/(record_id) <record-patch>` :ref:`Update a record <record-patch>`
GET :ref:`/buckets/(bucket_id)/collections/(collection_id)/records/(record_id) <records-get>` :ref:`Retrieve a single record <records-get>`
DELETE :ref:`/buckets/(bucket_id)/collections/(collection_id)/records/(record_id) <record-delete>` :ref:`Delete a single record <record-delete>`

Buckets, Groups, Collection and Record endpoints are resource endpoints which can be filtered, paginated, and interacted with as described in :ref:`resource-endpoints`.

Full reference

Full detailed API documentation:

.. toctree::
   :maxdepth: 2

   cliquet/versioning
   cliquet/authentication
   cliquet/resource
   cliquet/timestamps
   cliquet/backoff
   cliquet/errors
   cliquet/deprecation
   buckets
   collections
   records
   groups
   permissions
   synchronisation