Descripción general de la referencia API
¡Bienvenido a la guía de referencia API de NAKIVO Backup & Replication!
Visión general
La API de NAKIVO Backup & Replication ("API" para abreviar a partir de aquí) está diseñada para automatizar las tareas de protección de datos.
Se trata de una API HTTP JSON-RPC, lo que significa que invocarás acciones enviando un JSON con los parámetros correspondientes.
Puntos finales
Se utiliza el mismo punto final para todas las solicitudes:
https://<Dirección_IP_del_director>:4443/c/router
Cambie IP_address_of_Director por la dirección IP real de su instalación NAKIVO Backup & Replication (la misma que utiliza para acceder a la interfaz de usuario).
Formato de solicitud
Todas las solicitudes deben tener formato JSON. Puede enviar la solicitud desde el archivo.json independiente o incluirlos en el cuerpo de la solicitud.
Los campos obligatorios son:
| Campo | Tipo | Descripción |
|---|---|---|
action
|
string | La acción que se invoca |
method
|
string | El método que se invoca |
type
|
string | Tipo de solicitud. Debe estar rpc en todo momento. |
tid
|
integer | ID de transacción de una solicitud. Se utiliza para identificar la solicitud tanto por parte del cliente como del servidor. Si el cliente envía un lote de solicitudes, tid debe ser único entre las solicitudes |
data
|
array or JSON object | Los parámetros de la solicitud. El formato depende del tipo de solicitud. |
Opciones de la línea de comandos cURL
Al enviar peticiones con la herramienta cURL, utilice las siguientes opciones:
| Opción | Formulario abreviado | Descripción |
|---|---|---|
--request |
-X |
Especifica el comando de petición a utilizar. En la mayoría de los casos, la API NAKIVO utiliza el comando POST |
--url |
|
URL con la que trabajar. La URL puede especificarse sin la opción --url |
--header |
-H |
Pasa cabeceras personalizadas al servidor |
--data |
-d |
Datos de la solicitud HTTP POST; véase la tabla anterior. Si se especifica, se puede omitir la opción -request POST |
--cookie-jar |
-c |
Escribe cookies en el archivo <> después de la solicitud. |
--cookie |
-b |
Envía cookies desde una string o un archivo @<> |