Cliquet
2.10.0
Rationale
Getting started
HTTP Protocol
API versioning
Authentication
Resource endpoints
Batch operations
Utility endpoints for OPS and Devs
Server timestamps
Backoff indicators
Error responses
Deprecation
Internals
Ecosystem
Contributing
Changelog
Contributors
Cliquet
Docs
»
HTTP Protocol
Edit on GitHub
HTTP Protocol
¶
API versioning
Authentication
Basic Auth
OAuth Bearer token
Firefox Accounts
Resource endpoints
GET /{collection}
Filtering
Sorting
Counting
Polling for changes
Paginate
List of available URL parameters
HTTP Status Codes
POST /{collection}
Validation
Conflicts
HTTP Status Codes
DELETE /{collection}
HTTP Status Codes
GET /{collection}/<id>
HTTP Status Code
DELETE /{collection}/<id>
HTTP Status Code
PUT /{collection}/<id>
HTTP Status Code
PATCH /{collection}/<id>
Read-only fields
Conflicts
HTTP Status Code
Protected resources
Batch operations
POST /batch
HTTP Status Codes
Pros & Cons
Utility endpoints for OPS and Devs
GET /
GET /__heartbeat__
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