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:
IP_address_of_Director with the actual IP-address of your NAKIVO Backup & Replication installation (the same as you use to access UI).
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:
|string||The action that is invoked|
|string||The method that is invoked|
|string||The type of a request. Must be |
|integer||Transaction ID of a request. Used to identify the request by both the client and the server. If the client sends a batch of requests, tid must be unique among the requests|
|array or JSON object||The parameters of the request. Format depends on the request type.|
cURL Command Line Options
While sending requests with the cURL tool, use the following options:
|Specifies the request command to use. In most cases, NAKIVO API uses the POST command|
|URL to work with. The URL can be specified without the --url option|
|Passes custom headers to the server|
|Data of the HTTP POST request; see the table above. If specified, the –request POST option can be omitted|
|Writes cookies to the <file> after the request|
|Sends cookies from a string or a @<file>|
- Authentication Management
- Inventory Management
- Job Management
- Repository Management
- Backup Objects Management
- Transporter Management
- Multitenancy Management
- Branding Management