Reading List
latest
API Endpoints
Authentication
Resource endpoints
Batch operations
Utility endpoints for OPS and Devs
Server timestamps
API versioning
Backoff indicators
Error responses
Data model
Installation
Contributing
Changelog
Reading List
Docs
»
API Endpoints
Edit on GitHub
API Endpoints
¶
Authentication
Firefox Account OAuth Bearer token
Obtain the token
Using the Web UI
Custom flow
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
Using
Response-Behavior:
light
Using
Response-Behavior:
diff
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
Read the Docs
v: latest
Versions
latest
stable
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.