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 |
---|---|---|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.1 |
|
|
5.0.1 |
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
5.0.2 |
|
|
5.0.2 |
|
|
||
|
||
|
||
|
||
|
||
|
||
|
5.0.2 |
|
|
5.0.2 |
|
|
||
|
5.0.2 |
|
|
5.0.2 |
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
||
|
||
|
5.0.2 |
|
|
5.0.2 |
|
|
||
|
5.0.2 |
|
|
5.0.2 |
|
|
||
|
||
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.1 |
|
|
5.0.1 |
|
|
||
|
||
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
5.0.2 |
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
The following URI templates are considered deprecated, and may be removed in a future version.
URI template key |
Replacement |
Resource |
Deprecated In |
---|---|---|---|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
|
|
|
5.0.2 |
Details¶
Name | root |
URI | /api/ |
Token Policy ID | root |
HTTP Methods |
|
Parent Resource | None. |
Child Resources |
|
Links¶
Name |
Method |
Resource |
---|---|---|
all_diff_comments | GET |
|
all_file_attachment_comments | GET |
|
all_general_comments | GET |
|
all_reviews | GET |
|
default_reviewers | GET |
|
extensions | GET |
|
groups | GET |
|
hosting_service_accounts | GET |
|
hosting_services | GET |
|
info | GET |
|
oauth_apps | GET |
|
oauth_tokens | GET |
|
repositories | GET |
|
review_requests | GET |
|
search | GET |
|
self | GET |
|
session | GET |
|
users | GET |
|
validation | GET |
|
webhooks | GET |
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: 17000
Content-Type: application/vnd.reviewboard.org.root+json
ETag: 49f6a927afd474fee340bb4a63f128b0e87e3740
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": false,
"name": "Review Board",
"package_version": "8.0a0",
"version": "8.0 alpha 0 (dev)"
},
"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/"
}
}