Full detailed API documentation:
authentication resource buckets collections records groups permissions filtering sorting pagination selecting_fields utilities batch timestamps backoff errors deprecation
| Method | URI | Description |
|---|---|---|
| GET | / <api-utilities> |
Information about the running instance
<api-utilities> |
| POST | /batch <batch> |
Send multiple operations in one request <batch> |
| GET | /__heartbeat__ <api-utilities> |
Return the status of dependent services
<api-utilities> |
| *Buckets | ||
| POST | /buckets <buckets-post> |
Create a bucket <buckets-post> |
| GET | /buckets <buckets-get> |
List buckets <buckets-get> |
| DELETE | /buckets <buckets-delete> |
Delete every writable buckets <buckets-delete> |
| PUT | /buckets/(bucket_id) <bucket-put> |
Create or replace a bucket <bucket-put> |
| GET | /buckets/(bucket_id) <bucket-get> |
Retrieve an existing bucket <bucket-get> |
| DELETE | /buckets/(bucket_id) <bucket-delete> |
Delete a bucket <bucket-delete> |
| Groups | ||
| POST | /buckets/(bucket_id)/groups <groups-post> |
Create a group <groups-post> |
| GET | /buckets/(bucket_id)/groups <groups-get> |
Retrieve the list of bucket's group <groups-get> |
| PUT | /buckets/(bucket_id)/groups/(group_id) <group-put> |
Update a group <group-put> |
| GET | /buckets/(bucket_id)/groups/(group_id) <group-get> |
Retrieve a group <group-get> |
| DELETE | /buckets/(bucket_id)/groups/(group_id) <groups-post> |
Delete a group <group-delete> |
| **Collecti | ons** | |
| GET | /buckets/(bucket_id)/collections <collections-get> |
List bucket's collections <collections-get> |
| DELETE | /buckets/(bucket_id)/collections <collections-delete> |
Delete writable collections <collections-delete> |
| POST | /buckets/(bucket_id)/collections <collections-post> |
Create a collection <collections-post> |
| PUT | /buckets/(bucket_id)/collections/(collection_id) <collection-put> |
Create or replace a collection <collection-put> |
| PATCH | /buckets/(bucket_id)/collections/(collection_id) <collection-patch> |
Update a collection <collection-patch> |
| GET | /buckets/(bucket_id)/collections/(collection_id) <collection-get> |
Retreive an existing collection <collection-get> |
| DELETE | /buckets/(bucket_id)/collections/(collection_id) <collection-delete> |
Delete a collection <collection-delete> |
| *Records | ||
| POST | /buckets/(bucket_id)/collections/(collection_id)/records <records-post> |
Upload a record <records-post> |
| GET | /buckets/(bucket_id)/collections/(collection_id)/records <records-get> |
Retrieve stored records <records-get> |
| DELETE | /buckets/(bucket_id)/collections/(collection_id)/records <records-delete> |
Delete stored records <records-delete> |
| PUT | /buckets/(bucket_id)/collections/(collection_id)/records/(record_id) <record-put> |
Replace a record <record-put> |
| PATCH | /buckets/(bucket_id)/collections/(collection_id)/records/(record_id) <record-patch> |
Update a record <record-patch> |
| GET | /buckets/(bucket_id)/collections/(collection_id)/records/(record_id) <records-get> |
Retrieve a single record <records-get> |
| DELETE | /buckets/(bucket_id)/collections/(collection_id)/records/(record_id) <record-delete> |
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 resource-endpoints.