API Reference Overview
Welcome to the NAKIVO Backup & Replication API reference guide!
Overview
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.
Endpoints
The same endpoint is used for all requests:
https://<IP_adress_of_Director>:4443/c/router
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:
| Field | Type | Description |
|---|---|---|
action
|
string | The action that is invoked |
method
|
string | The method that is invoked |
type
|
string | The type of a request. Must be rpc at all times. |
tid
|
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 |
data
|
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:
| Option | Short Form | Description |
|---|---|---|
--request |
-X |
Specifies the request command to use. In most cases, NAKIVO API uses the POST command |
--url |
|
URL to work with. The URL can be specified without the --url option |
--header |
-H |
Passes custom headers to the server |
--data |
-d |
Data of the HTTP POST request; see the table above. If specified, the –request POST option can be omitted |
--cookie-jar |
-c |
Writes cookies to the <file> after the request |
--cookie |
-b |
Sends cookies from a string or a @<file> |