Using Arctera System Recovery RESTful Application Programming Interfaces (APIs)
Arctera System Recovery 24 continues to support a set of functions that can be hosted as RESTful APIs. The API Client uses the HTTP(S) protocol to make an API request to the Arctera System Recovery Server. The server processes the request and sends a response to the client with an appropriate HTTP status code indicating success or failure.
The REST API calls from a remote computer only work with a valid CA Authorized certificate or a Self-Signed Certificate. Arctera System Recovery 24 now provides the enhanced InstallWebAPI.exe utility. Which automatically creates and binds a Self-Signed Certificate while installing Arctera System Recovery.
In scenarios, as mentioned in below cases:
Case 1: To use a valid CA Authorized certificate or a Self-Signed Certificate of your choice.
Case 2: To use Arctera System Recovery RESTful Application Programming Interfaces on Windows Operating Systems with PowerShell version lesser than 3.0, you have to create a Self-signed certificate or use a valid CA Authorized certificate and bind the certificate using InstallWebAPI Utility.
The following steps should be followed:
-
On a machine with Arctera System Recovery installed, open the InstallWebAPI Utility using the command prompt in the administrator mode.
The InstallWebAPI Utility is located at the following path:
<Arctera System Recovery installation folder>/Agent/
The utility displays the following:
-
Bind Certificate-View Certificate-Unbind Certificate
-
Bind the certificate and after it is successful the Arctera WebAPI Services start and you can make the REST API calls using a program or interface of your choice from any remote machine.
To view a list of the supported APIs, refer to the following link:
Related information