– ManageDatabases

Jb5: CreateAccount

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible values	Example
account	String	REQUIRED Username for the new Linux account.		`account=linuxUsername`

Example Call JETAPI

jetbackup5api -F Plugin/ManageDatabases/CreateAccount -D "account={$USERNAME}"

success: 1
message: Account created successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/ManageDatabases/CreateAccount&account={$USERNAME}

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

Jb5: ListDatabases

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible values	Example
type	Integer	Filter listed databases by type	MySQL: `type=1` MongoDB: `type=2` PostgreSQL: `type=3`	`type=1`

**Returns**
Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of databases.
total	Integer	The total number of database.

Example Call JETAPI

jetbackup5api -F Plugin/ManageDatabases/ListDatabases -D "type=1"

success: 1
message: List databases fetched successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  databases:
    1:
      example:
      mysql: exampledb1
      sys:
    2:
    3:

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/ManageDatabases/ListDatabases&type=1

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

Jb5: ListDatabaseUsers

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible values	Example
type	Integer	Filter listed databases by type	MySQL: `type=1` MongoDB: `type=2` PostgreSQL: `type=3`	`type=1`

**Returns**
Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of database users.
total	Integer	The total number of database users.

Example Call JETAPI

jetbackup5api -F Plugin/ManageDatabases/ListDatabaseUsers -D "type=1"

success: 1
message: List database users fetched successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  users:
    1:
      example_user1: exampledb1
      example_user2: exampledb2
    2:
    3:

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/ManageDatabases/ListDatabaseUsers&type=1

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

Jb5: GetSettings

Mon, 01 Jan 0001 00:00:00 +0000

**Returns**
Parameter name	Type	Description	Possible values	Example
items	List []	Returns the plugin settings.

Example Call JETAPI

jetbackup5api -F Plugin/ManageDatabases/GetSettings

success: 1
message: Settings fetched successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  default_db_user:
  assign_type: 2

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/ManageDatabases/GetSettings

Jb5: GetStatistics

Mon, 01 Jan 0001 00:00:00 +0000

**Returns**
Parameter name	Type	Description	Possible values	Example
items	List []	Returns the database and database user statistics.

Example Call JETAPI

jetbackup5api -F Plugin/ManageDatabases/GetStatistics

success: 1
message:
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  databases:
    1:
      dbs:
        total: 3
        assigned: 1
        unassinged: 2
      users:
        total: 6
        assigned: 2
        unassinged: 4
    2:
      dbs:
        total: 8
        assigned: 3
        unassinged: 5
      users:
        total: 1
        assigned: 1
        unassinged: 0
    3:
      dbs:
        total: 0
        assigned: 0
        unassinged: 0
      users:
        total: 0
        assigned: 0
        unassinged: 0

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/ManageDatabases/GetStatistics

Jb5: DatabaseAssign

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible Values	Example
account	String	REQUIRED The account to assign databases/database users to.		`account=exampleAccount`
type	Integer	REQUIRED The database type.	MySQL: `type=1` MongoDB: `type=2` PostgreSQL: `type=3`	`type=1`
list	Integer	REQUIRED The list of databases/database users to assign. All possible value must be included and can be empty.	`list[databases][assigned][0]` `list[databases][unassigned][0]` `list[users][assigned][0]` `list[users][unassigned][0]`	`list[databases][assigned][0]=exampleDB&list[databases][unassigned][0]=&list[users][assigned][0]=exampleDBUser&list[users][unassigned][0]="`

Example Call JETAPI

jetbackup5api -F Plugin/ManageDatabases/DatabaseAssign -D "type=2&list[databases][assigned][0]={$DATABASE}&list[databases][unassigned][0]=&list[users][assigned][0]={$DATABASE_USER}&list[users][unassigned][0]=&account={$ACCOUNT_NAME}"

success: 1
message: Database reassigned successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/ManageDatabases/DatabaseAssign&type=2&list[databases][assigned][0]={$DATABASE}&list[databases][unassigned][0]=&list[users][assigned][0]={$DATABASE_USER}&list[users][unassigned][0]=&account={$ACCOUNT_NAME}

Jb5: ManageSettings

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible Values	Example
default_db_user	String	The default account which unassigned databases will be backed up to.		`default_db_user=exampleUser`
assign_type	Integer	The database assign type.	Automatically assign databases to accounts: `type=1` Manually assign databases to accounts: `type=2`	`type=1`

Example Call JETAPI

jetbackup5api -F Plugin/ManageDatabases/ManageSettings -D "default_db_user={$ACCOUNT_NAME}&assign_type=1"

success: 1
message: Settings saved successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Plugin/ManageDatabases/ManageSettings&default_db_user={$ACCOUNT_NAME}&assign_type=1