Last modified February 12, 2025

ListDatabases

This function will list all databases on the server.
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