Support

Documentation

setIncludedDB

DEPRECATED - This method will be removed in Akeeba Backup 7.1

Adds an additional included database definition. Available since API version 340.

Request Data expected

profile

Integer. The profile ID you want to list.

name

String. The unique name for this database. It is best to only use lowercase letters and dashes.

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.

test

Bool. True (default) to test the connection before saving.

Response Data returned

Boolean true on success.