REST API Server / Creating and Exporting Backups in REST API Server
In this video of our N3uron Academy, we’re going to explore how to retrieve historical data using N3uron’s REST API Server Module. Let’s get started!
[00:00] Welcome, everyone! In today’s tutorial, we’ll learn how to create and export backups using N3uron’s REST API Server Module. For demonstration, we’ll use Postman as our API testing tool and follow the N3uron REST API Server documentation to structure our requests correctly. Let’s review our server configuration. As you can see, we’re using an HTTPS-secured connection on TCP port 3443, bound to a specific network interface. Additionally, we’ll be using embedded certificates for enhanced security. In this example, we authenticate with the REST API Server using Basic Authorization by logging in as a user with the Administrator Role, which is granted full permissions and complete access to the tag model.
[01:00] Alternatively, you can choose Token-based Authorization. Since we’re both creating and exporting backups, the Administrator Role must have GET and POST permissions on the backup endpoint. Before continuing, let’s navigate to N3uron’s Backup Manager, where all node backups are listed. In this case, no backups have been created yet. Now let’s open the API documentation in our browser to check how the requests are formed. We’ll begin with the Create Backup API call. Next, let’s open Postman, where we’ve already configured a POST request to create a backup. Let’s quickly review the request details. We’re using the HTTPS protocol, followed by the host IP address and port. The endpoint is ‘backup’, and the command is ‘create’. For authorization, we are using Basic Authorization for the admin user, along with its corresponding password. In the body of the request, we provide the parameters in JSON format, specifying the name of the backup and a metadata description for it.
[02:05] Next, let’s verify our request against the REST API documentation to ensure it’s properly structured. Since everything appears to be correct, let’s send the request. Let’s go back to the Backup Manager in N3uron to verify that the backup was successfully created. As you can see, the backup now appears in the list with the exact name provided, confirming that the backup was created successfully. Now let’s move on to exporting the backup to our local computer using the Export Backup API call. This time, while the endpoint remains ‘backup’, the command changes to ‘export’. Be sure to include the name parameter that exactly matches the backup you want to export. The authorization method remains Basic Authorization. Let’s refer to the API documentation once again to cross-check our request.
[03:03] Also, note that the retrieved backup is provided as a ZIP file encoded in Base64. Now let’s send the request. But instead of simply clicking Send, this time choose ‘Send and download’ from the dropdown menu. As expected, a dialog window appears prompting you to choose a folder for saving the response. In this case, we’re saving the file with a .zip.base64 extension to indicate that it’s a ZIP file encoded in Base64. Once the file is saved, locate the file on your system. If you’re using Windows, open a PowerShell terminal in that same folder, and run the following command: certutil -decode response.zip.base64 backup-2025-04-07.zip. Here, response.zip.base64 is the downloaded file, and backup-2025-04-07.zip will be the name of the resulting ZIP file. This command decodes the Base64-encoded response and produces the corresponding ZIP backup file.
[04:00] Now you can extract the ZIP file and verify that the configuration of your node was backed up successfully. That’s it for this video! We invite you to explore our N3uron REST API Server documentation further. Inside, you’ll find comprehensive details on server configuration, API calls, and examples to help you seamlessly integrate REST API Server with other services. Also, check out our Postman Collections for API documentation and code samples in multiple programming languages. Thanks for watching, and see you in the next one!
N3uron software is an Industrial Edge Platform for IIoT and DataOps that streamlines the flow of data between industrial systems and business applications, either on-premise or in the cloud. N3uron provides an out-of-the-box solution for data standardization, normalization and contextualization, seamless integration with industrial and IT systems, efficient information management, and unparalleled scalability and security. The N3uron platform makes it easier for operations teams to aggregate, manage and analyze industrial data, resulting in enhanced productivity and informed decision-making. Whether you're looking to optimize your operations, reduce downtime or improve product quality, the N3uron platform is the answer.
CONTRIBUTING MEMBER
N3uron is a Contributing Member of the Eclipse Foundation, actively participating in the development of their robust ecosystem. By leveraging EF technologies, we offer innovative products and services that drive our corporate strategy forward. N3uron is Sparkplug Compatible Software.
DLMS® UA MEMBER
N3uron is a member of the DLMS® User Association, the global community that drives standardization in the energy and water industry. Being part of the DLMS UA represents N3uron's commitment to advancing smart metering and energy management solutions.
FOLLOW US
N3uron Connectivity Systems • Paseo de la Castellana, 91, 4º, 1; Madrid, 28046, Spain • +34 911 841 938 • [email protected]
N3uron software is an Industrial Edge Platform for IIoT and DataOps that streamlines the flow of data between industrial systems and business applications, either on-premise or in the cloud. N3uron provides an out-of-the-box solution for data standardization, normalization and contextualization, seamless integration with industrial and IT systems, efficient information management, and unparalleled scalability and security. The N3uron platform makes it easier for operations teams to aggregate, manage and analyze industrial data, resulting in enhanced productivity and informed decision-making. Whether you're looking to optimize your operations, reduce downtime or improve product quality, the N3uron platform is the answer.
CONTRIBUTING MEMBER
N3uron is a Contributing Member of the Eclipse Foundation, actively participating in the development of their robust ecosystem. By leveraging EF technologies, we offer innovative products and services that drive our corporate strategy forward. N3uron is Sparkplug Compatible Software.
CONTRIBUTING MEMBER
N3uron is a Contributing Member of the Eclipse Foundation, actively participating in the development of their robust ecosystem. By leveraging EF technologies, we offer innovative products and services that drive our corporate strategy forward. N3uron is Sparkplug Compatible Software.
FOLLOW US
N3uron Connectivity Systems • Paseo de la Castellana, 91, 4º, 1; Madrid, 28046, Spain • +34 911 841 938 • [email protected]
N3uron software is an Industrial Edge Platform for IIoT and DataOps that streamlines the flow of data between industrial systems and business applications, either on-premise or in the cloud. N3uron provides an out-of-the-box solution for data standardization, normalization and contextualization, seamless integration with industrial and IT systems, efficient information management, and unparalleled scalability and security. The N3uron platform makes it easier for operations teams to aggregate, manage and analyze industrial data, resulting in enhanced productivity and informed decision-making. Whether you're looking to optimize your operations, reduce downtime or improve product quality, the N3uron platform is the answer.
CONTRIBUTING MEMBER
N3uron is a Contributing Member of the Eclipse Foundation, actively participating in the development of their robust ecosystem. By leveraging EF technologies, we offer innovative products and services that drive our corporate strategy forward. N3uron is Sparkplug Compatible Software.
DLMS® UA MEMBER
N3uron is a member of the DLMS® User Association, the global community that drives standardization in the energy and water industry. Being part of the DLMS UA represents N3uron's commitment to advancing smart metering and energy management solutions.
FOLLOW US
N3uron Connectivity Systems • Paseo de la Castellana, 91, 4º, 1; Madrid, 28046, Spain • +34 911 841 938 • [email protected]