• Get Review Board
  • What's New
  • Products
  • Review Board Code review, image review, and document review
  • Documentation
  • Release Notes
  • Power Pack Enterprise integrations, reports, and enhanced document review
  • Try for 60 Days
  • Purchase
  • RBCommons Review Board as a Service, hosted by us
  • Pricing
  • RBTools Command line tools and Python API for Review Board
  • Documentation
  • Release Notes
  • Review Bot Automated code review, connecting tools you already use
  • Documentation
  • Release Notes
  • RB Gateway Manage Git and Mercurial repositories in your network
  • Documentation
  • Release Notes
  • Learn and Explore
  • What is Code Review?
  • Documentation
  • Frequently Asked Questions
  • Support Options
  • Third-Party Integrations
  • Demo
  • Review Board RBTools Power Pack Review Bot Djblets RB Gateway
    1. Review Board 7.x
    2. Version 7.x
    3. Version 6.x
    4. Version 5.0
    5. Version 4.0
    6. Version 3.0
    7. Version 2.5
    8. Version 2.0
    9. Version 1.7
    10. Version 1.6
    11. Version 1.5
    12. Version 1.0
    13. Web API Guide
    14. Resources
    15. Root List Resource
  • Home
  • Users Guide
  • Getting Started
  • Introduction
  • What is Code Review?
  • Review Board Workflows
  • Account Settings
  • Dashboard
  • Working with Review Requests
  • Overview
  • Creating Review Requests
  • Editing Fields
  • Uploading Diffs
  • Uploading File Attachments
  • Publishing Review Requests
  • Closing Review Requests
  • Reviewing
  • Reviews and Comments
  • The Review Banner
  • Managing and Publishing Drafts
  • Issue Tracking
  • Reviewing Code (Diffs)
  • Reviewing File Attachments
  • Reviewing Images
  • Reviewing Markdown Files
  • Reviewing Text Files
  • Creating and Editing Reviews
  • Approving Changes (Ship It!)
  • Replying to Comments
  • Automated Code Reviews
  • Searching
  • Quick Search
  • Full-Text Search
  • Using Markdown
  • Administration Guide
  • Installation
  • Installing Review Board
  • Linux System Compatibility
  • Installing with Docker
  • Manually Installing on Linux
  • Installing on macOS
  • Installing on Windows
  • Installing Development Releases
  • Creating a Review Board Site
  • Upgrading
  • Upgrading Review Board
  • Upgrading Review Board Sites
  • Optimization
  • Optimizing and Scaling Review Board
  • Administration UI
  • Overview of the Administration UI
  • Administrator Dashboard
  • Database Management
  • Configuration
  • Site Settings
  • General Settings
  • Authentication Settings
  • Avatar Services Settings
  • E-Mail Settings
  • Diff Viewer Settings
  • Logging Settings
  • SSH Settings
  • File Storage Settings
  • User Privacy Settings
  • Search Settings
  • Access Control
  • Working with E-Mail
  • Default Reviewers
  • Permission Groups
  • Repositories
  • Bazaar Repositories
  • CVS Repositories
  • Git Repositories
  • HCL VersionVault and IBM ClearCase
  • Mercurial Repositories
  • Perforce Repositories
  • Subversion Repositories
  • Assembla Repositories
  • AWS CodeCommit Repositories
  • Beanstalk Repositories
  • Bitbucket Repositories
  • Bitbucket Server Repositories
  • Codebase HQ Repositories
  • Fedora Hosted Repositories
  • Gerrit Repositories
  • GitHub Repositories
  • GitHub Enterprise Repositories
  • GitLab Repositories
  • Gitorious Repositories
  • Cliosoft SOS Repositories
  • SourceForge Repositories
  • Unfuddle STACK Repositories
  • VisualStudio.com Repositories
  • Review Groups
  • Users
  • WebHooks
  • Extensions
  • Integrations
  • Asana Integration
  • CircleCI Integration
  • Discord Integration
  • I Done This Integration
  • Jenkins CI Integration
  • Matrix Integration
  • Mattermost Integration
  • Microsoft Teams Integration
  • Slack Integration
  • Travis CI Integration
  • Trello Integration
  • Site Maintenance
  • The rb-site Tool
  • Advanced Management Commands
  • Monitoring Review Board
  • Health Checks
  • Web API Guide
  • Resource Tree
  • Resources
  • Root List Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Extension List Resource
  • Extension Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Info Resource
  • Repository User List Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Request List Resource
  • Review Request Resource
  • Change List Resource
  • Diff Context Resource
  • Diff List Resource
  • File Attachment List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Status Update List Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Root Review List Resource
  • Search Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • API Token List Resource
  • Archived Review Request List Resource
  • Muted Review Request List Resource
  • User File Attachment List Resource
  • Watched List Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • Server Info Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Default Reviewer Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • File Diff List Resource
  • File Diff Resource
  • Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • Diff Commit Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Diff File Attachment Resource
  • Original File Resource
  • Patched File Resource
  • Extension List Resource
  • Extension Resource
  • Extension Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • Hosting Service Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository User Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User Resource
  • Change List Resource
  • Change Resource
  • Change Resource
  • File Attachment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Comment List Resource
  • Review Request List Resource
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • File Attachment List Resource
  • File Attachment Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft File Attachment List Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Status Update List Resource
  • Status Update Resource
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • File Diff List Resource
  • File Attachment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review File Attachment Comment List Resource
  • Review General Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Status Update List Resource
  • Status Update Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Comment List Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft File Attachment Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft File Diff List Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Root Review List Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply General Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review General Comment Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Search Resource
  • Status Update List Resource
  • Status Update Resource
  • Status Update Resource
  • API Token List Resource
  • API Token Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • Muted Review Request Resource
  • Session Resource
  • User List Resource
  • User Resource
  • API Token List Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • User Resource
  • API Token List Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • User File Attachment Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • WebHook Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 102 - Invalid Attribute
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 106 - Missing Attribute
  • 107 - Enable Extension Failed
  • 108 - Disable Extension Failed
  • 109 - Extension Already Installed
  • 110 - Install Extension Failed
  • 111 - Duplicate Item
  • 112 - OAuth2 Missing Scope Error
  • 113 - OAuth2 Access Denied Error
  • 114 - Rate Limit Exceeded
  • 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
  • 224 - Diff Parse Error
  • 225 - Publish Error
  • 226 - User Query Error
  • 227 - Commit ID Already Exists
  • 228 - Token Generation Failed
  • 230 - Could not close review request
  • 231 - Could not reopen review request
  • 232 - Ship-It Revocation Error
  • REST API 2.0
  • Overview
  • Authenticating
  • API Token Policies
  • OAuth2 Authentication
  • Rich Text Fields and Types
  • Storing/Accessing Extra Data
  • Resources
  • Root List Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Extension List Resource
  • Extension Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Request List Resource
  • Review Request Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Root Review List Resource
  • Search Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • Server Info Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Default Reviewer Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • File Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • File Diff List Resource
  • File Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • Diff Commit Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Diff File Attachment Resource
  • Original File Resource
  • Patched File Resource
  • Extension List Resource
  • Extension Resource
  • Extension Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • Hosting Service Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository User Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User Resource
  • Change List Resource
  • Change Resource
  • Change Resource
  • File Attachment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Comment List Resource
  • Review Request List Resource
  • Review Request Resource
  • Change List Resource
  • Diff Context Resource
  • Diff List Resource
  • File Attachment List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Status Update List Resource
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • File Attachment List Resource
  • File Attachment Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft File Attachment List Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Status Update List Resource
  • Status Update Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Comment List Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft File Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft File Attachment Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Root Review List Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review File Attachment Comment List Resource
  • Review General Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review General Comment Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply General Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Search Resource
  • Status Update List Resource
  • Status Update Resource
  • Status Update Resource
  • API Token List Resource
  • API Token Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • Muted Review Request Resource
  • Session Resource
  • User List Resource
  • User Resource
  • API Token List Resource
  • Archived Review Request List Resource
  • Muted Review Request List Resource
  • User File Attachment List Resource
  • Watched List Resource
  • User Resource
  • API Token List Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • User File Attachment Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • WebHook Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 102 - Invalid Attribute
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 106 - Missing Attribute
  • 107 - Enable Extension Failed
  • 108 - Disable Extension Failed
  • 109 - Extension Already Installed
  • 110 - Install Extension Failed
  • 111 - Duplicate Item
  • 112 - OAuth2 Missing Scope Error
  • 113 - OAuth2 Access Denied Error
  • 114 - Rate Limit Exceeded
  • 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
  • 224 - Diff Parse Error
  • 225 - Publish Error
  • 226 - User Query Error
  • 227 - Commit ID Already Exists
  • 228 - Token Generation Failed
  • 230 - Could not close review request
  • 231 - Could not reopen review request
  • 232 - Ship-It Revocation Error
  • Glossary
  • Extending Review Board
  • Extension Files/Package Layout
  • Creating an Extension Class
  • Extension Configuration
  • Database Models
  • Extension Static Media Files
  • JavaScript Extensions
  • Testing Extensions
  • Extension Distribution
  • Writing Review Board Extensions
  • The rbext Tool
  • Extension Hooks
  • AccountPageFormsHook
  • AccountPagesHook
  • Action Hooks
  • AdminWidgetHook
  • APIExtraDataAccessHook
  • AuthBackendHook
  • AvatarServiceHook
  • CommentDetailDisplayHook
  • DashboardColumnsHook
  • DashboardSidebarItemsHook
  • DataGridColumnsHook
  • EmailHook
  • ReviewRequestPublishedEmailHook
  • ReviewRequestClosedEmailHook
  • ReviewPublishedEmailHook
  • ReviewReplyPublishedEmailHook
  • FileAttachmentThumbnailHook
  • FileDiffACLHook
  • HostingServiceHook
  • IntegrationHook
  • NavigationBarHook
  • ReviewRequestApprovalHook
  • ReviewRequestFieldsHook
  • ReviewRequestFieldSetsHook
  • ReviewUIHook
  • SCMToolHook
  • SignalHook
  • TemplateHook
  • URLHook
  • UserInfoboxHook
  • UserPageSidebarItemsHook
  • WebAPICapabilitiesHook
  • JavaScript Extension Hooks
  • CommentDialogHook
  • FileAttachmentThumbnailContainerHook
  • ReviewDialogCommentHook
  • ReviewDialogHook
  • Adding Review Request Fields
  • Review UI Integration
  • Writing Authentication Backends
  • Writing Legacy Authentication Backends
  • Extending the Web API
  • Module and Class References
  • reviewboard
  • reviewboard.deprecation
  • reviewboard.rb_platform
  • reviewboard.signals
  • reviewboard.accounts.backends
  • reviewboard.accounts.backends.ad
  • reviewboard.accounts.backends.base
  • reviewboard.accounts.backends.http_digest
  • reviewboard.accounts.backends.ldap
  • reviewboard.accounts.backends.nis
  • reviewboard.accounts.backends.registry
  • reviewboard.accounts.backends.standard
  • reviewboard.accounts.backends.x509
  • reviewboard.accounts.decorators
  • reviewboard.accounts.errors
  • reviewboard.accounts.forms.auth
  • reviewboard.accounts.forms.pages
  • reviewboard.accounts.forms.registration
  • reviewboard.accounts.managers
  • reviewboard.accounts.middleware
  • reviewboard.accounts.mixins
  • reviewboard.accounts.models
  • reviewboard.accounts.pages
  • reviewboard.accounts.privacy
  • reviewboard.accounts.templatetags.accounts
  • reviewboard.accounts.testing
  • reviewboard.accounts.testing.queries
  • reviewboard.accounts.trophies
  • reviewboard.actions
  • reviewboard.actions.base
  • reviewboard.actions.errors
  • reviewboard.actions.registry
  • reviewboard.admin
  • reviewboard.admin.admin_sites
  • reviewboard.admin.cache_stats
  • reviewboard.admin.checks
  • reviewboard.admin.decorators
  • reviewboard.admin.form_widgets
  • reviewboard.admin.middleware
  • reviewboard.admin.model_admin
  • reviewboard.admin.security_checks
  • reviewboard.admin.server
  • reviewboard.admin.siteconfig
  • reviewboard.admin.support
  • reviewboard.admin.validation
  • reviewboard.admin.widgets
  • reviewboard.attachments.errors
  • reviewboard.attachments.forms
  • reviewboard.attachments.managers
  • reviewboard.attachments.mimetypes
  • reviewboard.attachments.models
  • reviewboard.avatars.registry
  • reviewboard.avatars.services
  • reviewboard.avatars.settings
  • reviewboard.avatars.templatetags.avatars
  • reviewboard.avatars.testcase
  • reviewboard.changedescs.models
  • reviewboard.datagrids.columns
  • reviewboard.datagrids.grids
  • reviewboard.datagrids.sidebar
  • reviewboard.diffviewer.chunk_generator
  • reviewboard.diffviewer.differ
  • reviewboard.diffviewer.diffutils
  • reviewboard.diffviewer.errors
  • reviewboard.diffviewer.forms
  • reviewboard.diffviewer.managers
  • reviewboard.diffviewer.models
  • reviewboard.diffviewer.models.diffcommit
  • reviewboard.diffviewer.models.diffset
  • reviewboard.diffviewer.models.diffset_history
  • reviewboard.diffviewer.models.filediff
  • reviewboard.diffviewer.models.legacy_file_diff_data
  • reviewboard.diffviewer.models.raw_file_diff_data
  • reviewboard.diffviewer.myersdiff
  • reviewboard.diffviewer.opcode_generator
  • reviewboard.diffviewer.parser
  • reviewboard.diffviewer.processors
  • reviewboard.diffviewer.renderers
  • reviewboard.diffviewer.smdiff
  • reviewboard.certs
  • reviewboard.certs.cert
  • reviewboard.certs.errors
  • reviewboard.extensions.base
  • reviewboard.extensions.hooks
  • reviewboard.extensions.packaging
  • reviewboard.extensions.testing
  • reviewboard.extensions.testing.testcases
  • reviewboard.hostingsvcs.base
  • reviewboard.hostingsvcs.base.client
  • reviewboard.hostingsvcs.base.forms
  • reviewboard.hostingsvcs.base.hosting_service
  • reviewboard.hostingsvcs.base.http
  • reviewboard.hostingsvcs.base.paginator
  • reviewboard.hostingsvcs.base.registry
  • reviewboard.hostingsvcs.base.repository
  • reviewboard.hostingsvcs.errors
  • reviewboard.hostingsvcs.forms
  • reviewboard.hostingsvcs.hook_utils
  • reviewboard.hostingsvcs.models
  • reviewboard.hostingsvcs.repository
  • reviewboard.hostingsvcs.service
  • reviewboard.hostingsvcs.testing
  • reviewboard.hostingsvcs.testing.testcases
  • reviewboard.hostingsvcs.utils.paginator
  • reviewboard.integrations
  • reviewboard.integrations.base
  • reviewboard.integrations.forms
  • reviewboard.integrations.models
  • reviewboard.integrations.urls
  • reviewboard.integrations.views
  • reviewboard.notifications
  • reviewboard.notifications.email
  • reviewboard.notifications.email.backend
  • reviewboard.notifications.email.decorators
  • reviewboard.notifications.email.hooks
  • reviewboard.notifications.email.message
  • reviewboard.notifications.email.utils
  • reviewboard.notifications.email.views
  • reviewboard.notifications.forms
  • reviewboard.notifications.managers
  • reviewboard.notifications.models
  • reviewboard.notifications.webhooks
  • reviewboard.reviews.actions
  • reviewboard.reviews.builtin_fields
  • reviewboard.reviews.chunk_generators
  • reviewboard.reviews.conditions
  • reviewboard.reviews.context
  • reviewboard.reviews.default_actions
  • reviewboard.reviews.detail
  • reviewboard.reviews.errors
  • reviewboard.reviews.features
  • reviewboard.reviews.fields
  • reviewboard.reviews.forms
  • reviewboard.reviews.managers
  • reviewboard.reviews.markdown_utils
  • reviewboard.reviews.models
  • reviewboard.reviews.signals
  • reviewboard.reviews.templatetags.reviewtags
  • reviewboard.reviews.testing
  • reviewboard.reviews.testing.queries
  • reviewboard.reviews.testing.queries.review_groups
  • reviewboard.reviews.testing.queries.review_requests
  • reviewboard.reviews.testing.queries.reviews
  • reviewboard.reviews.ui.base
  • reviewboard.reviews.ui.image
  • reviewboard.reviews.ui.markdownui
  • reviewboard.reviews.ui.text
  • reviewboard.reviews.views.attachments
  • reviewboard.reviews.views.bug_trackers
  • reviewboard.reviews.views.diff_fragments
  • reviewboard.reviews.views.diffviewer
  • reviewboard.reviews.views.download_diff
  • reviewboard.reviews.views.email
  • reviewboard.reviews.views.mixins
  • reviewboard.reviews.views.new_review_request
  • reviewboard.reviews.views.review_request_detail
  • reviewboard.reviews.views.review_request_infobox
  • reviewboard.reviews.views.review_request_updates
  • reviewboard.reviews.views.root
  • reviewboard.scmtools.certs
  • reviewboard.scmtools.conditions
  • reviewboard.scmtools.core
  • reviewboard.scmtools.crypto_utils
  • reviewboard.scmtools.errors
  • reviewboard.scmtools.forms
  • reviewboard.scmtools.managers
  • reviewboard.scmtools.models
  • reviewboard.scmtools.signals
  • reviewboard.scmtools.testing
  • reviewboard.scmtools.testing.queries
  • reviewboard.scmtools.tests.testcases
  • reviewboard.search.fields
  • reviewboard.search.forms
  • reviewboard.search.indexes
  • reviewboard.search.search_backends.base
  • reviewboard.search.search_backends.elasticsearch
  • reviewboard.search.search_backends.registry
  • reviewboard.search.search_backends.whoosh
  • reviewboard.search.signal_processor
  • reviewboard.search.testing
  • reviewboard.site.conditions
  • reviewboard.site.context_processors
  • reviewboard.site.decorators
  • reviewboard.site.middleware
  • reviewboard.site.mixins
  • reviewboard.site.models
  • reviewboard.site.signals
  • reviewboard.site.templatetags.localsite
  • reviewboard.site.testing
  • reviewboard.site.testing.queries
  • reviewboard.site.urlresolvers
  • reviewboard.site.validation
  • reviewboard.ssh.client
  • reviewboard.ssh.errors
  • reviewboard.ssh.policy
  • reviewboard.ssh.storage
  • reviewboard.ssh.utils
  • reviewboard.testing.hosting_services
  • reviewboard.testing.queries
  • reviewboard.testing.queries.base
  • reviewboard.testing.queries.http
  • reviewboard.testing.scmtool
  • reviewboard.testing.testcase
  • reviewboard.themes
  • reviewboard.themes.context_processors
  • reviewboard.themes.ui
  • reviewboard.themes.ui.base
  • reviewboard.themes.ui.default
  • reviewboard.themes.ui.registry
  • reviewboard.webapi.auth_backends
  • reviewboard.webapi.base
  • reviewboard.webapi.decorators
  • reviewboard.webapi.errors
  • reviewboard.webapi.mixins
  • reviewboard.webapi.models
  • reviewboard.webapi.server_info
  • reviewboard.webapi.testing
  • reviewboard.webapi.testing.queries
  • reviewboard.webapi.tests.base
  • Frequently Asked Questions
  • General Index
  • Python Module Index
  • Release Notes
  • Root List Resource¶

    The root of the Review Board API resource tree.

    This should be used as a starting point for any clients that need to access any resources in the API. By browsing through the resource tree instead of hard-coding paths, your client can remain compatible with any changes in the resource URI scheme.

    This also contains information on the server and the capabilities of the API. This information was formerly provided only by the Server Info resource, but has been moved here as a convenience to clients.

    URI Templates

    The following URI templates (found in the uri_templates key) can be used to help quickly reach the right API resource.

    Note

    This list may have changed between versions of Review Board, with some items added and some pointing to corrected URLs. In particular, due to a bug on some Python versions, there were differences in Review Board 4.0.x and 5.0/5.0.1.

    Please check the specific URI templates for your version of Review Board if you are having any trouble.

    URI template key

    Resource

    Version Added

    all_diff_comments

    Root Diff Comment List Resource

    5.0.2

    all_file_attachment_comments

    Root File Attachment Comment List Resource

    5.0.2

    all_general_comments

    Root General Comment List Resource

    5.0.1

    all_reviews

    Root Review List Resource

    5.0.1

    api_token

    API Token Resource

    api_tokens

    API Token List Resource

    archived_review_request

    Archived Review Request Resource

    archived_review_requests

    Archived Review Request List Resource

    commit_validation

    Validate Diff Commit List Resource

    default_reviewer

    Default Reviewer Resource

    default_reviewers

    Default Reviewer List Resource

    diff

    Diff Resource

    diffs

    Diff List Resource

    diff_commit

    Diff Commit Resource

    5.0.2

    diff_commits

    Diff Commit List Resource

    5.0.2

    diff_context

    Diff Context Resource

    diff_file_attachment

    Diff File Attachment Resource

    diff_file_attachments

    Diff File Attachment List Resource

    diff_validation

    Validate Diff List Resource

    extension

    Extension Resource

    extensions

    Extension List Resource

    file_diff

    File Diff Resource

    5.0.2

    file_diffs

    File Diff List Resource

    5.0.2

    file_diff_comments

    File Diff Comment List Resource

    file_diff_original

    Original File Resource

    5.0.2

    file_diff_patched

    Patched File Resource

    5.0.2

    group

    Review Group Resource

    groups

    Review Group List Resource

    hosting_service

    Hosting Service Resource

    hosting_services

    Hosting Service List Resource

    hosting_service_account

    Hosting Service Account Resource

    hosting_service_accounts

    Hosting Service Account List Resource

    info

    Server Info Resource

    muted_review_request

    Muted Review Request Resource

    muted_review_requests

    Muted Review Request List Resource

    oauth_app

    OAuth2 Applications Resource

    oauth_apps

    OAuth2 Applications List Resource

    oauth_token

    OAuth2 Tokens Resource

    oauth_tokens

    OAuth2 Tokens List Resource

    remote_repository

    Remote Repository Resource

    remote_repositories

    Remote Repository List Resource

    repository

    Repository Resource

    repositories

    Repository List Resource

    repository_branches

    Repository Branches Resource

    5.0.2

    repository_commits

    Repository Commits Resource

    5.0.2

    repository_group

    Repository Group Resource

    5.0.2

    repository_groups

    Repository Group List Resource

    5.0.2

    repository_info

    Repository Info Resource

    5.0.2

    repository_user

    Repository User Resource

    5.0.2

    repository_users

    Repository User List Resource

    5.0.2

    review

    Review Resource

    reviews

    Review List Resource

    review_diff_comment

    Review Diff Comment Resource

    5.0.2

    review_diff_comments

    Review Diff Comment List Resource

    5.0.2

    review_draft

    Review Draft Resource

    review_general_comment

    Review General Comment Resource

    5.0.2

    review_general_comments

    Review General Comment List Resource

    5.0.2

    review_group_user

    Review Group User Resource

    review_group_users

    Review Group User List Resource

    review_reply

    Review Reply Resource

    5.0.2

    review_replies

    Review Reply List Resource

    5.0.2

    review_reply_draft

    Review Reply Draft Resource

    5.0.2

    review_reply_diff_comment

    Review Reply Diff Comment Resource

    5.0.2

    review_reply_diff_comments

    Review Reply Diff Comment List Resource

    5.0.2

    review_reply_file_attachment_comment

    Review Reply File Attachment Comment Resource

    5.0.2

    review_reply_file_attachment_comments

    Review Reply File Attachment Comment List Resource

    5.0.2

    review_reply_general_comment

    Review Reply General Comment Resource

    5.0.2

    review_reply_general_comments

    Review Reply General Comment List Resource

    5.0.2

    review_reply_screenshot_comment

    Review Reply Screenshot Comment Resource

    5.0.1

    review_reply_screenshot_comments

    Review Reply Screenshot Comment List Resource

    5.0.1

    review_request

    Review Request Resource

    review_requests

    Review Request List Resource

    review_request_change

    Change Resource

    5.0.2

    review_request_changes

    Change List Resource

    5.0.2

    review_request_draft

    Review Request Draft Resource

    5.0.2

    review_request_file_attachment

    File Attachment Resource

    5.0.2

    review_request_file_attachments

    File Attachment List Resource

    5.0.2

    review_request_file_attachment_comments

    File Attachment Comment List Resource

    5.0.2

    review_request_last_update

    Review Request Last Update Resource

    5.0.2

    review_request_status_update

    Status Update Resource

    5.0.2

    review_request_status_updates

    Status Update List Resource

    5.0.2

    root

    Root List Resource

    screenshot

    Screenshot Resource

    screenshots

    Screenshot List Resource

    screenshot_comment

    Review Screenshot Comment Resource

    screenshot_comments

    Screenshot Comment List Resource

    search

    Search Resource

    session

    Session Resource

    user

    User Resource

    users

    User List Resource

    user_file_attachment

    User File Attachment Resource

    user_file_attachments

    User File Attachment List Resource

    validation

    Validation List Resource

    watched

    Watched List Resource

    watched_review_group

    Watched Review Group Resource

    watched_review_groups

    Watched Review Group List Resource

    watched_review_request

    Watched Review Request Resource

    watched_review_requests

    Watched Review Request List Resource

    webhook

    WebHook Resource

    webhooks

    WebHook List Resource

    The following URI templates are considered deprecated, and may be removed in a future version.

    URI template key

    Replacement

    Resource

    Deprecated In

    branches

    repository_branches

    Repository Branches Resource

    5.0.2

    change

    review_request_change

    Change Resource

    5.0.2

    changes

    review_request_changes

    Change List Resource

    5.0.2

    commit

    diff_commit

    Diff Commit Resource

    5.0.2

    commits

    repository_commits

    Repository Commits Resource

    5.0.2

    diff_comment

    review_reply_diff_comment

    Review Reply Diff Comment Resource

    5.0.2

    diff_comments

    review_reply_diff_comments

    Review Reply Diff Comment List Resource

    5.0.2

    draft

    review_request_draft

    Review Request Draft Resource

    5.0.2

    file

    file_diff

    File Diff Resource

    5.0.2

    files

    file_diffs

    File Diff List Resource

    5.0.2

    file_attachment

    review_request_file_attachment

    File Attachment Resource

    5.0.2

    file_attachments

    review_request_file_attachments

    File Attachment List Resource

    5.0.2

    general_comment

    review_general_comment

    Review General Comment Resource

    5.0.2

    general_comments

    review_general_comments

    Review General Comment List Resource

    5.0.2

    last_update

    review_request_last_update

    Review Request Last Update Resource

    5.0.2

    original_file

    file_diff_original_file

    Original File Resource

    5.0.2

    patched_file

    file_diff_patched_file

    Patched File Resource

    5.0.2

    reply

    review_reply

    Review Reply Resource

    5.0.2

    replies

    review_replies

    Review Reply List Resource

    5.0.2

    reply_draft

    review_reply_draft

    Review Reply Draft Resource

    5.0.2

    status_update

    review_request_status_update

    Status Update Resource

    5.0.2

    status_updates

    review_request_status_update

    Status Update List Resource

    5.0.2

    Details¶

    Name root
    URI /api/
    Token Policy ID root
    HTTP Methods
    • GET - Retrieves the list of top-level resources and templates.

    Parent Resource

    None.

    Child Resources
    • Default Reviewer List Resource
    • Extension List Resource
    • Hosting Service Account List Resource
    • Hosting Service List Resource
    • OAuth2 Applications List Resource
    • OAuth2 Tokens List Resource
    • Repository List Resource
    • Review Group List Resource
    • Review Request List Resource
    • Root Diff Comment List Resource
    • Root File Attachment Comment List Resource
    • Root General Comment List Resource
    • Root Review List Resource
    • Search Resource
    • Server Info Resource
    • Session Resource
    • User List Resource
    • Validation List Resource
    • WebHook List Resource

    Links¶

    Name

    Method

    Resource

    all_diff_comments

    GET

    Root List Resource

    all_file_attachment_comments

    GET

    Root List Resource

    all_general_comments

    GET

    Root List Resource

    all_reviews

    GET

    Root List Resource

    default_reviewers

    GET

    Default Reviewer List Resource

    extensions

    GET

    Extension List Resource

    groups

    GET

    Review Group List Resource

    hosting_service_accounts

    GET

    Hosting Service Account List Resource

    hosting_services

    GET

    Hosting Service List Resource

    info

    GET

    Server Info Resource

    oauth_apps

    GET

    OAuth2 Applications List Resource

    oauth_tokens

    GET

    OAuth2 Tokens List Resource

    repositories

    GET

    Repository List Resource

    review_requests

    GET

    Review Request List Resource

    search

    GET

    Search Resource

    self

    GET

    Root List Resource

    session

    GET

    Session Resource

    users

    GET

    User List Resource

    validation

    GET

    Validation List Resource

    webhooks

    GET

    WebHook List Resource

    HTTP GET¶

    Retrieves the list of top-level resources and templates.

    Errors¶

    100 - Does Not ExistHTTP 404 - Not Found Object does not exist
    101 - Permission DeniedHTTP 403 - Forbidden You don’t have permission for this
    103 - Not Logged InHTTP 401 - Unauthorized You are not logged in
    112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden Your OAuth2 token lacks the necessary scopes for this request.
    113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden OAuth2 token access for this resource is prohibited.

    Examples¶

    application/vnd.reviewboard.org.root+json¶

    $ curl https://reviews.example.com/api/ -H "Accept: application/json"
    
    HTTP 200 OK
    Content-Length: 16987
    Content-Type: application/vnd.reviewboard.org.root+json
    ETag: 6b721f2092ef412c0e276141f9c70ec4689c6ede
    Vary: Accept, Cookie
    X-Content-Type-Options: nosniff
    
    {
      "capabilities": {
        "authentication": {
          "client_web_login": true
        },
        "diffs": {
          "base_commit_ids": true,
          "file_attachments": true,
          "max_binary_size": 10485760,
          "max_diff_size": 2097152,
          "moved_files": true,
          "validation": {
            "base_commit_ids": true
          }
        },
        "extra_data": {
          "json_patching": true
        },
        "review_requests": {
          "commit_ids": true,
          "supports_history": true,
          "trivial_publish": true
        },
        "review_uis": {
          "supported_mimetypes": [
            "application/javascript",
            "application/json",
            "application/msword",
            "application/pdf",
            "application/vnd.ms-excel",
            "application/vnd.ms-powerpoint",
            "application/vnd.oasis.opendocument.presentation",
            "application/vnd.oasis.opendocument.spreadsheet",
            "application/vnd.oasis.opendocument.text",
            "application/vnd.openxmlformats-officedocument.presentationml.presentation",
            "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
            "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
            "application/x-javascript",
            "application/x-json",
            "application/x-pdf",
            "application/x-yaml",
            "image/*",
            "text/*",
            "text/markdown",
            "text/x-markdown"
          ]
        },
        "scmtools": {
          "git": {
            "empty_files": true,
            "symlinks": true
          },
          "mercurial": {
            "empty_files": true
          },
          "perforce": {
            "empty_files": true,
            "moved_files": true
          },
          "supported_tools": [
            "bazaar",
            "clearcase",
            "cliosoft_sos",
            "cvs",
            "git",
            "mercurial",
            "perforce",
            "plastic",
            "subversion",
            "tfs",
            "tfs_git",
            "versionvault"
          ],
          "svn": {
            "empty_files": true
          }
        },
        "text": {
          "can_include_raw_values": true,
          "markdown": true,
          "per_field_text_types": true
        }
      },
      "links": {
        "all_diff_comments": {
          "href": "https://reviews.example.com/api/diff-comments/",
          "method": "GET"
        },
        "all_file_attachment_comments": {
          "href": "https://reviews.example.com/api/file-attachment-comments/",
          "method": "GET"
        },
        "all_general_comments": {
          "href": "https://reviews.example.com/api/general-comments/",
          "method": "GET"
        },
        "all_reviews": {
          "href": "https://reviews.example.com/api/reviews/",
          "method": "GET"
        },
        "default_reviewers": {
          "href": "https://reviews.example.com/api/default-reviewers/",
          "method": "GET"
        },
        "extensions": {
          "href": "https://reviews.example.com/api/extensions/",
          "method": "GET"
        },
        "groups": {
          "href": "https://reviews.example.com/api/groups/",
          "method": "GET"
        },
        "hosting_service_accounts": {
          "href": "https://reviews.example.com/api/hosting-service-accounts/",
          "method": "GET"
        },
        "hosting_services": {
          "href": "https://reviews.example.com/api/hosting-services/",
          "method": "GET"
        },
        "info": {
          "href": "https://reviews.example.com/api/info/",
          "method": "GET"
        },
        "oauth_apps": {
          "href": "https://reviews.example.com/api/oauth-apps/",
          "method": "GET"
        },
        "oauth_tokens": {
          "href": "https://reviews.example.com/api/oauth-tokens/",
          "method": "GET"
        },
        "repositories": {
          "href": "https://reviews.example.com/api/repositories/",
          "method": "GET"
        },
        "review_requests": {
          "href": "https://reviews.example.com/api/review-requests/",
          "method": "GET"
        },
        "search": {
          "href": "https://reviews.example.com/api/search/",
          "method": "GET"
        },
        "self": {
          "href": "https://reviews.example.com/api/",
          "method": "GET"
        },
        "session": {
          "href": "https://reviews.example.com/api/session/",
          "method": "GET"
        },
        "users": {
          "href": "https://reviews.example.com/api/users/",
          "method": "GET"
        },
        "validation": {
          "href": "https://reviews.example.com/api/validation/",
          "method": "GET"
        },
        "webhooks": {
          "href": "https://reviews.example.com/api/webhooks/",
          "method": "GET"
        }
      },
      "product": {
        "is_release": true,
        "name": "Review Board",
        "package_version": "7.0.3",
        "version": "7.0.3"
      },
      "site": {
        "administrators": [
          {
            "email": "admin@example.com",
            "name": "Example Admin"
          }
        ],
        "time_zone": "UTC",
        "url": "http://example.com/"
      },
      "stat": "ok",
      "uri_templates": {
        "all_diff_comments": "https://reviews.example.com/api/diff-comments/",
        "all_file_attachment_comments": "https://reviews.example.com/api/file-attachment-comments/",
        "all_general_comments": "https://reviews.example.com/api/general-comments/",
        "all_reviews": "https://reviews.example.com/api/reviews/",
        "api_token": "https://reviews.example.com/api/users/{username}/api-tokens/{api_token_id}/",
        "api_tokens": "https://reviews.example.com/api/users/{username}/api-tokens/",
        "archived_review_request": "https://reviews.example.com/api/users/{username}/archived-review-requests/{review_request_id}/",
        "archived_review_requests": "https://reviews.example.com/api/users/{username}/archived-review-requests/",
        "branches": "https://reviews.example.com/api/repositories/{repository_id}/branches/",
        "change": "https://reviews.example.com/api/review-requests/{review_request_id}/changes/{change_id}/",
        "changes": "https://reviews.example.com/api/review-requests/{review_request_id}/changes/",
        "commit": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/commits/{commit_id}/",
        "commit_validation": "https://reviews.example.com/api/validation/commits/",
        "commits": "https://reviews.example.com/api/repositories/{repository_id}/commits/",
        "default_reviewer": "https://reviews.example.com/api/default-reviewers/{default_reviewer_id}/",
        "default_reviewers": "https://reviews.example.com/api/default-reviewers/",
        "diff": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/",
        "diff_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/{comment_id}/",
        "diff_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/",
        "diff_commit": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/commits/{commit_id}/",
        "diff_commits": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/commits/",
        "diff_context": "https://reviews.example.com/api/review-requests/{review_request_id}/diff-context/",
        "diff_file_attachment": "https://reviews.example.com/api/repositories/{repository_id}/diff-file-attachments/{file_attachment_id}/",
        "diff_file_attachments": "https://reviews.example.com/api/repositories/{repository_id}/diff-file-attachments/",
        "diff_validation": "https://reviews.example.com/api/validation/diffs/",
        "diffs": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/",
        "draft": "https://reviews.example.com/api/review-requests/{review_request_id}/draft/",
        "extension": "https://reviews.example.com/api/extensions/{extension_name}/",
        "extensions": "https://reviews.example.com/api/extensions/",
        "file": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/",
        "file_attachment": "https://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/",
        "file_attachment_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/file-attachment-comments/{comment_id}/",
        "file_attachment_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/file-attachment-comments/",
        "file_attachments": "https://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/",
        "file_diff": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/",
        "file_diff_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/diff-comments/",
        "file_diff_original_file": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/original-file/",
        "file_diff_patched_file": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/patched-file/",
        "file_diffs": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/",
        "files": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/",
        "general_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/general-comments/{comment_id}/",
        "general_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/general-comments/",
        "group": "https://reviews.example.com/api/groups/{group_name}/",
        "groups": "https://reviews.example.com/api/groups/",
        "hosting_service": "https://reviews.example.com/api/hosting-services/{hosting_service_id}/",
        "hosting_service_account": "https://reviews.example.com/api/hosting-service-accounts/{account_id}/",
        "hosting_service_accounts": "https://reviews.example.com/api/hosting-service-accounts/",
        "hosting_services": "https://reviews.example.com/api/hosting-services/",
        "info": "https://reviews.example.com/api/info/",
        "last_update": "https://reviews.example.com/api/review-requests/{review_request_id}/last-update/",
        "muted_review_request": "https://reviews.example.com/api/users/{username}/muted-review-requests/{review_request_id}/",
        "muted_review_requests": "https://reviews.example.com/api/users/{username}/muted-review-requests/",
        "oauth_app": "https://reviews.example.com/api/oauth-apps/{app_id}/",
        "oauth_apps": "https://reviews.example.com/api/oauth-apps/",
        "oauth_token": "https://reviews.example.com/api/oauth-tokens/{oauth_token_id}/",
        "oauth_tokens": "https://reviews.example.com/api/oauth-tokens/",
        "original_file": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/original-file/",
        "patched_file": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/patched-file/",
        "remote_repositories": "https://reviews.example.com/api/hosting-service-accounts/{account_id}/remote-repositories/",
        "remote_repository": "https://reviews.example.com/api/hosting-service-accounts/{account_id}/remote-repositories/{repository_id}/",
        "replies": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/",
        "reply": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/",
        "reply_draft": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/draft/",
        "repositories": "https://reviews.example.com/api/repositories/",
        "repository": "https://reviews.example.com/api/repositories/{repository_id}/",
        "repository_branches": "https://reviews.example.com/api/repositories/{repository_id}/branches/",
        "repository_commits": "https://reviews.example.com/api/repositories/{repository_id}/commits/",
        "repository_group": "https://reviews.example.com/api/repositories/{repository_id}/groups/{group_name}/",
        "repository_groups": "https://reviews.example.com/api/repositories/{repository_id}/groups/",
        "repository_info": "https://reviews.example.com/api/repositories/{repository_id}/info/",
        "repository_user": "https://reviews.example.com/api/repositories/{repository_id}/users/{username}/",
        "repository_users": "https://reviews.example.com/api/repositories/{repository_id}/users/",
        "review": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/",
        "review_diff_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/diff-comments/{comment_id}/",
        "review_diff_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/diff-comments/",
        "review_draft": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/draft/",
        "review_general_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/general-comments/{comment_id}/",
        "review_general_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/general-comments/",
        "review_group_user": "https://reviews.example.com/api/groups/{group_name}/users/{username}/",
        "review_group_users": "https://reviews.example.com/api/groups/{group_name}/users/",
        "review_replies": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/",
        "review_reply": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/",
        "review_reply_diff_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/{comment_id}/",
        "review_reply_diff_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/",
        "review_reply_draft": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/draft/",
        "review_reply_file_attachment_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/file-attachment-comments/{comment_id}/",
        "review_reply_file_attachment_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/file-attachment-comments/",
        "review_reply_general_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/general-comments/{comment_id}/",
        "review_reply_general_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/general-comments/",
        "review_reply_screenshot_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/screenshot-comments/{comment_id}/",
        "review_reply_screenshot_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/screenshot-comments/",
        "review_request": "https://reviews.example.com/api/review-requests/{review_request_id}/",
        "review_request_change": "https://reviews.example.com/api/review-requests/{review_request_id}/changes/{change_id}/",
        "review_request_changes": "https://reviews.example.com/api/review-requests/{review_request_id}/changes/",
        "review_request_draft": "https://reviews.example.com/api/review-requests/{review_request_id}/draft/",
        "review_request_file_attachment": "https://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/",
        "review_request_file_attachment_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/file-attachment-comments/",
        "review_request_file_attachments": "https://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/",
        "review_request_last_update": "https://reviews.example.com/api/review-requests/{review_request_id}/last-update/",
        "review_request_status_update": "https://reviews.example.com/api/review-requests/{review_request_id}/status-updates/{status_update_id}/",
        "review_request_status_updates": "https://reviews.example.com/api/review-requests/{review_request_id}/status-updates/",
        "review_requests": "https://reviews.example.com/api/review-requests/",
        "reviews": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/",
        "root": "https://reviews.example.com/api/",
        "screenshot": "https://reviews.example.com/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/",
        "screenshot_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/screenshot-comments/{comment_id}/",
        "screenshot_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/screenshot-comments/",
        "screenshots": "https://reviews.example.com/api/review-requests/{review_request_id}/screenshots/",
        "search": "https://reviews.example.com/api/search/{username}/",
        "session": "https://reviews.example.com/api/session/",
        "status_update": "https://reviews.example.com/api/review-requests/{review_request_id}/status-updates/{status_update_id}/",
        "status_updates": "https://reviews.example.com/api/review-requests/{review_request_id}/status-updates/",
        "user": "https://reviews.example.com/api/users/{username}/",
        "user_file_attachment": "https://reviews.example.com/api/users/{username}/user-file-attachments/{file_attachment_id}/",
        "user_file_attachments": "https://reviews.example.com/api/users/{username}/user-file-attachments/",
        "users": "https://reviews.example.com/api/users/",
        "validation": "https://reviews.example.com/api/validation/",
        "watched": "https://reviews.example.com/api/users/{username}/watched/",
        "watched_review_group": "https://reviews.example.com/api/users/{username}/watched/review-groups/{watched_obj_id}/",
        "watched_review_groups": "https://reviews.example.com/api/users/{username}/watched/review-groups/",
        "watched_review_request": "https://reviews.example.com/api/users/{username}/watched/review-requests/{watched_obj_id}/",
        "watched_review_requests": "https://reviews.example.com/api/users/{username}/watched/review-requests/",
        "webhook": "https://reviews.example.com/api/webhooks/{webhook_id}/",
        "webhooks": "https://reviews.example.com/api/webhooks/"
      }
    }
    

    Keep up with the latest Review Board releases, security updates, and helpful information.

    About
    News
    Demo
    RBCommons Hosting
    Integrations
    Happy Users
    Support Options
    Documentation
    FAQ
    User Manual
    RBTools
    Administration Guide
    Power Pack
    Release Notes
    Downloads
    Review Board
    RBTools
    Djblets
    Power Pack
    Package Store
    PGP Signatures
    Contributing
    Bug Tracker
    Submit Patches
    Development Setup
    Wiki
    Follow Us
    Mailing Lists
    Reddit
    Twitter
    Mastodon
    Facebook
    YouTube

    Copyright © 2006-2025 Beanbag, Inc. All rights reserved.

    Terms of Service — Privacy Policy — AI Ethics Policy — Branding

    On this page

    • [Top]
    • Details
    • Links
    • HTTP GET
      • Errors
    • Examples
      • application/vnd.reviewboard.org.root+json