Reading List
API Endpoints
Authentication
Firefox Account OAuth Bearer token
Obtain the token
Basic Auth
Resource endpoints
GET /articles
Filtering
Sorting
Counting
Polling for changes
Paginate
List of available URL parameters
Combining all parameters
Example
POST /articles
Validation
Conflicts
Example
DELETE /articles
Example
GET /articles/<id>
Example
DELETE /articles/<id>
Example
PATCH /articles/<id>
Modifiable fields
Response behavior
Errors
Conflicts
Example
Batch operations
POST /batch
Utility endpoints for OPS and Devs
GET /
GET /__heartbeat__
Server timestamps
API versioning
Versionning
Deprecation
Backoff indicators
Backoff header on heavy load
Retry-After indicators
Error responses
Protocol description
Error codes
Validation errors
Data model
Articles
Installation
Run locally
For development
Using Docker
Authentication
Install and setup PostgreSQL
Using Docker
Linux
OS X
Cryptography libraries
Linux
OS X
Running in production
Recommended settings
Monitoring
PostgreSQL setup
Running with uWsgi
Running with gevent
Contributing
Run tests
Run load tests
IRC channel
Changelog
2.0.0 (2015-07-22)
1.7.0 (2015-04-15)
1.6.0 (2015-04-10)
1.5.0 (2015-03-30)
1.4.0 (2015-03-27)
1.3.0 (2015-03-25)
1.2.0 (2015-03-20)
1.1.0 (2015-03-18)
1.0 (2015-03-03)
0.2.2 (2015-02-13)
0.2.1 (2015-02-11)
0.2 (2015-02-09)
0.1 (2015-01-30)
Reading List
Docs
»
Please activate JavaScript to enable the search functionality.
Read the Docs
v: stable
Versions
latest
stable
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.