Extension List Resource¶

Review Board’s extension resource.

This resource special-cases the one in Djblets to provide API token and OAuth token access.

Details¶

Name	`extensions`
URI	`/api/extensions/`
Token Policy ID	`extension`
HTTP Methods	GET - Returns the list of known extensions.
Parent Resource	Root List Resource
Child Resources	Extension Resource

Links¶

Name	Method	Resource
self	GET	Extension List Resource

HTTP GET¶

Returns the list of known extensions.

Each extension in the list has been installed, but may not be enabled.

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.extensions+json¶

$ curl https://reviews.example.com/api/extensions/ -H "Accept: application/json"

HTTP 200 OK
Content-Length: 1453
Content-Type: application/vnd.reviewboard.org.extensions+json
ETag: a06d986836ddff2f57d52f1c77f9cf1a54354eab
Item-Content-Type: application/vnd.reviewboard.org.extension+json
Vary: Accept, Cookie
X-Content-Type-Options: nosniff

{
  "extensions": [
    {
      "author": null,
      "author_url": null,
      "can_disable": false,
      "can_enable": false,
      "class_name": "rbintegrations.extension.RBIntegrationsExtension",
      "enabled": true,
      "installed": true,
      "links": {
        "self": {
          "href": "https://reviews.example.com/api/extensions/rbintegrations.extension.RBIntegrationsExtension/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/extensions/rbintegrations.extension.RBIntegrationsExtension/",
          "method": "PUT"
        }
      },
      "load_error": "This extension is not installed or could not be found. Try re-installing it and then click \"Reload Extensions\".",
      "loadable": false,
      "name": "Integrations",
      "summary": null,
      "version": null
    },
    {
      "author": null,
      "author_url": null,
      "can_disable": false,
      "can_enable": false,
      "class_name": "reviewbotext.extension.ReviewBotExtension",
      "enabled": false,
      "installed": true,
      "links": {
        "self": {
          "href": "https://reviews.example.com/api/extensions/reviewbotext.extension.ReviewBotExtension/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/extensions/reviewbotext.extension.ReviewBotExtension/",
          "method": "PUT"
        }
      },
      "load_error": "This extension is not installed or could not be found. Try re-installing it and then click \"Reload Extensions\".",
      "loadable": false,
      "name": "Review Bot",
      "summary": null,
      "version": null
    }
  ],
  "links": {
    "self": {
      "href": "https://reviews.example.com/api/extensions/",
      "method": "GET"
    }
  },
  "stat": "ok",
  "total_results": 2
}