Support

Documentation

getIncludedDBs

[Warning]Warning

DEPRECATED - This method will be removed in Akeeba Backup for Joomla 10, Akeeba Backup for WordPress 8, and Akeeba Solo 8. Versions of our software released after September 2023 may no longer include this method even if their major version is below those specified in this message.

Lists the additional included database definitions. Available since API version 340.

Request Data expected

All fields are MANDATORY.

profile

Integer. The profile ID you want to list.

Response Data returned

A JSON object. The object keys are the unique names of the extra included datbases. The value of each object key is a JSON array with the following keys.

host

String. The hostname of the database

port

Int. The port of the database server, null if not specified.

driver

String. Database driver to use, e.g. mysql, mysqli, pdomysql, mssql, sqlazure, postgresql

user

String. The user name to connect to the database server.

password

String. The password to connect to the database server.

database

String. The name of the database you are connecting to.