Integration Guide
Search
Press
ESC
to dismiss
Release notes
Introduction to Acronis Cyber Platform
Architecture
Tenancy model
Access model
Licensing model
Integration types
The connector
Data mapping
Cyberapp data access scopes
API Authentication
Step-by-step procedure
Managing workloads
Reporting workloads
Step-by-step procedure
Fetching workloads
Step-by-step procedure
Updating a workload
Step-by-step procedure
Deleting a workload
Step-by-step procedure
Managing alerts
Fetching alerts
Step-by-step procedure
Reporting alerts
Step-by-step procedure
Dismissing alerts
Step-by-step procedure
Sample code in 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
Sample code in GitHub
Inbound integrations (CyberApps)
Release notes
Introduction to CyberApps
CyberApp Standard
CyberApp components
CyberApp enablement
Acronis menu items
Alerts, workloads, and workload actions
Widgets and reports
CyberApp lifecycle
CyberApp examples
Endpoint security
Email security
Remote desktop
Password management
Getting started
Accessing Vendor Portal
Learning about CyberApps
Creating your first CyberApp
Demo CyberApp
Building the demo CyberApp
Importing the demo CyberApp
Managing a CyberApp team
Managing CyberApps
Opening the CyberApp list
Creating a CyberApp
Opening a CyberApp
Deleting a CyberApp
OVERVIEW
DESCRIPTIONS (CyberApp marketing)
VERSIONS (CyberApp functionality)
Working with Versions
Opening the Version list
Actions and details panel
Creating a new 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
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
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
Input parameters
Adding input parameters
Using Acronis variables in default value strings
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
Element visibility
Building element visibility logic
Setting model condition types
Model condition type examples
Setting form-level condition types
Form-level condition type examples
Defining validation logic
Defining element spacing
Callback mapping
Defining request mapping
Defining response mapping
Mapping
Scenario 1: Both left and right properties are single values
Scenario 2: Both left and right properties are arrays
Scenario 3: Both left and right properties are arrays
Scenario 4: Both left and right properties are array properties
Scenario 4.1: Left property is a primitive or an object at root level, and right property is an array property
Scenario 5: Left property is an array and right properties is a single value
Scenario 6: Left property is an array property and right properties is a single value
DEPLOYMENT
Opening the deployment list
Opening a list entry side-panel
Filtering the deployment list
Deployment request states
Test environment deployments
Deploying to test
Opening the details panel
Opening the details pop-up
Production deployments
Requesting production deployment
Editing a draft production deployment request
Opening the actions and details panel
Opening the details pop-up
Deleting a production deployment request
Sending for approval
Production deployment request approval process
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
Cross-domain Type Identifier (CTI)
Versioning
Outbound integrations
Outbound integration scenarios
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
Getting started
Setting up the Python environment
Starting the Python shell and configuring its session
Authentication
Authenticating to the Acronis platform
Requests and responses
Inspecting API response codes
HTTP status response codes
Pagination
API library
Account Management
API error codes
Tutorials
Enabling the backup service for a user in a customer tenant
Provisioning a partner tenant
Provisioning a customer tenant
Switching a tenant to production
Creating a billing report
Changing quotas
Changing storage quotas of partner sub-tenants
Suspending / Reactivating / Terminating
Managing tenants
JSON object structures
Creating a tenant
Fetching information about an individual tenant
Fetching information about tenants
Fetching information about child tenants
Fetching the production start date of a tenant
Switching a customer tenant to production mode
Modifying tenant properties
Moving a tenant to another tenant
Limiting higher-level administrator access to a tenant
Disabling a tenant
Deleting a tenant
Managing services
JSON object structure
Fetching information about all platform services
Fetching information about services enabled for a tenant
Fetching information about an individual service
Enabling a service for a sub-tenant
Disabling a service for a sub-tenant
Managing offering items and quotas
JSON object structure
Fetching available offering items
Switching the edition of a service
Changing quotas
Enabling/disabling an offering item
Managing branding options
Enabling branding for a tenant
Disabling branding for a tenant
Fetching the branding options of a tenant
Updating branding options for a tenant
Configuring the “Buy URL” option
Updating the brand logo
Managing user accounts
JSON object structure
Creating a user account
Activating a user account
Managing user account roles
Fetching user account information
Changing a user account password
Changing a user account email
Changing a user account contact info
Disabling/enabling a user account
Deleting a user account
Managing locations and storages
Location object structure
Storage object structure
Creating a location
Fetching locations
Updating a location
Deleting a location
Registering a storage
Fetching storages
Updating a storage
Moving a storage
Deleting a storage
Managing upsell
Enabling quota upsell for a user account
Enabling upsell of service editions for a sub-tenant
Managing billing settings
Billing settings
Setting the partner tenant tier level and the licensing mode
Switching a partner tenant tier level
Fetching the pricing information for a tenant
Searching for tenants and user accounts
Searching for a tenant by its name
Searching for a user account by its login
Usage and reporting
Tenant service usage JSON object structure
Fetching tenants usage batch
Managing reports
Advanced operations
How to log in to service consoles on behalf of another user
Managing two-factor authentication
Supported language codes
Agent Management
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
API endpoint
Activating an integration
Deactivating an integration
Resource and Policy Management
API error codes
Managing resources
Fetching a list of all resources
Fetching a list of resources by type
Fetching resources with the protection plan
Fetching detailed information about the resource
Fetching the protection status of resources
Managing protection plans and policies
Protection policy settings
Creating a protection plan
Fetching a list of policies and protection plans
Updating a policy or protection plan
Making a protection plan a favorite
Deleting a protection plan
Deleting all protection plans for a tenant
Fetching a list of plans applicable for a resource
Applying a protection plan to resources
Revoking protection plans from resources
Start execution of a policy
Fetching policy execution statuses of resources
Tracking the execution progress of a policy
Task Management
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 a specified date
Fetching a list of tasks related to Office 365 backup and recovery
Managing activities
Fetching a list of all activities
Endpoint Detection and Response API
Fetching incidents
Fetching incident details and response actions
Performing and monitoring response actions
Updating incident investigation state
Updating a batch of investigation states
Disaster Recovery API
Before you start
API error codes
Managing cloud servers
Fetch a list of cloud servers
Fetch information about the cloud server
Fetch a workload ID linked to the recovery server
Fetch a list of the recovery server’s recovery points
Start test failover for a specific recovery server
Start production failover for a specific recovery server
Stop failover for a specific recovery server
Fetch automated test failover screenshot
Fetch a console link for the cloud server
Fetch disaster recovery site status
Event Manager API
Topics and events
Fetching event topics and types
Subscribing to the events
Listening for the events
Advanced Automation API
Managing customers and clients
Set billing information for a customer
Create a user account for the customer
Fetch a list of customers
Fetch taxes
Fetch customer’s clients
Fetch customer details
Managing sales and billing
Create a ledger
Create a product
Create a sales item
Create an invoice for a customer
Fetch billable sales items
Fetch information about billing entities
Fetch a list of invoices
Fetch a list of products
Fetch a list of sales items
Managing service desk
Create a service desk ticket
Fetch service desk configuration
Fetch products for activity-based ticket billing
Fetch ticket priorities
Fetch a list of Service Level Agreements (SLA)
Fetch SLA breach date
Fetch ticket statuses
Fetch customer support groups
Scripts
Register agent and apply plan
Deploying the CyberApp
Enabling an outbound integration
Integration catalogs
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
Previewing a Description
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
Importing a Description package
Deleting a Description
Monitoring usage
Dashboard
Technical resources
Glossary
Copyright statement
Guide
Register agent and apply plan
Register agent and apply plan
Back to top