Outbound integrations

Through the public API endpoints, Acronis users can monitor and manage mission-critical Acronis Cyber Platform features from a third-party platform.
Examples include:

  • Configuring which features of Acronis Cyber Platform are available to MSPs and their customers.

  • Setting up usage quotas and collecting actual usage data.

  • Listing available workloads and Protection Plans, and assigning Protection Plans to workloads.

  • Receiving and processing alerts raised by Acronis Cyber Platform.

Development and deployment process

  1. Analyze requirements
    Determine:

    • The purpose of the integration.

    • Features that the integration will provide.

    • The Acronis platform data that the integration needs.

    • The Acronis API endpoints that the integration will use.

    Note

    For a list of typical outbound integration types, including scenario API details, see outbound integration scenarios.

  2. Create a CyberApp.
    This is necessary to list the integration on the Acronis integration catalogs.
    MSPs can then find and enable the integration directly within the Acronis Cyber Platform.

    Note

    For more information on CyberApps, see Inbound integrations (CyberApps).

    1. Register as a partner.

    2. Access Vendor Portal.

    3. Create the CyberApp.

      Important

      When you create a CyberApp, it is assigned a unique code.
      Note this down: you need it to implement API identification during development of the functionality, and to activate the integration for MSPs who enable it in the integration catalog.
      You can retrieve the CyberApp code later, if you cannot find it.
  3. Develop the integration functionality
    As part of the integration, you must implement the following:
    1. Add an API identification to every API query sent to Acronis by adding a header with a key of X-Application-Secret, with the value set to CyberApp code from step 2c, above.
      This helps Acronis monitor API load and resolve any API issues that might occur.
    2. As part of the integration configuration scenario, immediately after you have validated the Acronis API keys that the MSP will provide, you should make a single query to activate the integration for this tenant.
      In this query, use the CyberApp code from step 2c, above, as application_code.
      This will allow us to show in the Acronis Cyber Protect Platform that your integration is active for this tenant.
    3. If your integration includes a scenario where it can be disabled or switched off, we recommend that you also implement a single deactivation query.
      In this query, use the CyberApp code from step 2c, above, as application_code.
      This will allow us to show the correct activation status for your integration in the Acronis Cyber Protect Platform, should the MSP turn the integration off at some point.
  4. Create a CyberApp Description and provide marketing materials
    This determines how your integration will be presented in our integrations catalog and inside the Acronis Cyber Protect Platform.
    For more information, see Marketing a CyberApp.
  5. Deploy the CyberApp
    This publishes the integration marketing materials on Acronis integration catalogs.
    For more information, see Deploying the CyberApp.

In this section