The `urbackup-server-api` module provides a Node.js interface for programmatic interaction with the UrBackup server's web API. It enables comprehensive management and monitoring of backup operations, including manipulating server and client settings, group management, task monitoring, initiating/stopping backups, accessing live logs, and fetching backup history. The current stable version is 0.92.2, indicating it is under active development and has not yet reached a 1.0.0 release. The project exhibits an iterative release cadence, with minor versions introducing new features and occasional method signature adjustments. Its primary differentiation lies in simplifying the automation and integration of UrBackup server administration directly within Node.js applications, making it valuable for server administrators and developers. Due to its pre-1.0 status, users should be aware that method signatures and functionality may change without major version bumps, necessitating a review of the CHANGELOG before updates.
npm install urbackup-server-apiVerified import paths — ran on the pinned version, not inferred.
This example initializes the UrbackupServer client and demonstrates how to retrieve server activity, list clients by group, and identify clients with failed or missing backups.
Consult the package's `CHANGELOG.md` for specific breaking changes and adjust your code accordingly after each minor version update.
If your application relies on `groupName` when both parameters are present for `getGroupMembers()`, explicitly remove the `groupId` parameter or ensure `groupId` is the intended filter.
Ensure your UrBackup server uses valid, trusted TLS certificates. For self-signed certificates in non-production environments, consider adding the certificate to your system's trust store or configuring Node.js to trust it without broadly disabling rejection.
Verify that the UrBackup server is online and reachable from your Node.js application. Check the `url` parameter in your `UrbackupServer` constructor and ensure no firewall rules are preventing access.
Double-check the `username` and `password` parameters against your UrBackup server's user credentials. Ensure the user has the necessary API access rights.
For development, you can temporarily set `process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'` (highly discouraged for production). The correct fix is to configure a trusted SSL certificate on your UrBackup server or provide Node.js with the necessary CA certificate to trust the self-signed certificate.
No dependency data recorded yet.