• Datos de acceso:
  • Usuario: admin
  • Password: jorgegea
• Cabecera HTTP:  Authorization: Basic YWRtaW46am9yZ2VnZWE=

• Podrán hacer peticiones de tipo GET usuarios con el rol REST-Lectura
• Podrán hacer peticiones de cualquier tipo (GET, POST, PUT, DELETE) usuarios con el rol REST-Escritura
• También podrá hacer peticiones de cualquier tipo el usuario root.

1. Listado de elementos (<jobs> <job></job> <job></job> … <jobs>)
2. Descripción de un elmento (<job><name>job1</name> … </job>)
3. Valor concreto de alguna propiedad (<serialNumber>ADASDFD1ASDF</serialNumber>)
4. Mensaje de confirmación (<success>El elemento se borró correctamente</success>)

5. Mensaje de error (<error>Se produjo en error al intentar … </error>)

/users

• GET: Obtiene el listado de usuario
• PUT + user: Da de alta un nuevo usuario
• POST + user: Actualiza un usuario existente

/users/{name}

• GET: Obtiene los datos de un usuario
• DELETE: Elimina un usuario

/users/roles

• GET: Lista los roles de usuarios definidos en el sistema

/users/root/password/{newPassword}

• GET: Establece un nuevo password para el usuario root

/system/configuration

• GET: Obtiene el objeto systemConfiguration con todos los parámetros configurados en ese momento (correo de administración, servidor snmp, etc)

• POST + systemConfiguration: Establece nuevos parámetros de configuración para el sistema

/system/configuration/restart   o bien    /system/configuration/reboot

• GET: Reinicia el sistema

/system/configuration/shutdown

• GET: Apaga el sistema

/system/configuration/service

• GET: Obtiene el listado de los servicios del sistema con su correspondiente estado (running o stopped)

/system/configuration/service/{nameService}

• GET: Obtiene el estado de un servicio (running o stopped)

  • Los nombres de servicio posibles son: BACKUP-DIRECTOR, BACKUP-STORAGE, BACKUP-FILE, BACKUP-DATABASE, ISCSI, NFS, CIFS, FTP, WATCHDOG
  • No importa si es en minúsculas o mayúsculas

/system/configuration/service/{nameService}/start

• GET: Inicia un servicio dado

  • Los nombres de servicio posible son: BACKUP-DIRECTOR, BACKUP-STORAGE, BACKUP-FILE, BACKUP-DATABASE, ISCSI, NFS, CIFS, FTP, WATCHDOG
  • No importa si es en minúsculas o mayúsculas

/system/configuration/service/{nameService}/stop

• GET: Detiene un servicio dado

  • Los nombres de servicio posible son: BACKUP-DIRECTOR, BACKUP-STORAGE, BACKUP-FILE, BACKUP-DATABASE, ISCSI, NFS, CIFS, FTP, WATCHDOG
  • No importa si es en minúsculas o mayúsculas

/system/configuration/sendemail

• GET: Envía el email de prueba

/system/network/interfaces/{idInterface}

• GET: Obtiene los datos de la interfaz de red con identificador idInterface
• DELETE: Elimina la configuración de red asociada a la interfaz con identificador idInterface

/system/network/interfaces/configured

• GET: Obtiene el listado de interfaces de red configuradas en el sistema

/system/network/interfaces/available

• GET: Obtiene el listado de interfaces de red libres (no configuradas) en el sistema

/system/network/interfaces

• GET: Obtiene el listado total de interfaces de red en el sistema (configuradas y no configuradas)
• POST + networkInterfacesConfig: Establece la configuración de interfaces de red en el sistema

/system/network/routes

• GET: Obtiene la configuración de rutas estáticas del sistema
• POST + networkRoutesConfig: Establece la configuración de rutas estáticas del sistema

/routes/interface/{interface}

• GET; Obtiene las rutas estáticas establecidas para la interfaz identificada por interface.

/nameservers

• GET; Obtiene los servidores de nombres configurados
• POST + networkNameServersConfig: Establece los servidores de nombres del sistema

/system/time/date

• GET; Obtiene la fecha actual en el sistema
• POST + timeDate: Establece una nueva fecha

/system/time/zones

• GET: Obtiene el listado de zonas horarias disponibles
• POST + timeZone: Establece una zona horaria

/system/time/zones/configured

• GET: Obtiene la zona horaria actualmente configurada

/system/time/servers

• GET: Obtiene el listado de servidores ntp configurados
• POST + timeServerSet: Establece una nueva configuración de servidores ntp

/system/maintenance

• GET: Obtiene la configuración de mantenimiento actual (configuración de bd y configuración de copia de seguridad del catálogo)
• POST + maintenanceConfiguration: Establece una nueva configuración de mantenimiento

/db/recomended

• GET: Obtiene los datos de la configuración recomendada para WBSAirback®

/db/vacuum:

• GET: Ejecuta el proceso de vacunación y generación de índices en la BD

/import/share/{share}:

• GET: Importa la configuración del catálogo que esté contenida en el volumen compartido share

/export/share/{share}:

• GET: Exporta la configuración del catálogo al volumen compartido share.

/password/storage   o bien    /password/sd

• GET: Obtiene la contraseña que deben utilizar los repositorios para contactar con el servicio director de airback

/password/client      o bien     /password/fd

• GET: Obtiene la contraseña del cliente de backup de WBSAirback® (airback-fd)

/alive

• GET: Consulta para comprobar si el equipo está activo

/alerts

• GET: Obtiene el listado de alertas de Watchdog activas en el sistema

/memory

• GET: Obtiene el estado de memoria del equipo

/cpu

• GET: Obtiene el estado de carga y cpu del equipo

/network

• GET: Lista las interfaces de red, sus estados y sus niveles de transferencia puntuales y acumulados

/network/{interface}

• GET: Obtiene el estado de una interfaz de red concreta

/ha

• GET: Obtiene el estado de los servicios asociados a HA, si está configurado; DRBD, estado de sincronización DRBD, Heartbeat (HA), rol del nodo, lista de nodos activos, estado CMAN..

/vdisks

• GET: Obtiene el listado de VDISKS asociado a controladoras RAID del sistema.

/vdisks/{controllerId}/{vdiskId}/init

• GET: Lanza un proceso de chequeo de consistencia para el VDISK identificado por el controlador de id: controllerId y el vdisk de id: vdiskId

/vdisks/{controllerId}/{vdiskId}/cancel

• GET: Cancela un proceso de chequeo de consistencia activo para el VDISK identificado por el controlador de id: controllerId y el vdisk de id: vdiskId

/system/proxy

• GET: Obtiene la configuración de proxy
• POST + proxy: Establece una nueva configuración de proxy
• DELETE: Elimina la configuración actual de proxy

/update

• GET: Obtiene el listado de licencias registradas en el producto

/update/upgrade

• GET: Lanza una actualización total del sistema (si hay paquetes para actualizar)

/subscription/serial

• GET: Obtiene el número de serie del producto

/subscription/register:

• GET: Obtiene el estado actual de registro del producto

/subscription/register/account/{account}

• GET: Registra una nueva cuenta de producto

/subscription/support/connect

• GET: Se conecta a la VPN de soporte remoto

/subscription/support/disconnect

• GET: Desconecta la VPN de soporte remoto

/subscription/licenses

• GET: Obtiene el listado de licencias registradas actualmente para este producto

/subscription/licenses/register/{code}

• GET: Registra una nueva licencia

/system/auditory/actions

• GET: Obtiene el listado de acciones de auditoría del sistema
• Filtros:
  • page (int) y rows (int): permiten paginar el resultado.
  • date_from (string): fecha desde en formato yyyy-MM-dd_HH:mm:ss
  • date_to (string):  fecha hasta en formato yyyy-MM-dd_HH:mm:ss
  • type (string): tipo de entrada (WEB o REST)
  • user (string): usuario
  • origin (string): ip origen de la llamada
  • operation (string): opearción ejecutada
  • url (string): url completa que se invocó

/system/auditory/alerts

• GET: Obtiene el listado histórico de alertas del sistema
• Filtros:
  • page (int) y rows (int): permiten paginar el resultado.
  • date_from (string): fecha desde en formato yyyy-MM-dd_HH:mm:ss
  • date_to (string):  fecha hasta en formato yyyy-MM-dd_HH:mm:ss
  • subject (string): resumen/asunto de alerta
  • message (string); mensaje de alerta completo

/clients

• GET: Obtiene el listado de clientes
• PUT + client: Añade un nuevo cliente de backup.
  
  • Opcional: Auto despliegue de agente => /clients?deployUsername={user}&&deployPassword={password}. Se intentará el autodespliegue y autoconfiguración del agente en el cliente configurado
• POST + client:
  • Opcional: Auto despliegue de agente => /clients?deployUsername={user}&&deployPassword={password}. Se intentará el autodespliegue y autoconfiguración del agente en el cliente configurado

/clients/find/name/{clientName}

• GET: Busca por nombre un cliente y devuelve sus datos asociados

/clients{clientId}

• GET: Obtiene los datos de un cliente con identificador clientId.
• DELETE: Elimina un cliente con identificador clientId

/clients/checkonline/{clientid}

• GET: Comprueba si se puede conectar con un cliente con identificador clientID

/clients/status/{clientName}

• GET: Comprueba el estado del cliente nombrado 'clientName'. Devuelve los plugins instalados, jobs en ejecución, su conexión, la versión de Bacula instalada  y la fecha de inicio del demonio. 

/categories

• GET: Obtiene el listado de categorías definidas
• PUT + category: Añade una nueva categoría
• POST + category: Modifica una categoría

/categories/{name}

• GET: Obtiene una categoría con nombre name.
• DELETE: Elimina una categoría con nombre name.

/filesets

• GET: Obtiene el listado de todos los filesets definidos en el sistema
• PUT + fileset: Añade un nuevo fileset
  • Con este método se pueden dar de alta los siguientes tipos de filesets:
    • Standard de Cliente: Ficheros, SystemState, Exchange, Hyper-V, MssqlServer, Delta
    • Locales
    • NDMP
    • VMWare
• POST + fileset: Modifica un fileset
  • Con este método se pueden modificar los siguientes tipos de filesets:
    • Standard de Cliente: Ficheros, SystemState, Exchange, Hyper-V, MssqlServer, Delta
    • Locales
    • NDMP
    • VMWare

/filesets/oracle

• PUT + filesetOracle: Añade un nuevo fileset oracle
• POST + filesetOracle: Modifica un fileset oracle

/filesets/netappacc

• PUT + filesetNetappAccelerator: Añade un nuevo fileset netapp accelerator
• POST + filesetNetappAccelerator: Modifica un fileset netapp accelerator

/filesets/mysql

• PUT + filesetMysql: Añade un nuevo fileset mysql
• POST + filesetMysql: Modifica un fileset mysql

/filesets/postgresql

• PUT + filesetPostgresql: Añade un nuevo fileset postgresql
• POST + filesetPostgresql: Modifica un fileset postgresql

/filesets/mssqlvdi

• PUT + filesetMssqlvdi: Añade un nuevo fileset mssql-vdi
• POST + filesetMssqlvdi: Modifica un fileset mssql-vdi

/filesets/ndmp

• GET: Obtiene los filesets de tipo ndmp

/filesets/local

• GET: Obtiene los filesets de tipo local

/filesets/vmware

• GET: Obtiene los filesets de tipo vmware

/filesets/rhv

• GET: Obtiene todos los filesets de tipo rhv
• PUT: Añade un nuevo fileset rhv
• POST + nameFileset: Modifica el fileset seleccionado en 'nameFileset'. Permite modificar todo excepto el nombre y cliente.

/filesets/rhv/{name}/tree/{path}

• GET: Obtiene la lista de elementos que se especifica en el {path} de un determinado fileset. Este path se encuentra bajo la estructura RHV.

/filesets/docker

• GET: Obtiene todos los filesets de tipo docker
• PUT: Añade un nuevo fileset docker
• POST + nameFileset: Modifica el fileset seleccionado en 'nameFileset'. Permite modificar todo excepto el nombre y cliente.

/filesets/docker/{name}/tree/{path}

• GET: Obtiene la lista de elementos que se especifica en el {path} de un determinado fileset. Este path se encuentra bajo la estructura Docker.

/filesets/kubernetes

• GET: Obtiene todos los filesets de tipo kubernetes
• PUT: Añade un nuevo fileset kubernetes
• POST + nameFileset: Modifica el fileset seleccionado en 'nameFileset'. Permite modificar cualquier parámetro excepto el nombre y cliente.

/filesets/oracle

• GET: Obtiene los filesets de tipo oracle

/filesets/mysql

• GET: Obtiene los filesets de tipo mysql

/filesets/postgresql

• GET: Obtiene los filesets de tipo postgresql

/filesets/netappacc

• GET: Obtiene los filesets de tipo netapp accelerator

/filesets/mssqlvdi

• GET: Obtiene los fielsets de tipo mssqlvdi

/filesets/vmware/tree

• GET: Obtiene el árbol de elementos vmware (vcenter > host > datastore > máquina) a los que tiene acceso WBSAirback® en base a los clientes vmware configurados. Es necesaria su consulta para obtener los datos necesarios para construir los filesets Vmware o llevar a cabo recuperaciones Vmware.

/filesets/{filesetName}

• GET: Devuelve los datos de un fileset de nombre filesetName
• DELETE: Elimina un fileset de nombre filesetName

/files/mssql/client/{clientName}/databases

• GET: Obtiene el listado de bases de datos de las que se tiene algún backup para el cliente clientName. Este listado muestra el nombre, fileset y PATH de cada base de datos. El PATH es necesario para lanzar recuperaciones

/files/mssql/client/{clientName}/databases/{databasePath}/jobs

• GET: Obtiene el listado de versiones (jobs) de cierta base de datos determinada por databasePath (el formato es INSTANCIA___NOMBREBBDD y se puede obtener del método anterio). Su consulta es necesaria para encontrar el identificador de versión deseado en una recuperación por versión.

/files/mssql/client/{clientName}/restore/version/{level}

• POST + restoreMSSQLVDI: Lanza una recuperación por versión para el cliente clientName.
  
  • El parámetro level indica el tipo de recuperación: full, differential o pitr
  • Recibe por URL el número de version: http://.....?version=123
  • El resto de parámetros se especifican en el objeto restoreMSSQLVDI

/files/mssql/client/{clientName}/restore/date/{level}

• POST + restoreMSSQLVDI: Lanza una recuperación por fecha para el cliente clientName.
  
  • El parámetro level indica el tipo de recuperación: full, differential o pitr
  • Recibe por URL la fecha de recuperación: http://.....?date=yyyy-MM-dd_HH:mm:ss
  • El resto de parámetros se especifican en el objeto restoreMSSQLVDI

/schedules/{scheduleName}

• DELETE: Elimina la planificación con nombre scheduleName

/schedules/monthly

• GET: Obtiene el listado de planificaciones mensuales configuradas
• PUT + scheduleMonthly: Añade una nueva planificación mensual
• POST + scheduleMonthly: Edita una planificación mensual existente

/schedules/monthly/{name}

• GET: Obtiene todos los datos de una planificación mensual de nombre name.

/schedules/daily

• GET: Obtiene el listado de planificaciones diarias configuradas
• PUT + scheduleDaily: Añade una nueva planificación diaria
• POST + scheduleDaily: Edita una nueva planificación diaria existente

/schedules/daily/{name}

• GET: Obtiene todos los datos de una planficación diaria de nombre name.

/schedules/weekly

• GET: Obtiene el listado de planificaciones semanales
• PUT + scheduleWeekly: Añade una nueva planficiación semanal
• POST + scheduleWeekly: Edita una planficiacón semanal existente

/schedules/weekly/{name}

• GET: Obtiene todos los datos de una planificación semanal de nombre name

/schedules/yearly

• GET: Obtiene el listado de planificaciones anuales configuradas
• PUT + scheduleYearly:Añade una nueva planificación anual
• POST + scheduleYearly:Edita una planificación anual existente

/schedules/yearly/{name}

• GET: Obtiene todos los datos de una planificación anual de nombre name

/pools

• GET: Obtiene el listado de pools del sistema
• PUT + pool: Añade un nuevo pool
• POST + pool: Edita un pool existente

/pools/{poolName}

• GET: Obtiene los datos del pool de nombre poolName
• DELETE: Elimina el pool llamado poolName

/pools/{poolName}/jobs

• GET: Obtiene los jobs que utilizan el pool poolName

/pools/{poolName}/volumes

• GET: Obtiene los volúmenes generados para el pool poolName

/pools/{poolName}/volumes/purge

• GET: Lanza una operación de purgado de volúmenes para el pool poolName

/pools/{poolName}/volumes/add/volume/{nameVol}

• GET: Añade un volumen de nombre nameVol al pool de nombre poolName, en otras palabras, añade una cinta etiquetada al pool.

/pools/{poolName}/volumes/add/volume/{nameVol}/slot/{slot}/drive/{drive}

• GET: Añade un volumen de cita de una librería a partir de un slot y drive concretos.

/pools/{poolName}/volumes/{label}

• DELETE: Elimina un volumen llamado label del pool poolName. Esta operación elimina los datos y los registros del catálogo.

/pools/{poolName}/volumes/{nameVol}/status/{newstatus}

• GET: Cambia el estado de un volumen de un pool

/pool/volumes

• GET: Devuelve el listado de volúmenes. Se puede filtrar por los siguientes parámetros:
  • pool (string): Nombre de un pool existente
  • storage (string): Nombre de un repositorio existente
  • name (string): Nombre de un volumen existente
  • status (string): Estado del volumen (Full, Append, Error, Recycled, Purged ..)
  • slot (int): Número de slot
  • retention (long): Retención asociada (en segundos)
  • type (string): MediaType asociado: LTO4, LTO5, LTO6, File, agg1-vol1-X2131331313 ...
  • firstwrite_from (string): fecha de primera escritura desde en formato yyyy-MM-dd_HH:mm:ss
  • firstwrite_to (string): fecha de primera escritura desde en formato yyyy-MM-dd_HH:mm:ss
  • lastwrite_from (string): fecha de última escritura hasta en formato yyyy-MM-dd_HH:mm:ss
  • lastwrite_to (string): fecha de última escritura hasta en formato yyyy-MM-dd_HH:mm:ss

/storage/disks

• GET: Obtiene el listado de repositorios de tipo disco configurados
• PUT + storageDisk: Añade un nuevo repositorio de tipo disco al sistema
• POST + storageDisk: Modifica un repositorio de tipo disco existente

/storage/disks/{storageName}

• GET: Obtiene todos los datos de un repostorio de tipo disco de nombre storageName
• DELETE: Elimina un repositorio de tipo disco llamado storageName

/storage/remotes

• GET: Obtiene el listado de repositorios remotos configurados
• PUT + storageRemote: Añade un nuevo repositorio remoto al sistema
• POST + storageRemote: Modifica un repositorio remoto existente

/storage/remotes/{storageName}

• GET: Obtiene todos los datos de un repositorio remoto de nombre storageName
• DELETE: Elimina un repositorio remoto llamado storageName

/storage/libraries

• GET: Obtiene el listado de repositorios de tipo librería configurados
• PUT + storageLibrary: Añade un nuevo repositorio de tipo librería al sistema
• POST + storageLibrary: Modifica un repositorio de tipo librería existente

/storage/libraries/{storageName}

• GET: Obtiene todos los datos de un repostorio de tipo librería de nombre storageName
• DELETE: Elimina un repositorio de tipo librería llamado storageName

/storage/libraries/{storageName}/slots

• GET: Obtiene los slots disponibles del repositorio de tipo librería llamado storageName

/storage/libraries/{storageName}/umount/drive/{numDrive}

• GET: Desmonta el drive numDrive del repositorio de tipo librería llamado storageName

/storage/libraries/{storageName}/mount/drive/{numDrive}/slot/{numSlot}

• GET: Monta el slot numSlot en el drive numDrive del repositorio de tipo librería llamado storageName

/storage/libraries/{storageName}/format/drive/{numDrive}

• GET: Formate la cinta montada en en un drive numDrive del repositorio de tipo librería llamado storageName

/storage/libraries/{storageName}/drives

• GET: Obtiene el listado de drives de la librería

/storage/tapes

• GET: Obtiene el listado de repositorios de tipo cinta configurados
• PUT + storageTape: Añade un nuevo repositorio de tipo cinta al sistema
• POST + storageTape: Modifica un repositorio de tipo cinta existente

/storage/tapes/{storageName}

• GET: Obtiene todos los datos de un repositorio de tipo cinta de nombre storageName
• DELETE: Elimina un repositorio de tipo cinta llamado storageName

/format/{storageName}

• GET: Formatea la cinta asociada al repositorio

/mount/{storageName}

• GET: Monta la cinta asociada al repositorio

/umount/{storageName}

• GET: Desmonta la cinta asociada al repositorio

/hypervisors

• GET: Obtiene el listado de hipervisores definidos
• PUT + hypervisor: Añade un nuevo hipervisor
• POST + hypervisor: Edita un hipervisor existente

/hypervisors/{name}

• GET: Obtiene la configuración de un hipervisor llamado name
• DELETE: Elimina un hipervisor llamado name

/hypervisors/jobs

• GET: Obtiene los jobs configurados de tipo hipervisor en el sistema
• PUT + hypervisorJob: Añade un nuevo trabajo de hipervisor
• POST+ hypervisorJob: Edita un trabajo de hipervisor existente

/hypervisors/jobs/{name}

• GET: Obtiene la configuracion de un trabajo de tipo hipervisor de nombre name
• DELETE: Elimina un trabajo de hipervisor de nombre name

/hypervisors/{name}/jobs

• GET: Obtiene los jobs de hipervisor de un hipervisor llamado name

/hypervisors/{name}/machines

• GET: Obtiene las máquinas accesibles mediante el hipervisor llamado name

/hypervisors/{hypervisorName}/machines/{machineName}

• GET: Obtiene los datos de una maquina virtual concreta

/hypervisors/{hypervisorName}/machines/storage/{storageName}

• GET: Obtiene las maquinas asociadas a cierto repositorio

/hypervisors/{hypervisorName}/stores

• GET: Obtiene los datastores accesibles mediante un hipervisor de nombre hypervisorName

/jobs

• PUT + jobScheduled: Añade un nuevo trabajo planificado
• POST + jobScheduled: Edita un trabajo planificado existente
  • Si no recibe listado de scripts (no se recibe etiqueta <scripts>), los scripts asociados al job no se modifican
  • Si se recibe una etiqueta scripts vacía, los scripts se eliminarían

/jobs/archieved/

• GET: Obtiene el listado de todos los trabajos presentes en el catálogo.
  
  • Filtro por fechas disponible en el formato: yyyy-MM-dd_HH:mm:ss usando los siguientes parámetros:
    • starttime_from
    • starttime_to
    • endtime_from
    • endtime_to
    • realendtime_from
    • realendtime_to
    • modified_from
    • modified_to
      • Podemos usar los parámetros modifed_ para obtener los trabajos que han sido modificados desde esa fecha concreta (útil para procesos externos de lectura de jobs en equipos con infinidad de jobs en los que la query tarda mucho. De esta forma podemos obtener jobs de forma 'incremental')
  • Otros filtros:
    
    • pool (string): Nombre de un pool existente
    • storage (string): Nombre de un repositorio existente
    • clientName (string): Nombre de cliente asociado existente
    • type (string): Tipo de job: Backup, Copy, Migration
    • level (string): Nivel del job: Full, Incremental, Differential
    • category (string): Nombre de categoría(s)
    • status (string): Estado del job: (Running, Completed successfully, Fatal error ..)
    • page (int) y recordsByPage (int): Paginación del resultado

/jobs/archieved/deleted

• GET: Obtiene el listado de los jobs borrados desde una fecha indicada con en parámetro 'deleted_from' en formato yyyy-MM-dd_HH:mm:ss

/jobs/archieved/client/name/{clientname}

• GET: Obtiene el listado de trabajos presentes en el catálogo para un cliente de nombre clientname. Los clientes Vmware han de emplear este método para obtener el listado de sus jobs, ya que carecen de identificador.

/jobs/archieved/client/{clientid}

• GET: Obtiene el listado de trabajos presentes en el catálogo para un cliente de identificador clientId

/jobs/archieved/{jobid}

• DELETE: Elimina un trabajo con identificador jobId

/jobs/archieved/{jobname}

• GET: Obtiene el último trabajo incorporado en el catálogo (finalizado, corriendo...) para el trabajo de nombre jobname

/jobs/archieved/id/{jobid}

• GET: Obtiene un trabajo a partir de su identificador

/jobs/archieved/copyof/{jobid}

• GET: A partir del jobid de un job tipo 'c' coordinador de copias, obtiene el trabajo de datos tipo 'C' asociado (si existe).

/jobs/archieved/failed

• GET: Obtiene el listado de jobs (ejecuciones) cuya última ejecución no fue exitosa
  • parámetro failedExecutions: Número entero que indica cuántas ejecuciones fallidas consecutivas hay que considerar para incluir a un trabajo en el listado (ej: /jobs/archieved/failed?failedExecutions=2)
  • parámetro showOne: true | false: Indica si se muestra sólo una ocurrencia o todas, de cada uno de los trabajos/ejecuciones que cumplen la condición (/jobs/archieved/failed?showOne=true)

/jobs/log/{jobid}

• GET: Obtiene el log de un job
  • parámetro text: Valor boolean (true | false) para obtener el log en formato texto. Si no se indica, se obtienen objetos tipo jobLog

/jobs/scheduled/

• GET: Obtiene el listado de configuraciones de todos los trabajos del sistema
  • parámetro storage: Filtro por repositorio (obtener trabajos que usan el repositorio seleccionado. Ej: /jobs/scheduled?storage=STG-BACKUP-DISK-A)
  • parámetro schedule: Filtro por planificación (obtener trabajos que usan la planificación seleccionada. Ej: /jobs/scheduled?schedule=PLAN-WED-9H)
  • parámetro clientId: Filtro por cliente (obtener trabajos asociados a el cliente indicado. Ej: /jobs/scheduled?clientId=27)

/jobs/scheduled/{jobname}

• GET: Obtiene la configuración de un trabajo de nombre jobname
• DELETE: Elimina el trabajo configurado de nombre jobname

/jobs/scheduled/client/{clientid}

• GET: Obtiene los trabajos configurados para el cliente de identificador clientid

/jobs/scheduled/client/name/{clientname}

• GET: Obtiene los trabajos configurados para el cliente de nombre clientname. Los clientes Vmware han de emplear este método para obtener el listado de sus jobs, ya que carecen de identificador.

/jobs/inventory

• GET: Obtiene el inventario de bakups del sistema. El inventario es un resumen de los jobs configurados, con datos específicos sobre el cliente asociado, repositorio y filesets. Es una lista de objetos inventoryBackup.

/jobs/inventory/{job}

• GET: Obtiene los datos de inventario de un trabajo específico. El inventario contiene datos específicos sobre el cliente asociado, repositorio y filesets. Es un objeto inventoryBackup.

/jobs/plan

• GET: Obtiene la planificación de todos los trabajos del sistema para los próximos N días
  • parametro days: Número de días para la obtención del plan. Si no se especifica, por defecto es 30 (ej: /jobs/plan?days=60)

/jobs/plan/{jobName}

• GET: Obtiene la planificación del trabajo indicado para los próximos N días
  • parametro days: Número de días para la obtención del plan. Si no se especifica, por defecto es 30 (ej: /jobs/plan?days=60)

/jobs/restart/{jobid}

• GET: Reinicia un job

/jobs/run/{jobName}

• GET: Lanza un job
  • parámetro when: Hora de lanzamiento del job. Si no se especifica, se lanza inmediatamente. Parámetro en formato fecha yyyy-MM-dd_HH:mm:ss. Ej: /jobs/run/backupOracle?when=2018-06-12_08:00:00)
  • parámetro level: Nivel de lanzamiento del job (Full, Incremental Differential). Ej: /jobs/run/backupOracle?level=Incremental

/jobs/cancel/{jobid}

• GET: Cancela un job

/jobs/stop/{jobid}

• GET: Detiene/pausa un job

/jobs/prune/{clientId}

• GET: Elimina los trabajos antiguos para el cliente de identificador clientId

/jobs/running

• GET: Indica si hay jobs running o no con un mensaje <success>XX</success> que puede tomar los valores true o false

/files/{clientId}

• GET: Obtiene el listado de ficheros de los que se tiene copia para el cliente de identificador clientId
  
  • Opcional: Se puede especificar el directorio en base al cual obtener el listado, así como parámetros de paginación con: directory, max_entries y pag.
  • El directorio ha de ir codificado en formato URL y UTF-8. Por ejemplo: 
    • Directorio: C;/Backup     |      Resultados por pagina:20       |     Pág. 2
      /files/{clientId}?directory=C%3A%2FBackup%2F&&max_entries=20&pag=2

/files/job/{jobId}

• GET: Obtiene e listado de ficheros respaldados por el job de identificador jobId
  • Opcionales:
    • totalSize (boolean). Si se especifica (totalSize=true), se devuelve la suma total del tamaño respaldado por ese job
    • omitSizeInfo (boolean); Si se especifica (omitSizeInfo=true), se omite la información de tamaño y fecha de cada archivo. Esto aumenta enormemente el rendimiento de estas consultas
    • page (int) y recordsByPage (int): Permiten paginar el resultado para consultas de jobs muy grandes (casos VF, por ejemplo).

/files/versions/find?path=XX

• GET: Obtiene el listado de jobs que han respaldado un path completo dado que viene especificado por la variable path.
  • Opcionales:
    • clientId (int): Identificador de cliente
    • level (string): Nivel para filtrar jobs (F, I, D..)

/files/{clientId}/jobs

• GET: Obtiene los jobs que han hecho backup para un determinado archivo, que se indica como parámetro:
  • El archivo se indica con el parámetro file. Es posible especificar parámetros de paginación con: max_entries y pag.
  • El archivo ha de ir codificado en formato URL y UTF-8. Por ejemplo: archivo: C;/Backup     |      Resultados por pagina:20
    /files/{clientId}?file=C%3A%2FBackup%2F&&max_entries=20

/files/{clientId}/restore/version/{jobId}

• GET: Lanza una recuperación por versión del cliente clientId, utilizando el job jobId, del archivo especificado como parámetro file (en formato URL y UTF-8)
  • Opcionales en la petición:
    • destinationClientId: Identificador del cliente donde restaurar el/los archivo/s
    • destinationPath: Path donde restaurar el/los archivo/s
    • lv: Volúmen lógico donde restaurar el/los archivos si el cliente destino es el cliente local airback-fd
    • share: Volúmen lógico compartido donde restaurar el/los archivos si el cliente destino es el cliente local airback-fd
    • prescript: Script a ejecutar antes de lanzar la restauración
    • postscript: Script a ejecutar después de lanzar la restauración
    • dependentJobs: boolean que indica si se deben buscar y aplicar los posibles trabajos dependientes a la restauración

/files/{clientId}/restore/date

• GET: Lanza una recuperación por fecha del cliente clientId, utilizando:
  • Fecha máxima: parámetro date en formato yyyy-MM-dd_HH:mm:ss
  • Archivos: Parámetros file (en formato URL y UTF-8): http://.......?file=file1&file=file2&file=file3....
  • Opcionales en la petición:
    • destinationClientId: Identificador del cliente donde restaurar el/los archivo/s
    • destinationPath: Path donde restaurar el/los archivo/s
    • lv: Volúmen lógico donde restaurar el/los archivos si el cliente destino es el cliente local airback-fd
    • share: Volúmen lógico compartido donde restaurar el/los archivos si el cliente destino es el cliente local airback-fd
    • prescript: Script a ejecutar antes de lanzar la restauración
    • postscript: Script a ejecutar después de lanzar la restauración

/files/job/{jobId}

• GET: Obtiene el listado completo de archivos respaldados por un trabajo, a partir de su jobid

/files/storages

• GET: Devuelve el listado de ficheros respaldados por un conjunto de repositorios entre dos fechas dadas:
  • Fecha hasta: parámetro to en formato yyyy-MM-dd_HH:mm:ss
  • Fecha desde: parámetro from en formato yyyy-MM-dd_HH:mm:ss
  • Lista de storages: lista de parámetros storage con el nombre de cada repositorio implicado. Se debe indicar o bien esta lista, o bien el parámetro libraries=true.
  • Búsqueda en librerías: parámetro booleano libraries que, si se utiliza con el valor true, buscaría en todos los repositorios de tipo librería (locales o remotas). Si se utiliza este parámetro, no se debe indicar ningún storage en 'Lista de storages'.
  • Opcionales:
    
    • Tipo: Permite filtrar con el parámetro type por el tipo de job ('B', 'C', 'c', 'R')
    • Lista de paths por los que filtrar: lista de parámetros include con la ruta por las rutas por las cuales filtrar. Cualquier archivo que en su ruta contenga alguno de los includes indicados, será mostrado en la salida.
  • Ejemplo:
    • http://x.x.x.x/resources/files/storages?from=2016-09-20_00:00:00&to=2016-09-21_00:00:00&include=share&libraries=true
      • Obtendría la lista de ficheros respaldados entre los días 20 y 21 de todas las librerías del sistema en los que estuviesen implicados volúmenes compartidos

/vmware/client/{clientName}/machines

• GET: Obtiene el listado de máquinas virtuales de las que se tiene backup para el cliente clientName. Este listado muestra nombre e identificador vm-x de cada máquina.

/vmware/client/{clientName}/machines/{virtualMachineId}/jobs

• GET: Obtiene el listado de versiones (jobs) de cierta máquina virtual virtualMachineId (vm-x ó nombre de máquina). Su consulta es necesaria antes de lanzar una recuperación Vmware por versión.

/files/vmware/client/{clientName}/restore/date

• GET: Lanza una recuperación por fecha de un conjunto de máquinas virtuales para el cliente clientName, utilizando como parámetros en la URL:
  • Fecha máxima: parámetro date en formato yyyy-MM-dd_HH:mm:ss
  • Máquinas virtuales a restaurar: Parametros machine (en formato URL y UTF-8): http://.......?machine=vm-1334&machine=vm-34&machine=Windows2003X1....
  • Host: parámetro host para indicar el nombre del host destino donde lanzar la restauración
  • Datastore: parámetro datastore para indicar el datastore destino donde lanzar la restauración

/files/vmware/client/{clientName}/restore/version/job/{jobId}

• GET: Lanza una recuperación por versión de un conjunto de máquinas virtuales para el cliente clientName y la versión de job jobId, utilizando como parámetros en la URL:
  • Máquinas virtuales a restaurar: Parametros machine (en formato URL y UTF-8): http://.......?machine=vm-1334&machine=vm-34&machine=Windows2003X1....
  • Host: parámetro host para indicar el nombre del host destino donde lanzar la restauración
  • Datastore: parámetro datastore para indicar el datastore destino donde lanzar la restauración

/files/rhv/job/{jobId}/machines?path={path}

• GET: Listado de máquinas respaldadas que tiene un determinado job {jobId}.
  • (Opcional) Permite obtener los discos de una máquina específica {path}. Formatos permitidos: path=/vm1/ || path=vm1 || path=/vm1.

/files/rhv/client/{cName}/machines/{mName}/jobs

• GET: Listado de jobs pertenecientes al cliente {cName} que contienen un backup de la máquina especificada {mName}.

/files/rhv/restore

• POST: Realización de una restauración a partir de un jobId o una fecha en concreto. Prioriza el parámetro fecha.

/files/docker/job/{jobId}/machines?path={path}

• GET: Listado de los elementos respaldados que tiene un determinado job {jobId}.
  • (Opcional) Permite obtener los discos de una máquina específica {path}. Formatos permitidos: path=/image/ || path=image || path=/image.

/files/docker/restore

• POST: Realización de una restauración a partir de un jobId o una fecha en concreto. Prioriza el parámetro fecha.

/files/kubernetes/job/{jobId}/machines?path={path}

• GET: Listado de los elementos respaldados que tiene un determinado job. 

/kubernetes/client/{cName}/machines?path={path}

• GET: Listado de jobs del cliente definido en {cName} que almacenan los elementos definidos por el argumento {path}

/kubernetes/restore

• POST: Realización de una restauración a partir de un jobId o una fecha en concreto. Prioriza el parámetro fecha.

/templates/

• GET: Obtiene el listado de las plantillas configuradas
• PUT + template: Añade una nueva plantilla al sistema
• POST + template: Modifica una plantilla existente

/templates/{templateName}

• GET: Obtiene la plantilla con el nombre de {templateName}
• DELETE: Elimina la plantilla llamada {templateName}

/aggregates

• GET: Obtiene el listado de agregados definidos en el sistema
• PUT + aggregate: Añade un nuevo agregado
• POST + aggregate: Edita un agregado existente

/aggregates/{aggregateName}

• GET: Obtiene los datos de un agregado de nombre aggregateName
• DELETE: Elimina un agregado

/aggregates/refresh

• GET: Intenta montar todos los volúmenes de todos los agregados del sistema

/aggregates/{aggregateName}/umount

• GET: Desmonta todos los volúmenes del agregado aggregateName

/aggregates/devices

• GET: Obtiene los dispositivos sin asignar del sistema

/aggregates/recover/{aggregateName}

• GET: Intenta forzar la recuperación de un agregado de tipo ZFS que tuviese de nombre aggregateName

/volumes

• GET: Obtiene el listado de volúmenes del sistema
• PUT + volumeAdd: Añade un nuevo volúmen

/volumes/aggregate/{aggregateName}

• GET: Obtiene los volúmenes definidos pertenecientes al agregado aggregateName

/volumes/extend

• POST + volumeExtend;
  
  • Extiende el tamaño de un volumen
  • (opcional) Modifica los parámetros zfs de cuotas y reservas
  • (opcional) Establece la política de snapshots

/volumes/reduce

• POST + volumeExtend:
  • Reduce el tamaño de un volumen
  • (opcional) Modifica los parámetros zfs de cuotas y reservas
  • (opcional) Establece la política de snapshots

/volumes/aggregate/{aggregateName}/volume/{volumeName}

• GET: Obtiene los datos de un volumen concreto llamado volumeName del agregado aggregateName
• DELETE: Elimina un volumen concreto llamado volumeName del agregado aggregateName

/volumes/aggregate/{aggregateName}/volume/{volumeName}/snapshot

• GET: Obtiene el listado de snapshots asociados a un volumen llamado volumeName del agregado aggregateName

/volumes/aggregate/{aggregateName}/volume/{volumeName}/snapshot/make

• GET: Realiza un snapshot manual sobre el volumen volumeName perteneciente al agregado aggregateName

/volumes/aggregate/{aggregateName}/volume/{volumeName}/snapshot/{snapshotName}

• GET: Obtiene los datos del snapshot snapshotName, del volumen volumeName perteneciente al agregado aggregateName
• DELETE: Elimina el snapshot snapshotName, del volumen volumeName perteneciente al agregado aggregateName

/iscsi

• GET: Obtiene el listado de targets iscsi definidos en el sistema
• PUT + iscsiTarget: Añade un nuevo target iscsi
• DELETE: Elimina todos los targets iscsi definidos

/iscsi/{iqn}

• DELETE: Elimina el target iscsi de iqn iqn

/iscsi/vg/{vg}/lv/{lv}

• GET: Obtiene los targets iscsi definidos para el volumen lv del agregado vg

/iscsi/type/{type}

• GET: Lista los targets iscsi por tipo. El tipo puede ser autochanger, tape o volume.

/iscsi/external

/iscsi/external/outdated

• GET: Obtiene el listado de accesos de targets iscsi externos que no son accesibles

/iscsi/external/outdated/remove/address/{address}/port/{port}

• DELETE: Elimina del histórico de accesos de targets iscsi externos el registro de ip address y puerto port

/iscsi/external/send

• GET: Obtiene los targets iscsi nuevos disponibles para la sesión

/iscsi/external/search/address/{address}

• GET: Lanza una búsqueda de targets iscsi externos disponibles en la dirección ip address

/iscsi/external/login

• PUT + iscsiExternalTargetLogin: Lleva a cabo un login iscsi en un target externo

/iscsi/external/logout

• POST + iscsiExternalTargetLogin: Lleva a cabo un logout iscsi de un target externo

/iscsi/airback/name

• GET: Obtiene el nombre de iniciador iscsi de WBSAirback

/iscsi/vg/{vg}/lv/{lv}/snapshot/{snapshot}

• GET: Obtiene un target de tipo snapshot, de nombre snapshot, del volumen lv perteneciente al agregado vg.
• PUT: Añade un target de tipo snapshot llamado snapshot para el volumen lv del agregado vg.

/replication/sources

• GET: Obtiene el listado de orígenes de replicación configuradas.
• PUT + replicationDestination: Añade un nuevo origen de replicación
• POST + replicationDestination: Edita un origen de replicación

/replication/sources/vg/{vg}/lv/{lv}/address/{address}

• GET: Obtiene los datos de configuración de un origen de replicación de agregado vg, volumen lv y dirección address
• DELETE: Elimina un origen de replicación de agregado vg, volumen lv y dirección address

/replication/destinations

• GET: Obtiene el listado de destinos de replicación configuradas.
• PUT + replicationDestination: Añade un nuevo destino de replicación
• POST + replicationDestination: Edita un destino de replicación

/replication/destinations/vg/{vg}/lv/{lv}/address/{address}

• GET: Obtiene los datos de configuración de un destino de replicación de agregado vg, volumen lv y dirección address
• DELETE: Elimina un destino de replicación de agregado vg, volumen lv y dirección address

/replication/interval

• GET: Obtiene el intervalo de replicación configurado

/replication/interval/{minutes}

• GET: Establece un nuevo intervalo de replicación

/replication/executions

• GET: Obtiene el listado de ejecuciones de sincronización

/cloud/accounts

• GET: Obtiene el listado de cuentas en la nube configuradas
• PUT + cloudAccount: Añade una nueva cuenta en la nube
• POST + cloudAccount: Edita una cuenta en la nube existente

/cloud/accounts/{alias}

• GET: Obtiene los datos de configuración de una cuenta en la nube de nombre alias
• DELETE: Elimina una cuenta en la nube de nombre alias

/cloud/disks

• GET: Obtiene los discos en la nube definidos
• PUT + cloudDisk: Añade un nuevo disco en la nube

/cloud/disks/device/{device}

• GET: Obtiene el disco en la nube definido con identificador de dispositivo device

• DELETE: Elimina el disco en la nube con identificador de dispositivo device

/cloud/disks/unassigned

• GET: Obtiene el listado de discos en la nube definidos que no están asignados a ningún agregado

/cloud/disks/group/{group}/stats

• GET: Obtiene las estadísticas de I/O de un disco en la nube

/cloud/disks/group/{group}

• GET: Obtiene el listado de discos en la nube asociados al agregado de nombre group

/quota/users

• PUT + quotaAdd:Añade una nueva quota de disco de usuario

/quota/users/group/{group}/volume/{volume}

• GET: Obtiene las quotas de usuario del volumen volume del agregado group

  • Parametro de query match: Cadena por la que buscar el nombre del grupo

/quota/users/group/{group}/volume/{volume}/username/{username}

• GET: Obtiene los datos de una quota de usuario de nombre groupname del volumen volume del agregado group
• DELETE: Elimina la quota de usuario de nombre groupname del volumen volume del agregado group

/quota/groups

/groups/group/{group}/volume/{volume}

• GET: Obtiene las quotas de grupo del volumen volume del agregado group
  
  • Parametro de query match: Cadena por la que buscar el nombre de usuario

/quota/groups/group/{group}/volume/{volume}/groupname/{groupname}

• GET: Obtiene los datos de una quota de grupo de nombre groupname del volumen volume del agregado group
• DELETE: Elimina la quota de grupo de nombre groupname del volumen volume del agregado group

/shares

• PUT + share: Añade un nuevo volumen compartido
• POST + share: Edita un volumen compartido existente

/shares/type/{type}

• GET: Obtiene el listado de volúmenes compartidos por tipo. El tipo puede ser: NFS, CIFS ó FTP

/shares/type/{type}/aggregate/{aggregateName}/volume/{volumeName}

• GET: Obtiene los datos de un volumen compartido del volumen volumeName del agregado aggregateName
• DELETE: Elimina el volumen compartido del volumen volumeName del agregado aggregateName

/shares/external

• GET: Obtiene el listado de volúmenes compartidos externos configurados
• PUT + shareExternalAdd: Añade un nuevo volumen compartido externo
• POST + shareExternalAdd: Modifica un volumen compartido externo existente

/shares/external/server/{server}?share={share}

• GET: Obtiene los datos de conrfiguración del volumen comparitdo externo share que se encuentra en el servidor server
• DELETE: Elimina el volumen comparitdo externo share que se encuentra en el servidor server

/groupjob

• GET: Obtiene el listado de group jobs
• PUT + group: Añade un grupo de jobs de tipo manual (agrupación de jobs existentes)
• POST + group: Modifica un grupo de jobs de tipo manual (agrupación de jobs existentes)

/groupjob/configure

• PUT + groupJobConfig: Añade un grupo de jobs a partir de la configuración de una plantilla
• POST + groupJobConfig: Añade un grupo de jobs a partir de la configuración de una plantilla

/groupjob/{name}/configuration

• GET: Obtiene la configuración de un grupo de jobs llamado name
• DELETE: Elimina la configuración de un grupo de jobs llamado name, pero no el grupo de jobs en si

/groupjob/{name}

• GET: Obtiene todos los datos de un grupo de jobs llamado name
• DELETE: Elimina un grupo de jobs llamado name

/groupjob/{name}/launch

• GET: Lanza la ejecución de un grupo de jobs llamado name

/groupjob/{name}/stop

• GET: Detiene la ejecución de un grupo de jobs llamado name

/groupjob/{name}/cancel

• GET: Cancela la ejecución de un grupo de jobs llamado name

/groupjob/{name}/restart

• GET; Reinicia la ejecución de un grupo de jobs llamado name

/advanced/templatejob

• GET: Obtiene el listado de las plantillas existentes
• PUT + templateJob: Añade una nueva plantilla al sistema
• POST + templateJob: Edita una plantilla existente

/advanced/templatejob/{name}

• GET: Obtiene todos los datos asociados a una plantilla llamada name
• DELETE: Elimina una plantilla de nombre name

/advanced/storage

• GET: Obtiene el listado de advanced storages configurados
• PUT + advancedStorage: Añade un nuevo elemento advanced storage
• POST + advancedStorage: Edita un elemento advanced storage existente

/advanced/storage/{name}

• GET: Obtiene los datos de un elemento advanced storage llamado name
• DELETE: Elimina un advanced storage llamado name

/advanced/storage/{storageName}/step/{stepName}

• DELETE: Elimina un paso llamado stepName asociado a un advanced storage llamado storageName

/advanced/step

• GET: Obtiene el listado de pasos existente.
• PUT + step: Añade un nuevo paso
• POST + step: Edita un paso existente

/advanced/step/{name}

• GET: Obtiene el paso de nombre name
• DELETE: Elimina el paso de nombre name

/advanced/step/type/{type}

• GET: Obtiene el listado de pasos del tipo type.
  • Los tipos validos son: backup, advanced_storage, script_process y script_application

/advanced/script

• GET: Obtiene el listado de procesos de script configurados en el sistema
• PUT + scriptProcess: Añade un nuevo proceso de script
• POST + scriptProcess: Edita un proceso de script existente en el sistema

/advanced/script/{name}

• GET: Obtiene la configuración de un proceso de script llamado name
• DELETE: Elimina un proceso de script llamado name

/advanced/inventory/system

• GET: Obtiene el listado de sistemas configurados en el inventario
• PUT + system: Añade un nuevo sistema al inventario
• POST + system: Edita un sistema existente en el inventario

/advanced/inventory/system/{name}

• GET: Obtiene la configuración de sistema del inventario llamado name
• DELETE: Elimina un sistema llamado name del inventario

/advanced/inventory/application

• GET: Obtiene el listado de aplicaciones configuradas en el inventario
• PUT + application: Añade una nueva applicación al inventario
• POST + application: Edita una aplicación existente en el inventario

/advanced/inventory/application/{name}

• GET: Obtiene la configuración de una aplicación del inventario llamada name
• DELETE: Elimina una aplicación llamada name del inventario

/advanced/inventory/storage

• GET: Obtiene el listado de elementos storage configurados en el inventario
• PUT + storageInventory: Añade un nuevo storage al inventario
• POST + storageInventory: Edita un storage existente en el inventario

/advanced/inventory/storage/{name}

• GET: Obtiene la configuración de un elemento storage del inventario llamado name
• DELETE: Elimina un elemento storage llamado name del inventario

/cdp/jobs

• GET: Obtiene el listado de jobs ejecutados en este módulo
  • parámetro from: parámetro en formato fecha yyyy-MM-dd_HH:mm:ss. Ej: /cdp/jobs?from=2018-05-12_09:15:00
  • parámetro to: parámetro en formato fecha yyyy-MM-dd_HH:mm:ss. Ej: /cdp/jobs?to=2018-06-12_23:15:00

/cdp/jobs/{userName}

• GET + userName: Obtiene el listado de jobs ejecutados en este módulo por el usuario indicado
  • parámetro from: parámetro en formato fecha yyyy-MM-dd_HH:mm:ss. Ej: /cdp/jobs/Win2012SQL?from=2018-05-12_09:15:00
  • parámetro to: parámetro en formato fecha yyyy-MM-dd_HH:mm:ss. Ej: /cdp/jobs/Win2012SQL?to=2018-06-12_23:15:00