Reviewers

Note

These APIs are experimental and are currently being worked on. Endpoints may change without warning. Consider the v3 API if you need stability. The only authentication method available at the moment is the internal one.

Subscribe

This endpoint allows you to subscribe the current user to the notification sent when a new listed version is submitted on a particular add-on.

Note

Requires authentication and the current user to have any reviewer-related permission.

POST /api/v4/reviewers/addon/(int: addon_id)/subscribe/

Unsubscribe

This endpoint allows you to unsubscribe the current user to the notification sent when a new listed version is submitted on a particular add-on.

Note

Requires authentication and the current user to have any reviewer-related permission.

POST /api/v4/reviewers/addon/(int: addon_id)/unsubscribe/

Disable

This endpoint allows you to disable the public listing for an add-on.

Note

Requires authentication and the current user to have Reviews:Admin
permission.
POST /api/v4/reviewers/addon/(int: addon_id)/disable/

Enable

This endpoint allows you to re-enable the public listing for an add-on. If the add-on can’t be public because it does not have public versions, it will instead be changed to awaiting review or incomplete depending on the status of its versions.

Note

Requires authentication and the current user to have Reviews:Admin permission.

POST /api/v4/reviewers/addon/(int: addon_id)/enable/

Flags

This endpoint allows you to manipulate various reviewer-specific flags on an add-on.

Note

Requires authentication and the current user to have Reviews:Admin permission.

PATCH /api/v4/reviewers/addon/(int: addon_id)/flags/
Response JSON Object:
 
  • auto_approval_disabled (boolean) – Boolean indicating whether auto approval are disabled on an add-on or not. When it’s true, new versions for this add-on will make it appear in the regular reviewer queues instead of being auto-approved.
  • pending_info_request (string|null) – Deadline date for the pending info request as a string, or null.
  • needs_admin_code_review (boolean) – Boolean indicating whether the add-on needs its code to be reviewed by an admin or not.
  • needs_admin_content_review (boolean) – Boolean indicating whether the add-on needs its content to be reviewed by an admin or not.

Browse

This endpoint allows you to browse through the contents of an Add-on version.

Note

Requires authentication and the current user to have ReviewerTools:View permission for listed add-ons as well as Addons:ReviewUnlisted for unlisted add-ons. Additionally the current user can also be the owner of the add-on.

GET /api/v4/reviewers/browse/(int: version_id)/

Inherits most properties from version detail except files.

Parameters:
  • file – The specific file in the XPI to retrieve. Defaults to manifest.json, install.rdf or package.json for Add-ons as well as the XML file for search engines.
Response JSON Object:
 
  • validation_url_json (string) – The url to the addons-linter validation report, rendered as JSON.
  • validation_url (string) – The url to the addons-linter validation report, rendered as HTML.
  • has_been_validated (boolean) – True if the version has been validated through addons-linter.
  • file (object) – The file attached to this version. See version detail -> files[] for more details.
  • file.content (string) – Raw content of the requested file.
  • file.entries[].binary (boolean/string) – True if the file is a binary file (e.g an .exe, dll, java, swf file), 'image' if the file is an image or False otherwise. If False or 'image' the file should be presentable to the user.
  • file.entries[].depth (image) – Level of folder-tree depth, starting with 0.
  • file.entries[].is_directory (boolean) – Wheather the file is a directory.
  • file.entries[].filename (string) – The filename of the file.
  • file.entries[].path (string) – The absolute path (from the root of the XPI) of the file.
  • file.entries[].sha256 (string) – SHA256 hash.
  • file.entries[].mimetype (string) – The determined mimetype of the file or application/octet-stream if none could be determined.
  • file.entries[].size (int) – The size in bytes.
  • file.entries[].modified (string) – The exact time of the commit, should be equivalent with created.