OpenText Core Endpoint Backup offers a REST API that provides access to key administrative functions within the Core Endpoint Backup vault dashboard. Using the API, you can manage companies, users, user groups, devices, and partners, as well as perform administrative tasks like restoring devices or setting legal holds.
Before you can start making API calls, your account needs to be enabled for API access. This isn’t on by default—you’ll need to reach out to OpenText Support to have it activated.
Once access is granted, you can authenticate and start working with the endpoints.
-
Endpoints & Authentication: Each request requires a valid JSON Web Token (JWT) in the header.
-
Supported Operations: The API allows you to create, update, list, and delete companies, users, and devices. You can also perform tasks such as suspending or replacing devices, managing user groups, sending passcodes, and initiating restores.
-
Swagger Access: You can view the full API documentation directly from your vault by going to
<yourvaultname>/swagger— for example,https://red-region.mysecuredatavault.com/swagger.
Make sure your environment supports TLS 1.2. Without it, you’ll encounter errors like:
System.ServiceModel.CommunicationException: 'An error occurred while making the HTTP request… This could be due to the fact that the server certificate is not configured properly with HTTP.SYS in the HTTPS case…'
- If you’re developing in C#, ensure your project targets .NET Framework 4.7.2 or later, or add this line to force TLS 1.2:
System.Net.ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
- If you’re using PowerShell, add this line at the top of your script:
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
That’s all you need to get started with the Core Endpoint Backup API. Once your JWT authentication is set up and your environment is configured for TLS 1.2, you can begin automating company, user, and device management directly through the REST interface.
