NAKIVO API Best Practices

Product version: 10.5

Last modified: 11 March 2022


What are some best practices for using the NAKIVO Backup & Replication API?


Best practices when using the NAKIVO API include:

  • Use pagination: When querying large data sets, use pagination where available to reduce clutter.

  • Monitor CPU and memory: When running multiple requests in parallel or using request bundling (multiple requests in one HTTP request), monitor CPU and memory load on the processing server. Keeping CPU and memory usage at reasonable levels can prevent unwanted service interruption.

  • Enable debug dumps: You may enable the export of API request-response logs for debugging purposes using the steps below:

    1. Enable Expert mode.

    2. Go to Settings > Expert and enable the system.debug.mode.enabled and system.debug.mode.log.api.requests settings.

    3. Once these options are enabled, the log file will be exported to logs\0\web_requests.log.

  • Use a service account: It is recommended that you use NAKIVO API with a separate service user account. To do this, first create a role (in the Users & Roles tab in General settings) with the desired permissions for the API user. Then, create a user and assign the aforementioned role.

  • Track activities: Any process started in NAKIVO Backup & Replication can be tracked in both the Activities dashboard and via API commands. This includes jobs, file/object recovery, repository verification, etc.

  • Refer to the SDK file: For a reference of all the java definitions of API services and methods, refer to the SDK zip file provided by support upon request.