Search

This endpoint allows you to search through public add-ons.

GET/api/v5/addons/search/

Query Parameters:

• q (string) – The search query. The maximum length allowed is 100 characters.

• app (string) – Filter byadd-on application availability.

• appversion (string) – Filter by application version compatibility. Pass the full version as a string, e.g.46.0. Only valid when theapp parameter is also present.

• author (string) – Filter by exact (listed) author username or user id. Multiple author usernames or ids can be specified, separated by comma(s), in which case add-ons with at least one matching author are returned.

• category (string) – Filter bycategory slug.app andtype parameters need to be set, otherwise this parameter is ignored.

• color (string) – (Experimental) Filter by color in RGB hex format, trying to find themes that approximately match the specified color. Only works for static themes.

• created (string) – Filter to add-on that have a creation date matching athreshold value.YYYY-MM-DD,YYYY-MM-DDTHH:MM,YYYY-MM-DDTHH:MM:SS or milliseconds timestamps are supported.

• exclude_addons (string) – Exclude add-ons byslug orid. Multiple add-ons can be specified, separated by comma(s).

• guid (string) – Filter by exact add-on guid. Multiple guids can be specified, separated by comma(s), in which case any add-ons matching any of the guids will be returned. As guids are unique there should be at most one add-on result per guid specified. For usage with Firefox, instead of separating multiple guids by comma(s), a single guid can be passed in base64url format, prefixed by therta: string.

• lang (string) – Activate translations in the specific language for that query. (Seetranslated fields)

• page (int) – 1-based page number. Defaults to 1.

• page_size (int) – Maximum number of results to return for the requested page. Defaults to 25.

• promoted (string) – Filter to add-ons in a specificpromoted category. Can be combined withapp. Multiple promoted categories can be specified, separated by comma(s), in which case any add-ons in any of the promotions will be returned.

• ratings (string) – Filter to add-ons that have average ratings of athreshold value.

• sort (string) – The sort parameter. The available parameters are documented in thetable below.

• tag (string) – Filter by exact tag name. Multiple tag names can be specified, separated by comma(s), in which case add-ons containingall specified tags are returned. Seeavailable tags

• type (string) – Filter byadd-on type. Multiple types can be specified, separated by comma(s), in which case add-ons that are any of the matching types are returned.

• updated (string) – Filter to add-on that have a last updated date matching athreshold value.YYYY-MM-DD,YYYY-MM-DDTHH:MM,YYYY-MM-DDTHH:MM:SS or milliseconds timestamps are supported.

• users (string) – Filter to add-ons that have average daily users of athreshold value.

Response JSON Object:

• count (int) – The number of results for this query.

• next (string) – The URL of the next page of results.

• previous (string) – The URL of the previous page of results.

• results (array) – An array ofadd-ons. As described below, the following fields are omitted for performance reasons:release_notes andlicense fields oncurrent_version as well aspicture_url fromauthors. The special_score property is added to each add-on object, it contains a float value representing the relevancy of each add-on for the given query.

Available sorting parameters:

Parameter	Description
created	Creation date, descending.
downloads	Number of weekly downloads, descending.
hotness	Hotness (average number of users progression), descending.
random	Random ordering. Only available when no search query ispassed and when filtering to only return promoted add-ons.
ratings	Bayesian rating, descending.
rating	Bayesian rating, descending (deprecated, backwards-compatibility only).
recommended	Promoted addons in the recommended category abovenon-recommended add-ons. Only available combined withanother sort - ignored on its own.Also ignored if combined with relevance as it already takesinto account recommended status.
relevance	Search query relevance, descending. Ignored without aquery.
updated	Last updated date, descending.
users	Average number of daily users, descending.

The default behavior is to sort by relevance if a search query (q)is present; otherwise place recommended add-ons first, then non recommendedadd-ons, then sorted by average daily users, descending. (sort=recommended,users).This is the default on AMO dev server.

You can combine multiple parameters by separating them with a comma.For instance, to sort search results by downloads and then by creationdate, usesort=downloads,created. The only exception is therandomsort parameter, which is only available alone.

Threshold style parameters allow queries against numeric or date-time values using comparison.

The following is supported (examples for query parameterfoo):

• greater thanfoo__gt (example query: ?foo__gt=10.1)

• less thanfoo__lt (example query: ?foo__lt=10.1)

• greater than or equal tofoo__gte (example query: ?foo__gte=10.1)

• less than or equal tofoo__lte (example query: ?foo__lte=10.1)

• equal tofoo (example query: ?foo=10.1)

Autocomplete

Similar toadd-ons search endpoint above, this endpointallows you to search through public add-ons. Because it’s meant as a backendfor autocomplete though, there are a couple key differences:

• No pagination is supported. There are nonext,prev orcountfields, and passingpage_size orpage has no effect, a maximum of 10results will be returned at all times.

• Only a subset of fields are returned.

• sort is not supported. Sort order is alwaysrelevance ifq isprovided, or thesearch default otherwise.

GET/api/v5/addons/autocomplete/

Query Parameters:

• q (string) – The search query.

• app (string) – Filter byadd-on application availability.

• appversion (string) – Filter by application version compatibility. Pass the full version as a string, e.g.46.0. Only valid when theapp parameter is also present.

• author (string) – Filter by exact (listed) author username. Multiple author names can be specified, separated by comma(s), in which case add-ons with at least one matching author are returned.

• category (string) – Filter bycategory slug.app andtype parameters need to be set, otherwise this parameter is ignored.

• lang (string) – Activate translations in the specific language for that query. (Seetranslated fields)

• tag (string) – Filter by exact tag name. Multiple tag names can be specified, separated by comma(s), in which case add-ons containingall specified tags are returned. Seeavailable tags

• type (string) – Filter byadd-on type.

Response JSON Object:

• results (array) – An array ofadd-ons. Only theid,icon_url,icons,name,promoted,type andurl fields are supported though.

Detail

This endpoint allows you to fetch a specific add-on by id, slug or guid.

Note

Non-public add-ons and add-ons with only unlisted versions require bothauthentication and reviewer permissions or an account listed as adeveloper of the add-on.

A 401 or 403 error response will be returned when clients don’t meetthose requirements. Those responses will contain the followingproperties:

• detail: string containing a message about the error.

• is_disabled_by_developer: boolean set totrue when the add-on has been voluntarily disabled by its developer.

• is_disabled_by_mozilla: boolean set totrue when the add-on has been disabled by Mozilla.

GET/api/v5/addons/addon/(int:id|string:slug|string:guid)/

Query Parameters:

• app (string) – Used in conjunction withappversion below to altercurrent_version behaviour. Need to be a validadd-on application.

• appversion (string) – Makecurrent_version return the latest public version of the add-on compatible with the given application version, if possible, otherwise fall back on the generic implementation. Pass the full version as a string, e.g.46.0. Only valid when theapp parameter is also present. Currently only compatible with language packs through the add-on detail API, ignored for other types of add-ons and APIs.

• lang (string) – Activate translations in the specific language for that query. (SeeTranslated Fields)

• show_grouped_ratings (boolean) – Whether or not to show ratings aggregates in theratings object (Use “true”/”1” as truthy values, “0”/”false” as falsy ones).

Response JSON Object:

• id (int) – The add-on id on AMO.

• authors (array) – Array holding information about the authors for the add-on.

• authors[].id (int) – The user id for an author.

• authors[].name (string) – The name for an author.

• authors[].url (string) – The link to the profile page for an author.

• authors[].username (string) – The username for an author.

• authors[].picture_url (string) – URL to a photo of the user, or/static/img/anon_user.png if not set. For performance reasons this field is omitted from the search endpoint.

• average_daily_users (int) – The average number of users for the add-on (updated daily).

• categories (object) – Object holding the categories the add-on belongs to.

• categories[app_name] (array) – Array holding thecategory slugs the add-on belongs to for a givenadd-on application. (Combine with the add-ontype to determine the name of the category).

• contributions_url (object|null) – URL to the (external) webpage where the addon’s authors collect monetary contributions, if set. Can be an empty value. (SeeOutgoing Links)

• created (string) – The date the add-on was created.

• current_version (object) – Object holding the currentversion of the add-on. For performance reasons thelicense field omits thetext property from both the search and detail endpoints.

• default_locale (string) – The add-on default locale for translations.

• description (object|null) – The add-on description (Seetranslated fields). This field might contain markdown.

• developer_comments (object|null) – Additional information about the add-on provided by the developer. (Seetranslated fields).

• edit_url (string) – The URL to the developer edit page for the add-on.

• guid (string) – The add-onextension identifier.

• has_eula (boolean) – The add-on has an End-User License Agreement that the user needs to agree with before installing (Seeadd-on EULA and privacy policy).

• has_privacy_policy (boolean) – The add-on has a Privacy Policy (Seeadd-on EULA and privacy policy).

• homepage (object|null) – The add-on homepage (Seetranslated fields andOutgoing Links).

• icon_url (string) – The URL to icon for the add-on (including a cachebusting query string).

• icons (object) – An object holding the URLs to an add-ons icon including a cachebusting query string as values and their size as properties. Currently exposes 32, 64, 128 pixels wide icons.

• is_disabled (boolean) – Whether the add-on is disabled or not.

• is_experimental (boolean) – Whether the add-on has been marked by the developer as experimental or not.

• is_noindexed (boolean|null) – Whether the add-on should be indexed or not indexed for SEO. Note that the search endpoint will always return anull value.

• name (object|null) – The add-on name (Seetranslated fields).

• last_updated (string) – The date of the last time the add-on was updated by its developer(s).

• latest_unlisted_version (object|null) – Object holding the latest unlistedversion of the add-on. This field is only present if the user has unlisted reviewer permissions, or is listed as a developer of the add-on.

• previews (array) – Array holding information about the previews for the add-on.

• previews[].id (int) – The id for a preview.

• previews[].caption (object|null) – The caption describing a preview (Seetranslated fields).

• previews[].image_size[] (int) – width, height dimensions of of the preview image.

• previews[].image_url (string) – The URL (including a cachebusting query string) to the preview image.

• position (int) – The position in the list of previews images.

• previews[].thumbnail_size[] (int) – width, height dimensions of of the preview image thumbnail.

• previews[].thumbnail_url (string) – The URL (including a cachebusting query string) to the preview image thumbnail.

• promoted (array) – Array holding promotion information about the add-on.

• promoted[].category (string) – The name of thepromoted category for the add-on.

• promoted[].apps[] (array) – Array of theapplications for which the add-on is promoted.

• ratings (object) – Object holding ratings summary information about the add-on.

• ratings.count (int) – The total number of user ratings for the add-on.

• ratings.text_count (int) – The number of user ratings with review text for the add-on.

• ratings_url (string) – The URL to the user ratings list page for the add-on.

• ratings.average (float) – The average user rating for the add-on.

• ratings.bayesian_average (float) – The bayesian average user rating for the add-on.

• ratings.grouped_counts (object) – Object with aggregate counts for ratings. Only included whenshow_grouped_ratings is present in the request.

• ratings.grouped_counts.1 (int) – the count of ratings with a score of 1.

• ratings.grouped_counts.2 (int) – the count of ratings with a score of 2.

• ratings.grouped_counts.3 (int) – the count of ratings with a score of 3.

• ratings.grouped_counts.4 (int) – the count of ratings with a score of 4.

• ratings.grouped_counts.5 (int) – the count of ratings with a score of 5.

• requires_payment (boolean) – Does the add-on require payment, non-free services or software, or additional hardware.

• review_url (string) – The URL to the reviewer review page for the add-on.

• slug (string) – The add-on slug.

• status (string) – Theadd-on status.

• summary (object|null) – The add-on summary (Seetranslated fields).

• support_email (object|null) – The add-on support email (Seetranslated fields).

• support_url (object|null) – The add-on support URL (Seetranslated fields andOutgoing Links).

• tags (array) – List containing the tag names set on the add-on.

• type (string) – Theadd-on type.

• url (string) – The (absolute) add-on detail URL.

• version (object) – For create or update requests that included aversion only. Object holding theversion that was submitted.

• versions_url (string) – The URL to the version history page for the add-on.

• weekly_downloads (int) – The number of downloads for the add-on in the last week. Not present for lightweight themes.

Possible values for the add-onstatus field / parameter:

Value	Description
public	Approved
deleted	Deleted
disabled	Disabled by Mozilla
nominated	Awaiting Review
incomplete	Incomplete - no approved listed versions

Possible values for the keys in thecompatibility field, as well as theapp parameter in the search API:

Value	Description
android	Firefox for Android
firefox	Firefox

Note

See thesupported versions.

Possible values for thetype field / parameter:

Note

For backwards-compatibility reasons, the value for type ofthemerefers to a deprecated XUL Complete Theme.persona are anothertype of depreated theme.New webextension packaged non-dynamic themes arestatictheme.

Value	Description
theme	Depreated. Theme (Complete Theme, XUL-based)
search	Search Engine
persona	Deprecated. Theme (Lightweight Theme, persona)
language	Language Pack (Application)
extension	Extension
dictionary	Dictionary
statictheme	Theme (Static Theme)

Possible values for thepromoted.category field:

Value	Description
line	“By Firefox” category
notable	Notable category
recommended	Recommended category
spotlight	Spotlight category
strategic	Strategic category
badged	A meta category that’s available for thepromotedsearch filter that is all the categories we expect an APIclient to expose as “reviewed” by Mozilla.Currently equal toline&recommended.

Create

This endpoint allows a submission of an upload to create a new add-on and setting other AMO metadata.

To create an add-on with a listed version from an upload (anuploadthat has channel ==listed) certain metadata must be defined - a versionlicense, anadd-onname, an add-onsummary, and add-on categories for each app the versionis compatible with.

Note

This API requiresauthentication.

POST/api/v5/addons/addon/

Request JSON Object:

• categories (object) – Object holding the categories the add-on belongs to.

• categories[app_name] (array) – Array holding thecategory slugs the add-on belongs to for a givenadd-on application.

• contributions_url (string) – URL to the (external) webpage where the addon’s authors collect monetary contributions. Only a limited number of services aresupported.

• default_locale (string) – The fallback locale for translated fields for this add-on. Note this only applies to the fields here - the default locale forversion release notes and custom license text is fixed toen-US.

• description (object|null) – The add-on description (Seetranslated fields). This field can contain some Markdown.

• developer_comments (object|null) – Additional information about the add-on. (Seetranslated fields).

• homepage (object|null) – The add-on homepage (Seetranslated fields andOutgoing Links).

• is_disabled (boolean) – Whether the add-on is disabled or not.

• is_experimental (boolean) – Whether the add-on should be marked as experimental or not.

• name (object|null) – The add-on name (Seetranslated fields).

• requires_payment (boolean) – Does the add-on require payment, non-free services or software, or additional hardware.

• slug (string) – The add-on slug. Valid slugs must only contain letters, numbers (categories L and N),-,_,~, and can’t be all numeric.

• summary (object|null) – The add-on summary (Seetranslated fields).

• support_email (object|null) – The add-on support email (Seetranslated fields).

• tags (array) – List containing the tag names to set on the add-on - seeavailable tags.

• version (object) – Object containing theversion to create this addon with.

Response:Seeadd-on

Edit

This endpoint allows an add-on’s AMO metadata to be edited.

Note

This API requiresauthentication, and for the user to be an author of the add-on.

PATCH/api/v5/addons/addon/(int:id|string:slug|string:guid)/

Request JSON Object:

• categories (object) – Object holding the categories the add-on belongs to.

• categories[app_name] (array) – Array holding thecategory slugs the add-on belongs to for a givenadd-on application.

• contributions_url (string) –

  URL to the (external) webpage where the addon’s authors collect monetary contributions. Only a limited number of services aresupported.

• default_locale (string) – The fallback locale for translated fields for this add-on. Note this only applies to the fields here - the default locale forversion release notes and custom license text is fixed toen-US.

• description (object|null) – The add-on description (Seetranslated fields). This field can contain some Markdown.

• developer_comments (object|null) – Additional information about the add-on. (Seetranslated fields).

• homepage (object|null) – The add-on homepage (Seetranslated fields andOutgoing Links).

• icon (null) – To clear the icon, i.e. revert to the default add-on icon, sendnull. Seeaddon icon to upload a new icon.

• is_disabled (boolean) – Whether the add-on is disabled or not. Note: if the add-on status isdisabled the response will always bedisabled=true regardless.

• is_experimental (boolean) – Whether the add-on should be marked as experimental or not.

• name (object|null) – The add-on name (Seetranslated fields).

• requires_payment (boolean) – Does the add-on require payment, non-free services or software, or additional hardware.

• slug (string) –

  The add-on slug. Valid slugs must only contain letters, numbers (categories L and N),-,_,~, and can’t be all numeric.

• summary (object|null) – The add-on summary (Seetranslated fields).

• support_email (object|null) – The add-on support email (Seetranslated fields).

• tags (array) – List containing the tag names to set on the add-on - seeavailable tags.

Put - Create or Edit

This endpoint allows a submission of an upload, which will either update an existing add-on and create a new version if the guid already exists, or will create a new add-on if the guid does not exist.See theAdd-on Create documentation for details of the request and restrictions.

Note

This API requiresauthentication, and for the user to be an author of the add-on if the add-on exists already.

Note

The guid in the url must match a guid specified in the manifest.

Note

A submission that results in a new add-on will have metadata defaults taken from the manifest (e.g. name), but a submission that updates an existing listing will not use data from the manifest.

PUT/api/v5/addons/addon/(string:guid)/

Delete

This endpoint allows an add-on to be deleted.Because add-on deletion is an irreversible and destructive action an additional token must be retrieved beforehand, and passed as a parameter to the delete endpoint.Deleting the add-on will permanently delete all versions and files submitted for this add-on, listed or not.All versions will be soft-blocked (restricted), which will disable and prevent any further installation in Firefox. Existing users can choose to re-enable the add-on.The add-on ID (guid) cannot be restored and will forever be unusable for submission.

Note

This API requiresauthentication, and for the user to be an owner of the add-on..

DELETE/api/v5/addons/addon/(int:id|string:slug|string:guid)/

Query Parameters:

• delete_confirm (string) – the confirmation token from thedelete confirm endpoint.

Versions List

This endpoint allows you to list all versions belonging to a specific add-on.

GET/api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/versions/

Note

Non-public add-ons and add-ons with only unlisted versions require both:

• authentication

• reviewer permissions or an account listed as a developer of the add-on

Query Parameters:

• filter (string) – Thefilter to apply.

• lang (string) – Activate translations in the specific language for that query. (Seetranslated fields)

• page (int) – 1-based page number. Defaults to 1.

• page_size (int) – Maximum number of results to return for the requested page. Defaults to 25.

Response JSON Object:

• count (int) – The number of versions for this add-on.

• next (string) – The URL of the next page of results.

• previous (string) – The URL of the previous page of results.

• results (array) – An array ofversions.

By default, the version list API will only return public versions(excluding versions that have incomplete, disabled, deleted, rejected orflagged for further review files) - you can change that with thefilterquery parameter, which may require authentication and specific permissionsdepending on the value:

Value	Description
all_without_unlisted	Show all listed versions attached to this add-on.Requires either reviewer permissions or a useraccount listed as a developer of the add-on.
all_with_unlisted	Show all versions (including unlisted) attached tothis add-on. Requires either reviewer permissions ora user account listed as a developer of the add-on.
all_with_deleted	Show all versions attached to this add-on, includingdeleted ones. Requires admin permissions.

Version Detail

This endpoint allows you to fetch a single version belonging to a specific add-on.

Note

This API accepts both version ids and version numbers in the URL. If the version number passed does not contain any dot characters (.) it would be considered anid. To avoid this and force a lookup by version number, add av prefix to it.

GET/api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/versions/(int:id|string:version_number)/

Query Parameters:

• lang (string) – Activate translations in the specific language for that query. (Seetranslated fields)

Response JSON Object:

• id (int) – The version id.

• approval_notes (string) – Information for Mozilla reviewers, for when the add-on is reviewed. These notes are only visible to Mozilla, and this field is only present if the user has reviewer permissions, or is listed as a developer of the add-on.

• channel (string) – The version channel, which determines its visibility on the site. Can be eitherunlisted orlisted.

• compatibility (object) –

  Object detailing whichapplications the version is compatible with.The exact min/max version numbers in the object correspond to thesupported versions.Example:

  {"compatibility":{"android":{"min":"38.0a1","max":"43.0"},"firefox":{"min":"38.0a1","max":"43.0"}}}

• compatibility[app_name].max (string) – Maximum version of the corresponding app the version is compatible with. Should only be enforced by clients ifis_strict_compatibility_enabled istrue.

• compatibility[app_name].min (string) – Minimum version of the corresponding app the version is compatible with.

• edit_url (string) – The URL to the developer edit page for the version.

• file.id (int) – The id for the file.

• file.created (string) – The creation date for the file.

• file.hash (string) – The hash for the file.

• file.is_mozilla_signed_extension (boolean) – Whether the file was signed with a Mozilla internal certificate or not.

• file.optional_permissions[] (array) – Array of the optional webextension permissions for this File, as strings. Empty for non-webextensions.

• file.host_permissions[] (array) – Array of the host permissions for this File, as strings. Empty for non-webextensions.

• file.permissions[] (array) – Array of the webextension permissions for this File, as strings. Empty for non-webextensions.

• file.data_collection_permissions[] (array) – Array of the data collection permissions for this File, as strings. Empty for non-webextensions.

• file.optional_data_collection_permissions[] (array) – Array of the optional data collection permissions for this File, as strings. Empty for non-webextensions.

• file.size (int) – The size for the file, in bytes.

• file.status (int) – Thestatus for the file.

• file.url (string) – The (absolute) URL to download the file.

• is_disabled (boolean) – If this version has been disabled by the developer. This field is only present for authenticated users, for their own add-ons.

• license (object) – Object holding information about the license for the version.

• license.is_custom (boolean) – Whether the license text has been provided by the developer, or not. (Whenfalse the license is one of the common, predefined, licenses).

• license.name (object|null) – The name of the license (Seetranslated fields).

• license.text (object|null) – The text of the license (Seetranslated fields). For performance reasons this field is only present in version detail detail endpoint: all other endpoints omit it.

• license.url (string|null) – The URL of the full text of license.

• license.slug (string|null) – The licenseslug, for non-custom (predefined) licenses.

• release_notes (object|null) – The release notes for this version (Seetranslated fields).

• reviewed (string) – The date the version was reviewed at.

• is_strict_compatibility_enabled (boolean) – Whether or not this version hasstrictCompatibility. set.

• source (string|null) – The (absolute) URL to download the submitted source for this version. This field is only present for authenticated users, for their own add-ons.

• version (string) – The version number string for the version.

Possible values for the version/filestatus field / parameter:

Value	Description
public	Approved
disabled	Rejected, disabled, or not reviewed
unreviewed	Awaiting Review

Version Create

This endpoint allows a submission of an upload to an existing add-on to create a new version,and setting other AMO metadata.

To create a listed version from an upload (anupload thathas channel ==listed) certain metadata must be defined - a versionlicense, anadd-onname, an add-onsummary, and add-on categories for each app the versionis compatible with. Add-on properties cannot be set with version create so anadd-on update must be made beforehand if the properties are notalready defined.

Note

This API requiresauthentication, and for the user to be an author of the add-on.

POST/api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/versions/

Request JSON Object:

• approval_notes (string) – Information for Mozilla reviewers, for when the add-on is reviewed. These notes are only visible to Mozilla.

• compatibility (object|array) – Either an object detailing whichapplicationsand versions the version is compatible with; or an array ofapplications,where min/max versions from the manifest, or defaults, will be used. Seeexamples.

• compatibility[app_name].max (string) – Maximum version of the corresponding app the version is compatible with. Should only be enforced by clients ifis_strict_compatibility_enabled istrue.

• compatibility[app_name].min (string) – Minimum version of the corresponding app the version is compatible with.

• license (string) – Theslug of a non-custom license. The license must match the add-on type. Either providelicense orcustom_license, not both. If neither are provided, and there was a license defined for the previous version, it will inherit the previous version’s license.

• custom_license.name (object|null) – The name of the license (Seetranslated fields). Custom licenses are not supported for themes.

• custom_license.text (object|null) – The text of the license (Seetranslated fields). Custom licenses are not supported for themes.

• release_notes (object|null) – The release notes for this version (Seetranslated fields).

• source (string|null) – The submitted source for this version. As JSON this field can only be set to null, to clear it - seeuploading source to set/update the source file.

• upload (string) – The uuid for the xpi upload to create this version with.

{"compatibility":{"android":{"min":"58.0a1","max":"73.0"},"firefox":{"min":"58.0a1","max":"73.0"}}}

{"compatibility":{"android":{"min":"58.0a1"// "max" is undefined, so the manifest max or default will be used.},"firefox":{// the object is empty - both "min" and "max" are undefined so the manifest min/max// or defaults will be used.}}}

{"compatibility":["android","firefox"]}

Version Edit

This endpoint allows the metadata for an existing version to be edited.

Note

This API requiresauthentication, and for the user to be an author of the add-on.

Note

This API accepts both version ids and version numbers in the URL. If the version number passed does not contain any dot characters (.) it would be considered anid. To avoid this and force a lookup by version number, add av prefix to it.

PATCH/api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/versions/(int:id|string:version_number)/

Request JSON Object:

• approval_notes (string) – Information for Mozilla reviewers, for when the add-on is reviewed. These notes are only visible to Mozilla.

• compatibility (object|array) – Either an object detailing whichapplications and versions the version is compatible with; or an array ofapplications, where default min/max versions will be used if not already defined. Seeexamples.

• compatibility[app_name].max (string) – Maximum version of the corresponding app the version is compatible with. Should only be enforced by clients ifis_strict_compatibility_enabled istrue.

• compatibility[app_name].min (string) – Minimum version of the corresponding app the version is compatible with.

• is_disabled (boolean) – If this version has been disabled by the developer. Note: a version with an already disabled file (file.status isdisabled) cannot be changed totrue.

• license (string) – Theslug of a non-custom license. The license must match the add-on type. Either providelicense orcustom_license, not both.

• custom_license.name (object|null) – The name of the license (Seetranslated fields). Custom licenses are not supported for themes.

• custom_license.text (object|null) – The text of the license (Seetranslated fields). Custom licenses are not supported for themes.

• release_notes (object|null) – The release notes for this version (Seetranslated fields).

• source (string|null) – The submitted source for this version. As JSON this field can only be set to null, to clear it - seeuploading source to set/update the source file.

Version Delete

This endpoint allows a version to be deleted. The version will be soft-blocked (restricted), which will disable and prevent any further installation in Firefox. Existing users can choose to re-enable the add-on.

Note

This API requiresauthentication, and for the user to be an author of the add-on.

Note

This API accepts both version ids and version numbers in the URL. If the version number passed does not contain any dot characters (.) it would be considered anid. To avoid this and force a lookup by version number, add av prefix to it.

DELETE/api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/versions/(int:id|string:version_number)/

Version Rollback

This endpoint allows an already approved version to be immediately re-created with a new version number, to rollback a problematic version.

The latest version in each channel is unavailable for rollback (or you wouldn’t be rolling back anything); also, for listed channel, is limited to the previous approved version.The rollback is asynchronous; you will be notified by email when it’s complete (or failed).

Seeversion create - the second version in the list - for the listed version available for rollback. Call the endpoint with?all_with_unlisted for all the unlisted versions, ignoring the first version and any versions that are notfile.status==public.

Note

This API requiresauthentication, and for the user to be an author of the add-on.

Note

This API accepts both version ids and version numbers in the URL. If the version number passed does not contain any dot characters (.) it would be considered anid. To avoid this and force a lookup by version number, add av prefix to it.

Warning

For the listed channel, if there is a version awaiting review in the listed channel it will be disabled as part of the rollback.

POST/api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/versions/(int:id|string:version_number)/rollback/

Request JSON Object:

• new_version_string (string) – The new version number (required). It must be unique across all channels, and for listed versions, higher than all previously signed versions.

• release_notes (object|null) – The release notes for this version (Seetranslated fields).

Preview Create

This endpoint allows a submission of a preview image to an existing non-theme add-on to create a new preview image. Themes can only have generated previews and new previews can not be created.Image files cannot be uploaded as JSON - the request must be sent as multipart form-data instead.If desired,position can be set set at the same time asimage, butcaption can not, so a separate API call is needed.

Note

This API requiresauthentication, and for the user to be an author of the add-on.

POST/api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/previews/

Form Parameters:

• image – The image being uploaded.

• postion – Integer value for the position the image should be returned in the addondetail (optional). Order is ascending so lower positions are placed earlier.

Request Headers:

• Content-Type – multipart/form-data

Preview Edit

This endpoint allows the metadata for an existing preview for a non-theme add-on to be edited. Themes can only have generated previews and previews can not be edited.

Note

This API requiresauthentication, and for the user to be an author of the add-on.

PATCH/api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/previews/(int:id)/

Request JSON Object:

• caption (object) – The caption describing a preview (Seetranslated fields).

• position (int) – The position the image should be returned in the addondetail. Order is ascending so lower positions are placed earlier.

Preview Delete

This endpoint allows the metadata for an existing preview for a non-theme add-on to be deleted. Themes can only have generated previews and previews can not be deleted.

Note

This API requiresauthentication, and for the user to be an author of the add-on.

DELETE/api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/previews/(int:id)/

Upload Create

This endpoint is for uploading an addon file, to then be submitted to create a new addon or version.

Note

This API requiresauthentication.

POST/api/v5/addons/upload/

Form Parameters:

• upload – The add-on file being uploaded.

• channel – The channel this version should be uploaded to, which determines its visibility on the site. It can be eitherunlisted orlisted.

Request Headers:

• Content-Type – multipart/form-data

After the file has uploaded theupload response will bereturned immediately, and the addon submitted for validation.Theupload detail endpoint should be queried for validation statusto determine when/if the upload can be used to create an add-on/version.

Upload List

This endpoint is for listing your previous uploads.

Note

This API requiresauthentication.

GET/api/v5/addons/upload/

Query Parameters:

• page (int) – 1-based page number. Defaults to 1.

• page_size (int) – Maximum number of results to return for the requested page. Defaults to 25.

Response JSON Object:

• count (int) – The number of uploads this user has submitted.

• next (string) – The URL of the next page of results.

• previous (string) – The URL of the previous page of results.

• results (array) – An array ofuploads.

Upload Detail

This endpoint is for fetching a single previous upload by uuid.

Note

This API requiresauthentication.

GET/api/v5/addons/upload/<string:uuid>/

Response JSON Object:

• uuid (string) – The upload id.

• channel (string) – The version channel, which determines its visibility on the site. Can be eitherunlisted orlisted.

• processed (boolean) – If the version has been processed by the validator.

• submitted (boolean) – If this upload has been submitted as a new add-on or version already. An upload can only be submitted once.

• url (string) – URL to check the status of this upload.

• valid (boolean) – If the version passed validation.

• validation (object) – the validation results JSON blob.

• version (string) – The version number parsed from the manifest.

EULA and Privacy Policy

This endpoint allows you to fetch an add-on EULA and privacy policy.

GET/api/v5/addons/addon/(int:id|string:slug|string:guid)/eula_policy/

Note

Non-public add-ons and add-ons with only unlisted versions require both:

• authentication

• reviewer permissions or an account listed as a developer of the add-on

Response JSON Object:

• eula (object|null) – The text of the EULA, if present (Seetranslated fields).

• privacy_policy (object|null) – The text of the Privacy Policy, if present (Seetranslated fields).

EULA and Privacy Policy Edit

This endpoint allows an add-on’s EULA and privacy policy to be edited.

Note

This API requiresauthentication, and for the user to be an author of the add-on.

Note

This API is not valid for themes - themes do not have EULA or privacy policies.

PATCH/api/v5/addons/addon/(int:id|string:slug|string:guid)/eula_policy/

Request JSON Object:

• eula (object|null) – The EULA text (Seetranslated fields).

• privacy_policy (object|null) – The privacy policy text (Seetranslated fields).

Language Tools

This endpoint allows you to list all public language tools add-ons availableon AMO.

GET/api/v5/addons/language-tools/

Note

Because this endpoint is intended to be used to feed a page thatdisplays all available language tools in a single page, it is notpaginated as normal, and instead will return all results withoutobeying regular pagination parameters. The ordering is left undefined,it’s up to the clients to re-order results as needed before displayingthe add-ons to the end-users.

In addition, the results can be cached for up to 24 hours, based on thefull URL used in the request.

Query Parameters:

• app (string) – Mandatory whenappversion is present, ignored otherwise. Filter byadd-on application availability.

• appversion (string) – Filter by application version compatibility. Pass the full version as a string, e.g.46.0. Only valid when both theapp andtype parameters are also present, and only makes sense for Language Packs, since Dictionaries are always compatible with every application version.

• author (string) – Filter by exact (listed) author username. Multiple author names can be specified, separated by comma(s), in which case add-ons with at least one matching author are returned.

• lang (string) – Activate translations in the specific language for that query. (Seetranslated fields)

• type (string) – Mandatory whenappversion is present. Filter byadd-on type. The default is to return both Language Packs or Dictionaries.

Response JSON Object:

• results (array) – An array of language tools.

• results[].id (int) – The add-on id on AMO.

• results[].current_compatible_version (object) – Object holding the latest publicly availableversion of the add-on compatible with theappversion parameter used. Only present whenappversion is passed and valid. For performance reasons, only the following version properties are returned on the object:id,file,reviewed, andversion.

• results[].default_locale (string) – The add-on default locale for translations.

• results[].name (object|null) – The add-on name (Seetranslated fields).

• results[].guid (string) –

  The add-onextension identifier.

• results[].slug (string) – The add-on slug.

• results[].target_locale (string) – For dictionaries and language packs, the locale the add-on is meant for. Only present when using the Language Tools endpoint.

• results[].type (string) – Theadd-on type.

• results[].url (string) – The (absolute) add-on detail URL.

Replacement Add-ons

This endpoint returns a list of suggested replacements for legacy add-ons that are unsupported in Firefox 57.

GET/api/v5/addons/replacement-addon/

Query Parameters:

• page (int) – 1-based page number. Defaults to 1.

• page_size (int) – Maximum number of results to return for the requested page. Defaults to 25.

Response JSON Object:

• count (int) – The total number of replacements.

• next (string) – The URL of the next page of results.

• previous (string) – The URL of the previous page of results.

• results (array) – An array of replacements matches.

• results[].guid (string) – The extension identifier of the legacy add-on.

• results[].replacement[] (string) – An array of guids for the replacements add-ons. If there is a direct replacement this will be a list of one add-on guid. The list can be empty if all the replacement add-ons are invalid (e.g. not publicly available on AMO). The list will also be empty if the replacement is to a url that is not an addon or collection.

Recommendations

This endpoint provides recommendations of other addons to install. Maximum four recommendations will be returned.

GET/api/v5/addons/recommendations/

Query Parameters:

• app (string) – Set theadd-on application for that query. This won’t filter the results. Defaults tofirefox.

• guid (string) – Fetch recommendations for this add-on guid.

• lang (string) – Activate translations in the specific language for that query. (Seetranslated fields)

• recommended (boolean) – Ignored.

Response JSON Object:

• outcome (string) – Outcome of the response returned. Will always becurated.

• fallback_reason (null) – Always null.

• count (int) – The number of results for this query.

• next (string) – The URL of the next page of results.

• previous (string) – The URL of the previous page of results.

• results (array) – An array ofadd-ons. The following fields are omitted for performance reasons:release_notes andlicense fields oncurrent_version andcurrent_beta_version, as well aspicture_url fromauthors.

Browser Mappings

This endpoint provides browser mappings of non-Firefox and Firefox extensions. Added to support the extensions import feature in Firefox.

GET/api/v5/addons/browser-mappings/

Note

This endpoint uses a largerpage_size than most other API endpoints.

Query Parameters:

• browser (string) – The browser identifier for this query (required). Must be one of these:chrome.

• page_size (int) – Maximum number of results to return for the requested page. Defaults to 100.

Response JSON Object:

• results (array) – An array containing a mapping of non-Firefox and Firefox extension IDs for a given browser.

• results[].extension_id (string) – A non-Firefox extension ID.

• results[].addon_guid (string) – The corresponding Firefox add-onguid.