This documentation covers the in-development release of Review Board. You can see the latest stable docs or all previous versions.
Web API Guide¶
REST API 2.0¶
This is the modern API first made available in Review Board 1.5.
- Overview
- Authenticating
- Resource Tree
- Resources
- Change List Resource
- Change Resource
- Diff List Resource
- Diff Resource
- Default Reviewer List Resource
- Default Reviewer Resource
- Draft File Attachment List Resource
- Draft File Attachment Resource
- Draft Screenshot List Resource
- Draft Screenshot Resource
- Extension List Resource
- Extension Resource
- File Attachment Comment List Resource
- File Attachment Comment Resource
- File Attachment List Resource
- File Attachment Resource
- File Diff Comment List Resource
- File Diff List Resource
- File Diff Resource
- Hosting Service Account List Resource
- Hosting Service Account Resource
- Original File Resource
- Patched File Resource
- Repository Info Resource
- Repository List Resource
- Repository Resource
- Review Diff Comment List Resource
- Review Diff Comment Resource
- Review Draft Resource
- Review File Attachment Comment List Resource
- Review File Attachment Comment Resource
- Review Group List Resource
- Review Group Resource
- Review Group User List Resource
- Review Group User Resource
- Review List Resource
- Review Reply Diff Comment List Resource
- Review Reply Diff Comment Resource
- Review Reply Draft Resource
- Review Reply File Attachment Comment List Resource
- Review Reply File Attachment Comment Resource
- Review Reply List Resource
- Review Reply Screenshot Comment List Resource
- Review Reply Screenshot Comment Resource
- Review Reply Resource
- Review Request Draft Resource
- Review Request Last Update Resource
- Review Request List Resource
- Review Request Resource
- Review Screenshot Comment List Resource
- Review Screenshot Comment Resource
- Review Resource
- Root List Resource
- Screenshot Comment List Resource
- Screenshot List Resource
- Screenshot Resource
- Search Resource
- Server Info Resource
- Session Resource
- User List Resource
- User Resource
- Watched Review Group List Resource
- Watched Review Group Resource
- Watched Review Request List Resource
- Watched Review Request Resource
- Watched List Resource
- Errors
- 100 - Does Not Exist
- 101 - Permission Denied
- 103 - Not Logged In
- 104 - Login Failed
- 105 - Invalid Form Data
- 203 - Invalid Change Number
- 204 - Change Number In Use
- 205 - Missing Repository
- 206 - Invalid Repository
- 207 - Repository File Not Found
- 208 - Invalid User
- 209 - Repository Action Not Supported
- 210 - Repository Information Error
- 212 - Empty Changeset
- 213 - Server Configuration Error
- 214 - Bad Host Key
- 215 - Unverified Host Key
- 216 - Unverified Host Certificate
- 217 - Missing User Key
- 218 - Repository Authentication Error
- 219 - Diff Empty
- 220 - Diff Too Big
- 221 - File Retrieval Error
- 222 - Hosting Service Authentication Error
- 223 - Group Already Exists
- Glossary
REST API 1.0 (deprecated)¶
This version of the API was first used in Review Board 1.0. It exists in 1.5 but has been removed in 1.6. All programs should be updated to use the new API.
Documentation for the old API is still available.