Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Welcome to the NAKIVO Backup & Replication API reference guide!


The NAKIVO Backup & Replication API ('API' for short from here) is designed to automate data protection tasks. This is a JSON-RPC HTTP API which means that you'll invoke actions by sending a JSON with the corresponding parameters.


The same endpoint is used for all requests:


Change the IP_address_of_Director with the actual IP-address of your NAKIVO Backup & Replication installation (the same as you use to access UI).

Request Format

All requests must be JSON-formatted. You can send the request either from the standalone .json file or include them into the request body.

The mandatory fields are:

actionstringThe action that is invoked
methodstringThe method that is invoked
typestringThe type of a request. Must be rpc at all times.
tidintegerTransaction ID. If you send only one request at a time, it must be 1. Increase the number if you send more than one request at a time.
dataarray or JSON objectThe parameters of the request. Format depends on the request type.

Child Pages

  • No labels