Cliquet
Rationale
Philosophy
Features
Records and synchronization
Generic endpoints
Toolkit
Dependencies
Built with Cliquet
Context
Vision
General
Generic storage
Roadmap
Similar projects
Getting started
Installation
Start a Pyramid project
Include Cliquet
Run!
Authentication
Define resources
Schema validation
What’s next ?
Configuration
Resource customization
Advanced initialization
Beyond Cliquet
API Endpoints
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
Error codes
Precondition errors
Conflict errors
Validation errors
Deprecation
Reference
Installation
Supported Python versions
Distribute & Pip
Python 3.4
Linux
OS X
Cryptography libraries
Linux
OS X
Install Redis
Linux
OS X
Install PostgreSQL
Client libraries only
Full server
Server using Docker
Configuration
Environment variables
Project info
Feature settings
Disabling endpoints
Deployment
Scheme, host and port
Deprecation
Logging with Heka
Handling exceptions with Sentry
Monitoring with StatsD
Monitoring with New Relic
Storage
Cache
Authentication
Authentication setup
Basic Auth
Custom Authentication
Firefox Accounts
Permission configuration
Application profiling
Enable middleware
Initialization sequence
Resource
Full example
Resource Schema
Resource class
Interaction with storage
Custom record ids
Generators objects
Custom Usage
Within views
Outside views
Viewsets
Configuring a viewset
Subclassing a viewset
ViewSet class
Storage
Backends
PostgreSQL
Redis
Memory
Cloud Storage
API
Exceptions
Store custom data
Cache
PostgreSQL
Redis
Memory
API
Permissions
Glossary
Overview
Route factory
Authorization policy
Permissions backend
Errors
Glossary
Ecosystem
Packages
Extending Cliquet
Pluggable components
Include external packages
Include me
Configuration
Custom backend
Adding features
JavaScript client
Contributing
Setup your development environment
OS X
Run tests
Run a single test
Definition of done
IRC channel
Changelog
2.3.1 (2015-07-15)
2.3 (2015-07-13)
2.2.1 (2015-07-06)
2.2.0 (2015-07-02)
2.1.0 (2015-06-26)
2.0.0 (2015-06-16)
1.8.0 (2015-05-13)
1.7.0 (2015-04-10)
1.6.0 (2015-03-30)
1.5.0 (2015-03-27)
1.4.1 (2015-03-25)
1.4.0 (2015-03-24)
1.3.2 (2015-03-20)
1.3.1 (2015-03-20)
1.3.0 (2015-03-20)
1.2.1 (2015-03-18)
1.2 (2015-03-18)
1.1.4 (2015-03-03)
1.1.3 (2015-03-03)
1.1.2 (2015-03-03)
1.1.1 (2015-03-03)
1.1 (2015-03-03)
1.0 (2015-03-02)
Contributors
Cliquet
Docs
»
API Endpoints
Edit on GitHub
API Endpoints
¶
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
Error codes
Precondition errors
Conflict errors
Validation errors
Deprecation
Read the Docs
v: 2.3.1
Versions
latest
2.3.1
2.2.1
2.0.0
1.8.0
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.