![[Warning]](/media/com_docimport/admonition/warning.png) | 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. |
Test the connection to a database, used to test connection information before submitting it to setIncludedDB. Available since API version 340.
Request Data expected
- connection
-
A JSON object 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.
Response Data returned
A JSON object.
- status
-
Bool. True if the connection is successful.
- message
-
String. Error message when status is false.