Historically, API endpoints have been provided in one of two ways:
-
As a URL specific to the Joomla! component.
-
As a direct URL to an
index.phporremote.phpfile in Akeeba Backup for WordPresas and Akeeba Solo.
The downside of this approach is that both Joomla! and WordPress may allow third party code to interfere with the handling of the URL, leading to unexpected breakage outside our control. Therefore, the following endpoint methods are now preferred, or in development:
-
Using a Joomla! API application endpoint URL
-
Using WordPress' admin-ajax.php endpoint
-
Using WordPress' API application endpoint URL
While third party code still runs under these contexts, it's less likely that it will interfere.
The APIv1 endpoints are as follows:
![[Warning]](/media/com_docimport/admonition/warning.png) | Warning |
|---|---|
|
APIv1 is retired and MUST NOT be used. Please note that some versions of our software may respond to an APIv1 endpoint only to return an error either telling you that you need to use APIv2, or telling you that the product has expired. In this case, you MUST try APIv2 instead. |
-
Akeeba Backup for Joomla! versions 3.3.0 to 8.3.x with the endpoint
https://www.example.com/index.php?option=com_akeeba&view=json&format=raw -
Akeeba Backup for WordPress versions 1.0.0 to 7.x with the endpoint
https://www.example.com/wp-content/plugins/akeeabackupwp/app/index.php?option=com_akeeba&view=json&format=raw -
Akeeba Backup for WordPress versions 7.4.0 and later 7.x versions with the endpoint
https://www.example.com/wp-content/plugins/akeeabackupwp/app/index.php?option=com_akeeba&view=api&format=raw -
Akeeba Solo versions 1.0.0 to 7.x versions with the endpoint
https://www.example.com/index.php?option=com_akeeba&view=json&format=raw -
Akeeba Solo versions 2.4.1 to 7.x versions with the endpoint
https://www.example.com/remote.php?option=com_akeeba&view=json&format=raw
The APIv2 endpoints are as follows:
-
Akeeba Backup for Joomla! versions 7.5.x to 8.x with the endpoint
https://www.example.com/index.php?option=com_akeeba&view=api&format=raw -
Akeeba Backup for Joomla! versions 9.x and later with the endpoint
https://www.example.com/index.php?option=com_akeebabackup&view=api&format=raw -
Akeeba Backup for Joomla! versions 9.6.0 and later with the endpoint
https://www.example.com/api/index.php/v2/akeebabackupwhich uses the Joomla! API application.![[Note]](/media/com_docimport/admonition/note.png)
Note This endpoint requires that the Web Services - Akeeba Backup plugin is published on the site.
-
Akeeba Backup for WordPress versions 7.4.0 and later 7.x versions with the endpoint
https://www.example.com/wp-content/plugins/akeeabackupwp/app/index.php?option=com_akeeba&view=api&format=raw -
Akeeba Backup for WordPress versions 7.7.1 to 8.x with the endpoint
https://www.example.com/wp-admin/admin-ajax.php?action=akeebabackup_api&option=com_akeeba&view=api&format=raw -
Akeeba Solo versions 7.4.0 to 8.x with the endpoint
https://www.example.com/index.php?option=com_akeeba&view=api&format=raw
The APIv3 endpoints are as follows:
![[Important]](/media/com_docimport/admonition/important.png) | Important |
|---|---|
|
APIv3 is still in emergent state. You should not use it in production just yet. |
-
Akeeba Backup for Joomla! versions 9.6.0 and later with the endpoint
https://www.example.com/api/index.php/v3/akeebabackupwhich uses the Joomla! API application.Note This endpoint requires that the Web Services - Akeeba Backup plugin is published on the site.
APIv1 is retired (obsolete)
The APIv1 has been retired and superseded by APIv2 in all products.
Moreover, APIv1 will no longer work on Akeeba Backup for Joomla! after December 2023. This change was announced in December 2019 with an original sunset date of API v1 set to December 2020. Due to the COVID-19 pandemic we extended the sunset date, but now the time has finally come.
Auto-detection strategy
When you need to detect the API endpoint and version to use on a site, we suggest that you use the following strategy.
Check for products in the following order: Akeeba Backup 9.x using the Joomla! API endpoint (APIv2, Akeeba Backup 9.6.0 or later), Akeeba Backup for WordPress, Akeeba Solo.
Check for APIv2 endpoints BEFORE APIv1 endpoints. Newer versions of some products implement APIv1 endpoints only to return an error informing you that you should not be using APIv1. Other products used to support APIv1 but they return an error message since December 2023 letting you know that it has expired.
When iterating through endpoints, always look for the newer endpoints before the older endpoints.
API and endpoint deprecation policy
Whenever we deprecate an API version we will provide a reasonable period of time (no less than 6 months and no more than 12 months) where both API versions will be supported by the same product simultaneously. This will be followed by a short period of time (no less than 3 months and no more than 6 months) where the old API version returns an error, letting you know you should use the newer API version. After that time the old API version's endpoint will be retired and its behaviour becomes unpredictable.
Whenever we introduce a new API endpoint within the same API version we will provide a reasonable period of time (no less than 6 months and no more than 12 months) where both API endpoints will be supported by the same product simultaneously. After that time the old endpoint will be retired and its behaviour becomes unpredictable.