Function: billmgr.backup

Result: the list of elements

Backup configuration

Access level: admin

  • id — Id
  • date — Date
  • size — Size, MiB

Start the backup process

Function: billmgr.backup.create

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of billmgr.backup function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of billmgr.backup function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Download the backup copy to your local machine

Function: backups.download

Download the backup copy to your local machine

Access level: admin

Restore

Function: backups.restore

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of billmgr.backup function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of billmgr.backup function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • behavior — Behavior. Select how you want to restore data from the backup.
    • Skip data – do not restore data and dependent elements that already exist in the system. Edit existing data – restore all the data from the archive.

E.g. you have a web-domain, which files were deleted from its home directory. If you choose “Skip existing data” while restoring the domain, its files won’t be restored. If you choose “Edit existing data”, domain’s files and settings will be restored.

Add a storage and backup plan

Function: billmgr.backup.setup

Add a storage and backup plan

Access level: admin

Backup archives

Function: backupdata

Result: the list of elements

Saved data

Access level: admin

  • type — Data type

Data name

Function: backupdata.names

Result: the list of elements

Data included into backup copy

Access level: admin

  • name — Data name
  • owner — Owner
Restore

Function: backupdata.restore

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid — parent list unique identifier (id element of backupdata function).
    • elid — unique identifier (id element of backupdata.names function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of backupdata function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of backupdata function).
    • elid — unique identifier (id element of backupdata.names function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • version — Version. Select a backup date
  • behavior — Behavior. Select how you want to restore data from the backup.
    • Skip data – do not restore data and dependent elements that already exist in the system. Edit existing data – restore all the data from the archive.

E.g. you have a web-domain, which files were deleted from its home directory. If you choose “Skip existing data” while restoring the domain, its files won’t be restored. If you choose “Edit existing data”, domain’s files and settings will be restored.

Name

Function: backupdata.files

Result: the list of elements

Files

Access level: admin

  • dname — Name
Restore

Function: backupdata.files.restore

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid — parent list unique identifier (id element of backupdata.names function).
    • elid — unique identifier (name element of backupdata.files function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of backupdata.names function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of backupdata.names function).
    • elid — unique identifier (name element of backupdata.files function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • version — Version. Select a backup date

Upload the backup copy

Function: backups.upload

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of billmgr.backup function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of billmgr.backup function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • type — Upload type. Select the upload type you want to use. You can upload files from your local computer or from a remote server. The files will be stored into the current folder.
  • name — File name. Enter the name of the file you want to upload. If you leave this field blank, the file name will be extracted from the URL.
  • storage — Storage. Select a storage for the backup copy

Delete the backup copy

Function: backups.delete

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of billmgr.backup function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of billmgr.backup function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • clean_storages — . (Optional parameter. To enable the option click "on".) Select if you want to delete archives and listings from the storages

Inventory module settings

Function: billmgr.backup.settings

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of billmgr.backup function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of billmgr.backup function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • dropsettings — . (Optional parameter. To enable the option click "on".) Backup settings and information about backup copies will be deleted. Data from storages won't be deleted