3CX icon

3CX

Interact with 3CX telephony system

Actions462

Backups → Restore

AI-generated

Overview

The node provides functionality to restore backups in the 3CX telephony system. It is useful for scenarios where you need to recover a previous state of your 3CX configuration or data by uploading and applying a backup file. For example, if a system update or configuration change causes issues, restoring from a backup can quickly revert the system to a known good state.

Properties

Name Meaning
File Name The key or name of the backup file to restore. Supports expressions like {{$json.FileName}}.
Footprint A numeric value representing the footprint parameter sent in the request body.
Password Password string used to secure the backup restoration process, sent in the request body.

Output

The node outputs JSON data representing the result of the restore operation. This typically includes status information about whether the restore was successful or if any errors occurred. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API authentication token credential to connect securely to the 3CX system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate headers.

Troubleshooting

  • Common Issues:
    • Incorrect or missing backup file name may cause the restore to fail.
    • Invalid password or missing password when required will prevent restoration.
    • Network connectivity issues or incorrect server URL can block API communication.
  • Error Messages:
    • Authentication errors indicate problems with the provided API token or credentials.
    • Validation errors may occur if required properties are missing or malformed.
    • Server errors might indicate issues on the 3CX side; check server logs for details.

Links and References

Discussion