Acronis Account Management API

Get self info using Basic Authentication Create an API Client Delete an API Client Issue a JWT token grant_type=password Get API Client Info (including tenant_id) using an issues token API v1 Login

Tenants management-Tenants Info & Navigation

Map tenants id (bigint) to tenants uuid Get my tenant info batch Get a list of available roles Get my tenant contacts Get my tenant contacts info Get my tenant children info Get my tenant users Get my tenant reports info Get my tenant API Clients info Get my tenant MFA status Get my tenant locations info Get my tenant infra info Get my tenant brand info Get my tenant legal documents info Get my tenant brand logo picture

Tenants management-Contacts

Create a contact for a partner tenant Get a partner tenant contacts Get a contact for id

Tenants management

Create a unit tenant underneath customer Disable 2FA for a partner tenant Lock a partner tenant Delete a partner tenant Get a customer pricing model Set a customer pricing model to production Get a partner pricing model Set a partner pricing model to trial Get a partner tenant info Get a customer tenant info Get a tenant usage Get a tenant batch usage for UI purposes Get APIv1 group id by API2 tenant id Get tenant children using APIv1 to find tenant id (uuid) by group id (int)Resolve tenant big int IDs to UUIDs

Applications, offering items and quota management

Get all available applications list Get all available applications for a root tenant Get an application settings list Get an application settings for a root tenant Get the Management Portal application settings for the root tenant Get an application settings for a partner tenant Get a commitment level for a partner tenant Set a commitment level for a partner tenant Get a licensing mode for a partner tenant -- ONLY for legacy editions Set a licensing mode for a partner tenant -- ONLY for legacy editions Get legacy editions limitation status Set legacy editions limitation Get an application settings for a customer tenant Enable an applications for a partner tenant Disable an applications for a partner tenant Get available offering items for a partner tenant Set a quota for an offering items for a partner tenant Get offering items for a partner tenant Get available offering items for a customer tenant Set offering items for a folder tenant Get offering items for a customer tenant Set offering items for a customer tenant Switch editions dry run Switch editions

Users management

Check login availiability Check password Create a new user for a root tenant Update a user for a customer Activate a user by setting a password Activate a user by e-mail Delete a User Get a partner tenant availiable roles Get a customer tenant availiable roles Get a usre personal tenant availiable roles Get a user info Get a user roles Get a user offering items Set a user role of a partner admin Set a user offering items quota Get my users info with access polices updated since specifieid datetime UTC

Impersonate a user

Issue a One Time Token (OTT)Logins into system using One-Time Token and get IDP session cookie Logins into system using external login URL Test that you login as a user (impersonate)Logout from an impersonated user

Agent registration tokens

Get registration token list Create registration token using a user personal tenant Create registration token using a customer tenant and a user personal tenant Delete registration token Exchange an agent registration token to authentication token

Locations and storage management

Get all available locations for a root tenant Get all available storages for a root tenant Get locarions for a partner tenant Get batch locations info by uuids Get a location info by uuid Get an infrastructure info by uuid Get batch storages info by uuids

Reports management

Create a Usage Report with SKU and no-zero usages Update a scheduled report for a tenant Get a report info Delet a report by id Get stored reports list Download stored reports Get reports for a tenant

Get brand for a tenant Enable custom branding Update tenant branding properties Disable custom branding Get brand logo for a tenant

Basiс platform info

Get platform components versions Get editions Get supported languages Get supported color schemas Get offering items names for editions

Get Open ID Configuration Get App Configuration

Legal Documents

Get a user legal documents Sign a user legal documents

External OAuth Integration

Register External IdP Get Registered External IdP Update a customer tenant to use external IdP as default Create a new user for an external authentication for a customer tenant Delete External IdP Registration

Runner: Create a partner and assign them all available editions and offering items

Issue a JWT token Create a partner tenant Get available offering items for a partner tenant Set offering items for a partner tenant Create a new user for a partner Set a user roles Activate a user by setting a password

Runner: Create a partner and lock updates from the Management Console for them

Issue a JWT token Create a partner tenant Lock a partner tenant Get available offering items for a partner tenant Set offering items for a partner tenant

Runner: Create a customer and assign them Cyber Protect Standard edition and all available offering items

Issue a JWT token Create a customer tenant Get available offering items for a customer tenant Set offering items for a customer tenant

The training flow

Get self info using Basic Authentication Create an API Client Issue a JWT token Create a customer tenant Get available offering items for a partner tenant Set offering items for a partner tenant Get available offering items for a customer tenant Set offering items for a customer tenant Get a customer pricing model Set a customer pricing model to production Check login availability Create a new user for a customer Activate a user by setting a password Get a tenant usage Create a report Get stored reports list Download stored reports

Acronis Agent Manager API

Get self info using Basic Authentication Create API Client Delete API Client Issue a JWT token Get API Client Info (including tenant_id) using an issues token

Fetch agents list for a tenant Force to start update of all agents Fetch an agent by id Get agents update configuration Get the agents refernces Get an agent update settings Get agents master update settings for a tenant

Acronis Alert Manager API

Get self info using Basic Authentication Create API Client Delete API Client Issue a Scoped token for Protection Management Get API Client Info (including tenant_id) using an issues token

Create an alert Fetch all alerts Dismiss the alerts by filter Fetch an alert by ID Dismiss an alert by ID Fetch categories Fetch all alert types Fetch an alert type by ID

Fetch alert counters Fetch alerts grouped by scope Fetch resources containing the highest severity alerts Fetch partner's customer alerts count Fetch alerts grouped per customer Get count of active alerts and last modification time

Acronis Cyber Files API

Create API Client Issue a JWT token for Cyber Files API Calls

Get Device List Get Device Info

Sync & Share Nodes

Get Sync & Share Nodes Create a sub-folder

Get Audit Log Entries List

Get a user info

Get Server Settings Get Purging Policies Settings Get Email Settings Get Audit Log Settings Get Security Settings Get Web Preview Settings

Runner: Create a partner, a customer, a user and assign a user Cyber Files user role and ceate folders hierarchy

Issue a JWT token for Cyber Files API Calls Create a customer tenant Set only Cyber Files for the parter Set only Cyber Files for the parter Create a new user for a customer Activate a user by setting a password Set a user the Cyber Files user role Get a user info Create a sub-folder Upload a File Download the sub folder ZIP archive Download the file

Acronis CyberApp

Callback Handler Scenarios-CyberApp enablement

Enablement Reset

Callback Handler Scenarios-Customer mapping

Tenant Mapping Write

Callback Handler Scenarios-Custom callback examples

Issue a JWT token

Platform APIs-Workload Management API v5-Manage Workloads

Fetch a list of all workloads Create single or multiple workloads in one request Fetch a workload by ID Update the workload Delete workloads Delete the workload

Platform APIs-Alert Manager API-Alerts

Create an alert Fetch all alerts Dismiss the alerts by filter Fetch an alert by ID Dismiss an alert by ID Fetch categories Fetch all alert types Fetch an alert type by ID

Platform APIs-Alert Manager API-Stats

Fetch alert counters Fetch alerts grouped by scope Fetch resources containing the highest severity alerts Fetch partner's customer alerts count Fetch alerts grouped per customer Get count of active alerts and last modification time

Acronis Notary API

Create API Client Issue a JWT token for Cyber Notry API Calls

Get documents Get all stored files

Runner: Create a partner, a customer, a user and assign a user Cyber Notary user role

Issue a JWT token for Cyber Notary API Calls Create a customer tenant Set only Cyber Files for the parter Set only Cyber Notary for the parter Create a new user for a customer Activate a user by setting a password Set a user the Cyber Notary user role Notarize a file Get Certificate for the file Create Stored File and Notarize List stored files Get the stored file Download the stored file

Acronis Resource & Policy Management API

Get self info using Basic Authentication Create API Client Delete API Client Issue a Scoped token for Protection Management Get API Client Info (including tenant_id) using an issues token

Resource Management

Search for resources Create a resource - a group Get a resource by Id Get a resource attributes Get a unuquie attributes values list for ressurces Get a resource context selections Create a resource selection Get a resource selection by Id Delete a resource selection by Id Get resources protection statuses

Policy Management

Get policies list Get policy by ID Import policiies list Update policy by ID Delete policy by ID Get applications Apply policy to resources Run policy for resources Revoke policy from resources

The training flow

Issue a JWT token Issue a Scoped token for Protection Management Search for resources Get a resource by Id Get a resource attributes Get a unuquie attributes values list for ressurces Create a resource - dynamic group Delete a resource - a group Get resources context selections Create a resource selection Get a resource selection by Id Delete a resource selection by Id Get resources protection statuses Search for the created policy Get a police by ID Create a policy Update a policy Delete a policy Get policy status Apply policy to resources Revoke policy from resources Run policy for resources

Acronis Task Manager API

Get self info using Basic Authentication Create API Client Delete API Client Issue a Scoped token for Protection Management Get API Client Info (including tenant_id) using an issues token

Get filtered tasks list

Get filtered activities list

Acronis Vault Manager API

Get self info using Basic Authentication Create an API Client Delete an API Client Issue a Scoped token for Protection Management Get API Client Info (including tenant_id) using an issues token API v1 Login

Fetch Backups Delete Backups

Backed Up Resources

Fetch Backed Up Resources

Fetch Archives Fetch Archive Backups Delete Archives

Fetch Vaults Fetch Vault Delete Vault Fetch Vault Archives Fetch Vault Archive Backup Fetch Full Vault Archive Backup Screenshot Fetch Vault Archive Backup Screenshot Preview Fetch Full Screenshot Fetch Screenshot Preview Fetch Vault Archive Backup Timestamps Fetch Vault Archive Backups Fetch Vault Configuration Fetch Vault Statistics Fetch Vault Agents Create or Attach Vault

Fetch Archives Sync Info Fetch Backups Sync Info Fetch Vaults Sync Info

Fetch Archive Stats

Fetch Registered Storage Nodes

Unregister Storage

Fetch Storage Folders Fetch Storage Folders in Path

Search Index Size Stats

Fetch Archive Search Index Size Stats

Storage Usage Stats

Fetch Storage Usage Stats

Antimalware Scan Stats

Fetch Antimalware Scan Stats

Acronis Workload Management API v5

Manage Workloads

Fetch a list of all workloads Create single or multiple workloads in one request Fetch a workload by ID Update the workload Delete workloads Delete the workload

Get self info using Basic Authentication Create an API Client Delete an API Client Issue a JWT token grant_type=password Get API Client Info (including tenant_id) using an issues token API v1 Login

Alerts Generator

Authenticate Fetch workloads Fetch applied protection plans Fetch protection plan Post an alert Fetch alert types

Acronis Account Management API

Get self info using Basic Authentication Create an API Client Delete an API Client Issue a JWT token grant_type=password Get API Client Info (including tenant_id) using an issues token API v1 Login

Tenants management-Tenants Info & Navigation

Map tenants id (bigint) to tenants uuid Get my tenant info batch Get a list of available roles Get my tenant contacts Get my tenant contacts info Get my tenant children info Get my tenant users Get my tenant reports info Get my tenant API Clients info Get my tenant MFA status Get my tenant locations info Get my tenant infra info Get my tenant brand info Get my tenant legal documents info Get my tenant brand logo picture

Tenants management-Contacts

Create a contact for a partner tenant Get a partner tenant contacts Get a contact for id

Tenants management

Create a unit tenant underneath customer Disable 2FA for a partner tenant Lock a partner tenant Delete a partner tenant Get a customer pricing model Set a customer pricing model to production Get a partner pricing model Set a partner pricing model to trial Get a partner tenant info Get a customer tenant info Get a tenant usage Get a tenant batch usage for UI purposes Get APIv1 group id by API2 tenant id Get tenant children using APIv1 to find tenant id (uuid) by group id (int)Resolve tenant big int IDs to UUIDs

Applications, offering items and quota management

Get all available applications list Get all available applications for a root tenant Get an application settings list Get an application settings for a root tenant Get the Management Portal application settings for the root tenant Get an application settings for a partner tenant Get a commitment level for a partner tenant Set a commitment level for a partner tenant Get a licensing mode for a partner tenant -- ONLY for legacy editions Set a licensing mode for a partner tenant -- ONLY for legacy editions Get legacy editions limitation status Set legacy editions limitation Get an application settings for a customer tenant Enable an applications for a partner tenant Disable an applications for a partner tenant Get available offering items for a partner tenant Set a quota for an offering items for a partner tenant Get offering items for a partner tenant Get available offering items for a customer tenant Set offering items for a folder tenant Get offering items for a customer tenant Set offering items for a customer tenant Switch editions dry run Switch editions

Users management

Check login availiability Check password Create a new user for a root tenant Update a user for a customer Activate a user by setting a password Activate a user by e-mail Delete a User Get a partner tenant availiable roles Get a customer tenant availiable roles Get a usre personal tenant availiable roles Get a user info Get a user roles Get a user offering items Set a user role of a partner admin Set a user offering items quota Get my users info with access polices updated since specifieid datetime UTC

Impersonate a user

Issue a One Time Token (OTT)Logins into system using One-Time Token and get IDP session cookie Logins into system using external login URL Test that you login as a user (impersonate)Logout from an impersonated user

Agent registration tokens

Get registration token list Create registration token using a user personal tenant Create registration token using a customer tenant and a user personal tenant Delete registration token Exchange an agent registration token to authentication token

Locations and storage management

Get all available locations for a root tenant Get all available storages for a root tenant Get locarions for a partner tenant Get batch locations info by uuids Get a location info by uuid Get an infrastructure info by uuid Get batch storages info by uuids

Reports management

Create a Usage Report with SKU and no-zero usages Update a scheduled report for a tenant Get a report info Delet a report by id Get stored reports list Download stored reports Get reports for a tenant

Get brand for a tenant Enable custom branding Update tenant branding properties Disable custom branding Get brand logo for a tenant

Basiс platform info

Get platform components versions Get editions Get supported languages Get supported color schemas Get offering items names for editions

Get Open ID Configuration Get App Configuration

Legal Documents

Get a user legal documents Sign a user legal documents

External OAuth Integration

Register External IdP Get Registered External IdP Update a customer tenant to use external IdP as default Create a new user for an external authentication for a customer tenant Delete External IdP Registration

Runner: Create a partner and assign them all available editions and offering items

Issue a JWT token Create a partner tenant Get available offering items for a partner tenant Set offering items for a partner tenant Create a new user for a partner Set a user roles Activate a user by setting a password

Runner: Create a partner and lock updates from the Management Console for them

Issue a JWT token Create a partner tenant Lock a partner tenant Get available offering items for a partner tenant Set offering items for a partner tenant

Runner: Create a customer and assign them Cyber Protect Standard edition and all available offering items

Issue a JWT token Create a customer tenant Get available offering items for a customer tenant Set offering items for a customer tenant

The training flow

Get self info using Basic Authentication Create an API Client Issue a JWT token Create a customer tenant Get available offering items for a partner tenant Set offering items for a partner tenant Get available offering items for a customer tenant Set offering items for a customer tenant Get a customer pricing model Set a customer pricing model to production Check login availability Create a new user for a customer Activate a user by setting a password Get a tenant usage Create a report Get stored reports list Download stored reports

Acronis Agent Manager API

Get self info using Basic Authentication Create API Client Delete API Client Issue a JWT token Get API Client Info (including tenant_id) using an issues token

Fetch agents list for a tenant Force to start update of all agents Fetch an agent by id Get agents update configuration Get the agents refernces Get an agent update settings Get agents master update settings for a tenant

Acronis Alert Manager API

Get self info using Basic Authentication Create API Client Delete API Client Issue a Scoped token for Protection Management Get API Client Info (including tenant_id) using an issues token

Create an alert Fetch all alerts Dismiss the alerts by filter Fetch an alert by ID Dismiss an alert by ID Fetch categories Fetch all alert types Fetch an alert type by ID

Fetch alert counters Fetch alerts grouped by scope Fetch resources containing the highest severity alerts Fetch partner's customer alerts count Fetch alerts grouped per customer Get count of active alerts and last modification time

Acronis Cyber Files API

Create API Client Issue a JWT token for Cyber Files API Calls

Get Device List Get Device Info

Sync & Share Nodes

Get Sync & Share Nodes Create a sub-folder

Get Audit Log Entries List

Get a user info

Get Server Settings Get Purging Policies Settings Get Email Settings Get Audit Log Settings Get Security Settings Get Web Preview Settings

Runner: Create a partner, a customer, a user and assign a user Cyber Files user role and ceate folders hierarchy

Issue a JWT token for Cyber Files API Calls Create a customer tenant Set only Cyber Files for the parter Set only Cyber Files for the parter Create a new user for a customer Activate a user by setting a password Set a user the Cyber Files user role Get a user info Create a sub-folder Upload a File Download the sub folder ZIP archive Download the file

Acronis CyberApp

Callback Handler Scenarios-CyberApp enablement

Enablement Reset

Callback Handler Scenarios-Customer mapping

Tenant Mapping Write

Callback Handler Scenarios-Custom callback examples

Issue a JWT token

Platform APIs-Workload Management API v5-Manage Workloads

Fetch a list of all workloads Create single or multiple workloads in one request Fetch a workload by ID Update the workload Delete workloads Delete the workload

Platform APIs-Alert Manager API-Alerts

Create an alert Fetch all alerts Dismiss the alerts by filter Fetch an alert by ID Dismiss an alert by ID Fetch categories Fetch all alert types Fetch an alert type by ID

Platform APIs-Alert Manager API-Stats

Fetch alert counters Fetch alerts grouped by scope Fetch resources containing the highest severity alerts Fetch partner's customer alerts count Fetch alerts grouped per customer Get count of active alerts and last modification time

Acronis Notary API

Create API Client Issue a JWT token for Cyber Notry API Calls

Get documents Get all stored files

Runner: Create a partner, a customer, a user and assign a user Cyber Notary user role

Issue a JWT token for Cyber Notary API Calls Create a customer tenant Set only Cyber Files for the parter Set only Cyber Notary for the parter Create a new user for a customer Activate a user by setting a password Set a user the Cyber Notary user role Notarize a file Get Certificate for the file Create Stored File and Notarize List stored files Get the stored file Download the stored file

Acronis Resource & Policy Management API

Get self info using Basic Authentication Create API Client Delete API Client Issue a Scoped token for Protection Management Get API Client Info (including tenant_id) using an issues token

Resource Management

Search for resources Create a resource - a group Get a resource by Id Get a resource attributes Get a unuquie attributes values list for ressurces Get a resource context selections Create a resource selection Get a resource selection by Id Delete a resource selection by Id Get resources protection statuses

Policy Management

Get policies list Get policy by ID Import policiies list Update policy by ID Delete policy by ID Get applications Apply policy to resources Run policy for resources Revoke policy from resources

The training flow

Issue a JWT token Issue a Scoped token for Protection Management Search for resources Get a resource by Id Get a resource attributes Get a unuquie attributes values list for ressurces Create a resource - dynamic group Delete a resource - a group Get resources context selections Create a resource selection Get a resource selection by Id Delete a resource selection by Id Get resources protection statuses Search for the created policy Get a police by ID Create a policy Update a policy Delete a policy Get policy status Apply policy to resources Revoke policy from resources Run policy for resources

Acronis Task Manager API

Get self info using Basic Authentication Create API Client Delete API Client Issue a Scoped token for Protection Management Get API Client Info (including tenant_id) using an issues token

Get filtered tasks list

Get filtered activities list

Acronis Vault Manager API

Get self info using Basic Authentication Create an API Client Delete an API Client Issue a Scoped token for Protection Management Get API Client Info (including tenant_id) using an issues token API v1 Login

Fetch Backups Delete Backups

Backed Up Resources

Fetch Backed Up Resources

Fetch Archives Fetch Archive Backups Delete Archives

Fetch Vaults Fetch Vault Delete Vault Fetch Vault Archives Fetch Vault Archive Backup Fetch Full Vault Archive Backup Screenshot Fetch Vault Archive Backup Screenshot Preview Fetch Full Screenshot Fetch Screenshot Preview Fetch Vault Archive Backup Timestamps Fetch Vault Archive Backups Fetch Vault Configuration Fetch Vault Statistics Fetch Vault Agents Create or Attach Vault

Fetch Archives Sync Info Fetch Backups Sync Info Fetch Vaults Sync Info

Fetch Archive Stats

Fetch Registered Storage Nodes

Unregister Storage

Fetch Storage Folders Fetch Storage Folders in Path

Search Index Size Stats

Fetch Archive Search Index Size Stats

Storage Usage Stats

Fetch Storage Usage Stats

Antimalware Scan Stats

Fetch Antimalware Scan Stats

Acronis Workload Management API v5

Manage Workloads

Fetch a list of all workloads Create single or multiple workloads in one request Fetch a workload by ID Update the workload Delete workloads Delete the workload

Get self info using Basic Authentication Create an API Client Delete an API Client Issue a JWT token grant_type=password Get API Client Info (including tenant_id) using an issues token API v1 Login

Alerts Generator

Authenticate Fetch workloads Fetch applied protection plans Fetch protection plan Post an alert Fetch alert types

Home Acronis CyberApp Platform APIs-Workload Management API v5-Manage WorkloadsUpdate the workload

Update the workload

PATCH {{base_url}}/api/workload_management/v5/workloads/:workload_internal_or_external_id

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string

Fetch a workload by ID

Delete workloads