Integration Guide
Search
Press
ESC
to dismiss
Acronis Cyber Platform
Architecture
Tenancy model
Access model
Licensing model
Identifying the integration type
Acronis-side (CyberApps)
CyberApp Standard
CyberApp components
CyberApp lifecycle
CyberApp examples
Endpoint security
Email security
Remote desktop
Password management
Vendor-side
Vendor-side lifecycle
The connector
Data mapping
Cyberapp data access scopes
API Authentication
Managing workloads
Reporting workloads
Fetching workloads
Updating workload
Deleting a workload
Managing alerts
Fetching alerts
Step-by-step procedure
Reporting alerts
Step-by-step procedure
Dismissing alerts
Step-by-step procedure
Sample code (GitHub)
The callback handler
Callback formats
Callback request format
Callback response format
Verifying callback requests
Enabling the CyberApp
Mapped enablement
Mapped partner enablement
Reading the partner ID from your service
Mapping the partner ID to the Acronis tenant ID
Mapped customer enablement
Reading partner customers from your service
Reading the customer mapping from your service
Writing the customer mapping to your service
Changing CyberApp credentials
Disabling a mapped partner
Disabling a mapped customer
Mirrored enablement
Mirrored partner enablement
Getting partner enablement state
Enabling a partner using mirroring
Mirrored customer enablement
Getting customer enablement status
Enabling customers using mirroring
Disabling a mirrored partner
Disabling mirrored customers
Custom callbacks
Callback error handling
Callback handler verification
Postman collection
Sample code (GitHub)
Building an Acronis-side integration (CyberApp)
CyberApp components
CyberApp enablement
Acronis menu items
Alerts, workloads, and workload actions
Widgets and reports
Getting started
Accessing Vendor Portal
Learning about CyberApps
Creating your first CyberApp
Demo CyberApp
Building the SayHi demo CyberApp
Importing the SayHi demo CyberApp
Managing a CyberApp team
Managing CyberApps
Opening the CyberApp list
Creating a CyberApp
Opening a CyberApp
Deleting a CyberApp
DESCRIPTIONS (CyberApp marketing)
VERSIONS (CyberApp functionality)
Working with Versions
Opening the Version list
Actions and details panel
Creating an empty Version
Choosing and setting the CyberApp enablement method
Setting mapped partner and customer enablement
Setting mirrored partner and mapped customer enablement
Setting mirrored partner and customer enablement
Setting mirrored partner and explicit customer enablement
Setting explicit partner and mirrored customer enablement
Setting explicit partner and customer enablement
Opening a Version
Sending for approval
Version approval process
Duplicating a Version
Exporting and importing Versions
Exporting a Version package
Preparing a Version package for import
Importing a Version package
Deleting a Version
General settings
CyberApp access scopes
Callbacks
Opening the callback list
Adding a callback
Working with callback payloads
Adding the request payload
Adding a response payload
Composing JSON schema for a payload
Payload JSON schema technical reference
Editing a callback
Deleting a callback
CyberApp enablement form
Creating the CyberApp enablement form
Building the example
Customer enablement form
Creating the customer enablement form
Custom integration settings
Opening the custom settings tab list
Creating a custom settings tab
Editing a custom settings tab
Deleting a custom settings tab
Extension points
Alerts
Opening the alert type list
Adding an alert type
Creating an alert category
Editing an alert type
Deleting an alert type
Main menu
Opening the menu item list
Adding a menu item
Editing a menu item
Deleting a menu item
Building the example
Workloads and actions
Workload types
Mapping to Acronis workloads
Opening the workload type list
Creating a workload type
Editing a workload type
Deleting a workload type
Actions
Opening the action list
Creating an action
Editing an action
Deleting an action
Widgets and reports
Widgets
Creating a device status widget
Creating an alerts widget
Reports
Creating a CyberApp report
UI builder
Working with forms
Root forms
Dependent forms
Form groups
Specifying a data initializer callback
Adding input parameters
Mapping data between forms
Setting up footer buttons
The form model
Building a form
UI elements
INPUT CONTROLS
ACTION CONTROLS
CONTENT ELEMENTS
LAYOUT MANAGEMENT
TABLE
Defining element validation logic
Building element visibility logic
Callback mapping
Defining request mapping
Defining response mapping
DEPLOYMENT
Opening the deployment list
Opening the actions and details panel
Deployment request states
Deploying to test
Requesting production deployment
Opening a deployment request
Sending for approval
Production deployment request approval process
Deleting a deployment request
ACTIVITIES
Filtering the activities report
SETTINGS
Opening CyberApp settings
Renaming a CyberApp
Generating a new API key
Disabling the API connection
Enabling the API connection
CyberApp SSO service account
CyberApp OIDC SSO authentication
Before you start
Exchanging code
Checking user information
Generating SSO service account credentials
Regenerating your SSO service account credentials
Deleting the SSO service account
Technical reference
Cyber Type Identifier (CTI)
Versioning
Building a vendor-side integration
Remote monitoring and management (RMM)
Managing the integration
Enabling
Configuring
Viewing statistics
Troubleshooting the connection
Disabling
Tenant mapping
Multiple partner mapping
Creating new customers
Customer mapping
Deploying Acronis
Installing the Acronis agent
Deploying to domain controllers
Installing the agent for DB application backup
Tasks
Automating tasks
Creating or re-using protection plans
Monitoring
Synchronizing tickets and alerts
Mapping tickets
Creating tickets
Ticket options
Professional services automation (PSA)
Managing the integration
Enabling
Configuring
Viewing statistics
Troubleshooting the connection
Tenant mapping
Customer mapping
Multiple partner mapping
Mapping products
Mapping Acronis offering items to PSA SKUs
Provisioning/configuring offering items
Synchronizing usage
Customer provisioning
Provisioning
Automatic provisioning
Automatic de-provisioning
Synchronizing tickets and alerts
Mapping tickets
Creating tickets
Ticket options
Ticketing
Managing the integration
Enabling
Configuring
Viewing statistics
Troubleshooting the connection
Mapping tenants
Mapping multiple partners
Mapping customers
Synchronizing tickets and alerts
Mapping tickets
Creating tickets
Ticket options
Security Information And Event Management (SIEM)
Enabling the integration
Selecting customers
Alerts
Protection status
Acronis agent information
Configuring
Integration Platform as a Service (iPaaS) and Workflow Automation
Enabling the integration
Tenant actions
Creating or updating a customer tenant
Switching customer tenant to production
Finding a customer tenant
Creating or updating a user
Finding a user
Responding to new customer created
Ticket and alert actions
Creating a ticket
Updating a ticket
Finding a ticket
Dismissing an alert
Responding to a new alert
Product and offering item actions
Getting a list of available offering items
Enabling an offering item
Getting usage report
Creating a product
Creating a contract
Creating contract parts
Creating a ledger
Creating a tax
Disabling the integration
Acronis platform APIs
Marketing an integration
Acronis catalogs
Integration catalogs
The Application Catalog
Catalog card
Catalog detail page
Marketing a CyberApp
Opening the Description list
Actions and details panel
Creating a Description
Opening a Description
Managing Description content
General settings
About CyberApp
Images & videos
Features
Company contact
Support contact
Additional information
Sending for approval
Description approval process
Deploying a CyberApp to catalog only
Duplicating a Description
Localizing a Description
Exporting and importing Descriptions
Exporting a Description
Preparing a Description package for import
Importing a Description package
Deleting a Description
Marketing a vendor-side integration
Monitoring usage
Dashboard
Acronis platform APIs
Acronis product API locations reference
Requests and responses
Inspecting API response codes
HTTP status response codes
Getting started
Setting up the Python environment
Starting the Python shell and configuring its session
Authenticating to the Acronis platform
Acronis public API library
Agent Management
Authenticating
Pagination
Fetching agent information
Fetching all registered agents
Fetching a specific agent
Fetching the online status of an agent
Fetching the OS family of the host
Integration Management
Authenticating
API endpoint
Activating an integration
Deactivating an integration
Task Management
Authenticating
Managing tasks
Fetching a list of all tasks
Fetching a list of tasks that are in progress
Fetching a list of tasks started after the specified date
Fetching a list of tasks completed after the specified date
Fetching a list of tasks related to Office 365 backup and recovery
Managing activities
Fetching a list of all activities
Acronis API library change log
Acronis GitHub integration resources
Acronis forum for APIs and SDKs
Acronis Postman collections
Glossary
Copyright statement
Guide
Acronis platform APIs
Acronis public API library
Task Management
Managing activities
Managing activities
In this section
Fetching a list of all activities
Back to top