API

Cheatsheet

Method	URI	Description
GET	/	Information about the running instance
POST	/batch	Send multiple operations in one request
GET	/__heartbeat__	Return the status of dependent services
Buckets
POST	/buckets	Create a bucket
GET	/buckets	List buckets
PUT	/buckets/(bucket_id)	Create or replace a bucket
GET	/buckets/(bucket_id)	Retrieve an existing bucket
DELETE	/buckets/(bucket_id)	Delete a bucket
Groups
POST	/buckets/(bucket_id)/groups	Create a group
GET	/buckets/(bucket_id)/groups	Retrieve the list of bucket’s group
PUT	/buckets/(bucket_id)/groups/(group_id)	Update a group
GET	/buckets/(bucket_id)/groups/(group_id)	Retrieve a group
DELETE	/buckets/(bucket_id)/groups/(group_id)	Delete a group
Collections
PUT	/buckets/(bucket_id)/collections/(collection_id)	Create or replace a collection
PATCH	/buckets/(bucket_id)/collections/(collection_id)	Update a collection
GET	/buckets/(bucket_id)/collections/(collection_id)	Retreive an existing collection
DELETE	/buckets/(bucket_id)/collections/(collection_id)	Delete a collection
Records
POST	/buckets/(bucket_id)/collections/(collection_id)/records	Upload a record
GET	/buckets/(bucket_id)/collections/(collection_id)/records	Retrieve stored records
PUT	/buckets/(bucket_id)/collections/(collection_id)/records/(record_id)	Replace a record
PATCH	/buckets/(bucket_id)/collections/(collection_id)/records/(record_id)	Update a record
GET	/buckets/(bucket_id)/collections/(collection_id)/records/(record_id)	Retrieve a single record
DELETE	/buckets/(bucket_id)/collections/(collection_id)/records/(record_id)	Delete a single record

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

Full reference

Full detailed API documentation:

• API versioning
• Authentication
  • Basic Auth
  • OAuth Bearer token
  • Firefox Accounts
• Resource endpoints
  • GET /{collection}
  • POST /{collection}
  • DELETE /{collection}
  • GET /{collection}/<id>
  • DELETE /{collection}/<id>
  • PUT /{collection}/<id>
  • PATCH /{collection}/<id>
  • Protected resources
• Server timestamps
  • Cache control
  • Concurrency control
• Backoff indicators
  • Backoff header on heavy load
  • Retry-After indicators
• Error responses
  • Protocol description
  • Precondition errors
  • Conflict errors
  • Validation errors
• Deprecation
• Buckets
  • Creating a bucket
  • Replacing a bucket
  • Retrieve an existing bucket
  • Updating an existing bucket
  • Deleting a bucket
  • Retrieving all buckets
• Collections
  • Creating a collection
  • Updating a collection
  • Retrieving an existing collection
  • Deleting a collection
  • Collection JSON schema
  • Collection caching
• Records
  • Uploading a record
  • Replacing a record
  • Updating a record
  • Retrieving stored records
  • Retrieving a specific record
  • Deleting a record
• Groups
  • Creating a group
  • Replacing a group
  • Retrieving a group
  • Retrieving all groups
  • Deleting a group
• Permissions
  • Formalism
  • Principals
  • Retrieve permissions
  • Add a permission
  • Replace or remove permissions
• Synchronisation
  • Polling for changes
  • Apply changes
  • Concurrency control
  • Offline-first
  • Implementations