.. _kinto-api-endpoints:

1.x
###

Full reference
==============

Full detailed API documentation:

.. toctree::
   :maxdepth: 1

   authentication
   accounts
   openid
   buckets
   collections
   records
   groups
   permissions
   filtering
   sorting
   pagination
   selecting_fields
   history
   quotas
   utilities
   admin
   batch
   openapi
   flush
   timestamps
   backoff
   errors
   deprecation


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>`                                        |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `GET`    | :ref:`/__api__ <openapi_spec>`                                                               | :ref:`Return the OpenAPI description of the running     |
|          |                                                                                              | instance <openapi_spec>`                                |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| **Buckets**                                                                                                                                                       |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `POST`   | :ref:`/buckets <buckets-post>`                                                               | :ref:`Create a bucket <buckets-post>`                   |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `GET`    | :ref:`/buckets <buckets-get>`                                                                | :ref:`List buckets <buckets-get>`                       |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `DELETE` | :ref:`/buckets <buckets-delete>`                                                             | :ref:`Delete every writable buckets <buckets-delete>`   |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `PUT`    | :ref:`/buckets/(bucket_id) <bucket-put>`                                                     | :ref:`Create or replace a bucket <bucket-put>`          |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `PATCH`  | :ref:`/buckets/(bucket_id) <bucket-patch>`                                                   | :ref:`Modify an existing bucket <bucket-patch>`         |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `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>` |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `DELETE` | :ref:`/buckets/(bucket_id)/groups <groups-delete>`                                           | :ref:`Delete writable groups <groups-delete>`           |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `PUT`    | :ref:`/buckets/(bucket_id)/groups/(group_id) <group-put>`                                    | :ref:`Update a group <group-put>`                       |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `PATCH`  | :ref:`/buckets/(bucket_id)/groups/(group_id) <group-patch>`                                  | :ref:`Modify an existing group <group-patch>`           |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `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**                                                                                                                                                   |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `GET`    | :ref:`/buckets/(bucket_id)/collections <collections-get>`                                    | :ref:`List bucket's collections <collections-get>`      |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `DELETE` | :ref:`/buckets/(bucket_id)/collections <collections-delete>`                                 | :ref:`Delete writable collections <collections-delete>` |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `POST`   | :ref:`/buckets/(bucket_id)/collections <collections-post>`                                   | :ref:`Create a collection <collections-post>`           |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `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:`Modify an existing 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>`            |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `DELETE` | :ref:`/buckets/(bucket_id)/collections/(collection_id)/records <records-delete>`             | :ref:`Delete stored records <records-delete>`           |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `PUT`    | :ref:`/buckets/(bucket_id)/collections/(collection_id)/records/(record_id) <record-put>`     | :ref:`Create or replace a record <record-put>`          |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+
| `PATCH`  | :ref:`/buckets/(bucket_id)/collections/(collection_id)/records/(record_id) <record-patch>`   | :ref:`Modify an existing 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>`           |
+----------+----------------------------------------------------------------------------------------------+---------------------------------------------------------+