Jump to >

This documentation covers the in-development release of Review Board. You can see the latest stable docs or all previous versions.

Root List Resource

Links to all the main resources, including URI templates to resources anywhere in the 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.

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

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: 10968
Content-Type: application/vnd.reviewboard.org.root+json
ETag: ad591e3d1a3b258811445d0a4b59ac5ad4d62b9e
Vary: Accept, Cookie
X-Content-Type-Options: nosniff
{
  "capabilities": {
    "diffs": {
      "base_commit_ids": true,
      "moved_files": true,
      "validation": {
        "base_commit_ids": true
      }
    },
    "extra_data": {
      "json_patching": true
    },
    "review_requests": {
      "commit_ids": true,
      "supports_history": true,
      "trivial_publish": true
    },
    "scmtools": {
      "git": {
        "empty_files": true,
        "symlinks": true
      },
      "mercurial": {
        "empty_files": true
      },
      "perforce": {
        "empty_files": true,
        "moved_files": true
      },
      "svn": {
        "empty_files": true
      }
    },
    "text": {
      "can_include_raw_values": true,
      "markdown": true,
      "per_field_text_types": true
    }
  },
  "links": {
    "default_reviewers": {
      "href": "https://reviews.example.com/api/default-reviewers/",
      "method": "GET"
    },
    "extensions": {
      "href": "https://reviews.example.com/api/extensions/",
      "method": "GET"
    },
    "file_attachment_comments": {
      "href": "https://reviews.example.com/api/file-attachment-comments/",
      "method": "GET"
    },
    "general_comments": {
      "href": "https://reviews.example.com/api/general-comments/",
      "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_diff_comments": {
      "href": "https://reviews.example.com/api/review-diff-comments/",
      "method": "GET"
    },
    "review_requests": {
      "href": "https://reviews.example.com/api/review-requests/",
      "method": "GET"
    },
    "reviews": {
      "href": "https://reviews.example.com/api/reviews/",
      "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": "5.0",
    "version": "5.0"
  },
  "site": {
    "administrators": [
      {
        "email": "admin@example.com",
        "name": "Example Admin"
      }
    ],
    "time_zone": "UTC",
    "url": "http://example.com/"
  },
  "stat": "ok",
  "uri_templates": {
    "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/review-requests/{review_request_id}/diffs/{diff_revision}/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_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/file-attachment-comments/{comment_id}/",
    "file_attachment_comments": "https://reviews.example.com/api/file-attachment-comments/",
    "file_attachments": "https://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/",
    "files": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/",
    "general_comment": "https://reviews.example.com/api/general-comments/{comment_id}/",
    "general_comments": "https://reviews.example.com/api/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_group": "https://reviews.example.com/api/repositories/{repository_id}/groups/{group_name}/",
    "repository_groups": "https://reviews.example.com/api/repositories/{repository_id}/groups/",
    "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-diff-comments/{comment_id}/",
    "review_diff_comments": "https://reviews.example.com/api/review-diff-comments/",
    "review_draft": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/draft/",
    "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_request": "https://reviews.example.com/api/review-requests/{review_request_id}/",
    "review_requests": "https://reviews.example.com/api/review-requests/",
    "reviews": "https://reviews.example.com/api/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/"
  }
}