Support

	Note
	APIv3 is in emergent state. You should experiment with it, but not use it in production.

APIv3 extends the native API applications of Joomla! and WordPress to provide API endpoints for Akeeba Backup, using the native API calling conventions of each CMS. Generally speaking, APIv3 is designed so that upgrading to it from APIv2 will inflict the least amount of pain for the integrator, unlike the APIv0 to APIv1, and the APIv1 to APIv2 migrations.

Like APIv1 and APIv2, you can use either GET or POST to call each method. The HTTP verb does not matter. This is a deliberate decision; if there are redirections involved in accessing a site the non-GET requests may fail (since the POST data part of the request is cleared). To prevent that issue and let users take backups reliably we decided to treat GET and POST as one and the same.

Specifying a method is done by appending the method name to the endpoint URL, e.g. https://www.example.com/api/index.php/v3/akeebabackup/startBackup to start a backup on Joomla!.

The authentication method, sending data to the API methods, the encapsulation of return data, and error reporting is left to the API application implementation of the corresponding CMS. Please note that each CMS may impose different requirements on the requests. For example, Joomla! requires you to send an Accept: application/json header.