Acronis Integration Setup

The Acronis pack allows you to manage tenants, reports, users, devices, backups, and storage.

This Integration supports multiple instances

Check out the instructions to set up multiple instances here.

Setup

To setup the Acronis Integration, you'll need to perform the following steps:

  1. Log in to the management portal.

  2. Click Settings β†’ API clients β†’ Create API client.

  3. Enter a name for the API client.

  4. Click Next.

The API client is created with the Active status by default.

Input the ID and secret value of the client below. For the Cloud Base URL - match the prefix of the cloud URL to the region below.

We'll run a final authorization check before we continue.

Having issues? Review Acronis' Documentation Here.

Actions

Abgw Storages

Unregister Storage​

Removes registered storage from a user's account.

Request​

DELETE /api/vault_manager/v1/abgw_storages/{storageId}

Path Params​

KeyTypeDescription

storageId*

Acronis Storage ID

None Provided

Activities

List Activities​

Retrieve a list of activities with specific criteria.

Request​

GET /api/task_manager/v2/activities

Query Params​

KeyTypeDescription

policyType

String (?)

None Provided

id

Acronis Activity

None Provided

resultCode

String (?)

None Provided

lod

String

None Provided

state

String (?)

None Provided

taskId

Acronis Task

None Provided

completedAt

String (?)

None Provided

Response​

A key-value pair that includes the following keys:

Response​

KeyTypeDescription

items

Item

None Provided

size

Number (float)

None Provided

timeStamp

String

None Provided


Objects​

Item​

KeyTypeDescription

completedAt

String

None Provided

context

Context

None Provided

createdAt

String

None Provided

executor

Executor

None Provided

id

Number (float)

None Provided

idString

String

None Provided

parentActivityId

Number (float)

None Provided

parentActivityIdString

String

None Provided

policy

Policy

None Provided

progress

Progress

None Provided

resource

Resource

None Provided

result

Result

None Provided

startedAt

String

None Provided

state

String

None Provided

taskId

Number (float)

None Provided

taskIdString

String

None Provided

tenant

Tenant

None Provided

type

String

None Provided

updatedAt

String

None Provided

uuid

String

None Provided


Context​

KeyTypeDescription

ArchiveLocation

String

None Provided

ArchiveName

String

None Provided

BackupFrameID

String

None Provided

BackupPlanID

String

None Provided

BackupPlanName

String

None Provided

BackupType

Number (float)

None Provided

CommandID

String

None Provided

Comments

String

None Provided

CurrentBackupFrame

String

None Provided

ExecutionQueue

String

None Provided

HasChildren

Boolean

None Provided

IsProcessRoot

Boolean

None Provided

MachineName

String

None Provided

MessageID

String

None Provided

Persistent

Persistent

None Provided

ProcessID

Number (float)

None Provided

ProtectionPlanID

String

None Provided

Sources

Source

None Provided

Specific

String

None Provided

UserName

String

None Provided

_runtime

Runtime

None Provided

isLegacy

Boolean

None Provided

parentUUID

String

None Provided

runMode

String

None Provided

title

String

None Provided


Executor​

KeyTypeDescription

clusterId

String

None Provided

id

String

None Provided


Policy​

KeyTypeDescription

id

String

None Provided

name

String

None Provided

type

String

None Provided


Progress​

KeyTypeDescription

current

Number (float)

None Provided

total

Number (float)

None Provided


Resource​

KeyTypeDescription

id

String

None Provided

name

String

None Provided

type

String

None Provided


Result​

KeyTypeDescription

code

String

None Provided

error

Error

None Provided

payload

Payload

None Provided

warnings

Warning

None Provided


Tenant​

KeyTypeDescription

id

String

None Provided

locator

String

None Provided

name

String

None Provided


Persistent​

KeyTypeDescription

Sources

Source

None Provided


Source​

KeyTypeDescription

BackupType

String

None Provided

ItemKey

Item Key

None Provided

ItemPath

String

None Provided


Runtime​

KeyTypeDescription

bytesProcessed

Number (float)

None Provided

bytesSaved

Number (float)

None Provided

sourceStamp

Number (float)

None Provided


Error​

KeyTypeDescription

code

String

None Provided

context

Context

None Provided

debug

Debug

None Provided

domain

String

None Provided

kbLink

Kb Link

None Provided

reason

String

None Provided


Payload​

KeyTypeDescription

BackupActivitiesNumber

Number (float)

None Provided

UnresolvedItemsWarning

Key-Value pair (Dictionary)

None Provided


Warning​

KeyTypeDescription

code

String

None Provided

context

Context

None Provided

debug

Debug

None Provided

domain

String

None Provided

kbLink

Kb Link

None Provided

reason

String

None Provided


Itemkey​

KeyTypeDescription

4B2A7A93-A44F-4155-BDE3-A023C57C9431

String

None Provided

ItemType

String

None Provided

LocalID

String

None Provided


Context​

KeyTypeDescription

$module

String

None Provided

_src

Src

None Provided

account

String

None Provided

cause_str

String

None Provided

commandid

String

None Provided

effect_str

String

None Provided

failcount

Number (float)

None Provided

isreturncode

Number (float)

None Provided

tenantname

String

None Provided


Debug​

KeyTypeDescription

msg

String

None Provided


Kblink​

KeyTypeDescription

build

Number (float)

None Provided

lineTag

String

None Provided

os

String

None Provided

product

String

None Provided

serCode

String

None Provided

version

String

None Provided


Src​

KeyTypeDescription

code

Number (float)

None Provided

fields

Field

None Provided

src

Src

None Provided

suberror

Suberror

None Provided

text

String

None Provided

types

Type

None Provided


Field​

KeyTypeDescription

$module

String

None Provided

CommandID

String

None Provided


Suberror​

KeyTypeDescription

code

Number (float)

None Provided

fields

Field

None Provided

src

Src

None Provided

suberror

Suberror

None Provided

text

String

None Provided

types

Type

None Provided


Type​

KeyTypeDescription

$module

String

None Provided

CommandID

String

None Provided

Agent Registration Tokens

List Registration Tokens​

Retrieve list of registration tokens.

Request​

GET /api/2/tenants/{tenant_id}/registration_tokens

Path Params​

KeyTypeDescription

tenant_id*

Acronis Tenant

None Provided

Get Registration Token​

Request​

POST /api/2/tenants/{tenant_id}/registration_tokens

Path Params​

KeyTypeDescription

tenant_id*

Acronis Tenant

None Provided

JSON Body​

KeyTypeDescription

expires_in

Number (float)

None Provided

scopes

Array

None Provided

Delete Registration Token​

Remove device registration identification for push notifications.

Request​

DELETE /api/2/registration_tokens/{registration_token_id}

Path Params​

KeyTypeDescription

registration_token_id*

String

None Provided

Agents

List Tenant Agents​

Request​

GET /api/agent_manager/v2/agents

Query Params​

KeyTypeDescription

tenant_id

Acronis Tenant

None Provided

Trigger Updating All Agents In The System​

Request​

POST /api/agent_manager/v2/agents/update:force

JSON Body​

KeyTypeDescription

agent_ids

Array

None Provided

Response​

Get Agent​

Request​

GET /api/agent_manager/v2/agents/{agent_id}

Path Params​

KeyTypeDescription

agent_id*

Acronis Agent

None Provided

Response​

A key-value pair that includes the following keys:

Response​

KeyTypeDescription

auto_update

Boolean

None Provided

core_version

Core Version

None Provided

enabled

Boolean

None Provided

host_id

String

None Provided

hostname

String

None Provided

id

String

None Provided

meta

Metum

None Provided

name

String

None Provided

online

Boolean

None Provided

platform

Platform

None Provided

registration_date

String

None Provided

tenant

Tenant

None Provided

units

Unit

None Provided

Get Agents Update Configuration​

Retrieve updated configuration data for agents.

Request​

GET /api/agent_manager/v2/agents/update/configuration

Response​

A key-value pair that includes the following keys:

Response​

KeyTypeDescription

max_agent_fail_count

Number (float)

None Provided

max_concurrent_agent_update_count

Number (float)

None Provided

min_update_package_fail_ratio_denominator

Number (float)

None Provided

update_package_fail_ratio_threshold

Number (float)

None Provided

update_window_end_offset_sec

Number (float)

None Provided

update_window_start_offset_sec

Number (float)

None Provided

Get The Agents Update References​

Retrieve agent references from the database.

Request​

GET /api/agent_manager/v2/agent_update_references

Query Params​

KeyTypeDescription

update_channel*

String

None Provided

os_family

String

None Provided

os_arch

String

None Provided

Response​

A key-value pair that includes the following keys:

Response​

KeyTypeDescription

os_arch

String

None Provided

os_family

String

None Provided

update_channel

String

None Provided

url

String

None Provided

version

Version

None Provided

Get Agent Configuration Information​

Request​

GET /api/agent_manager/v2/agent_update_settings/{agent_id}

Path Params​

KeyTypeDescription

agent_id*

Acronis Agent

None Provided

Query Params​

KeyTypeDescription

master

String (?)

None Provided

Response​

A key-value pair that includes the following keys:

Response​

KeyTypeDescription

agent_id

String

None Provided

automatic

Boolean

None Provided

inherited_from_tenant_id

String

None Provided

maintenance_window

Maintenance Window

None Provided

tenant_id

String

None Provided

update_channel

String

None Provided

Update Tenant Agent Configuration​

Request​

GET /api/agent_manager/v2/agent_update_settings/{tenant_id}

Path Params​

KeyTypeDescription

tenant_id*

Acronis Tenant

None Provided

Query Params​

KeyTypeDescription

master

String (?)

None Provided

Response​

A key-value pair that includes the following keys:

Response​

KeyTypeDescription

automatic

Boolean

None Provided

inherited_from_tenant_id

String

None Provided

maintenance_window

Maintenance Window

None Provided

tenant_id

String

None Provided

update_channel

String

None Provided


Objects​

Core Version​

KeyTypeDescription

current

Current

None Provided


Metum​

KeyTypeDescription

atp

Atp

None Provided


Platform​

KeyTypeDescription

arch

String

None Provided

caps

Number (float)

None Provided

family

String

None Provided

name

String

None Provided

product_type

Number (float)

None Provided

service_pack

Number (float)

None Provided

sku

Number (float)

None Provided

suite_mask

Number (float)

None Provided

version_major

Number (float)

None Provided

version_minor

Number (float)

None Provided


Tenant​

KeyTypeDescription

id

String

None Provided

name

String

None Provided


Unit​

KeyTypeDescription

meta

Metum

None Provided

name

String

None Provided

version

Version

None Provided


Version​

KeyTypeDescription

build

String

None Provided

release_id

String

None Provided

release_name

String

None Provided


Maintenancewindow​

KeyTypeDescription

days_of_week

Array

None Provided

time_from

String

None Provided

time_to

String

None Provided


Maintenancewindow​

KeyTypeDescription

days_of_week

Array

None Provided

time_from

String

None Provided

time_to

String

None Provided


Current​

KeyTypeDescription

build

String

None Provided

release_id

String

None Provided


Atp​

KeyTypeDescription

components

Component

None Provided


Component​

KeyTypeDescription

name

String

None Provided

update_time

String

None Provided

version

String

None Provided

Alert Types

Retrieve Registered Alert Types​

Request​

GET /api/alert_manager/v1/types

Response​

A key-value pair that includes the following keys:

Response​

KeyTypeDescription

items

Item

None Provided

Create An Alerts Type​

Endpoint to create a new type of alert.

Request​

POST /api/alert_manager/v1/types

JSON Body​

KeyTypeDescription

contextKeys

Array

None Provided

enabled

Boolean

None Provided

searchableDetails

Array

None Provided

severity

String

None Provided

supportedOS

Array

None Provided


Objects​

Item​

KeyTypeDescription

contextKeys

Array

None Provided

enabled

Boolean

None Provided

id

String

None Provided

searchableDetails

Array

None Provided

severity

String

None Provided

Alerts

List Alerts​

Get list of filtered alerts based on specified criteria.

Request​

GET /api/alert_manager/v1/alerts

Query Params​

KeyTypeDescription

updated_at

String (?)

Unix Time in nanoseconds (1 billionth of a second) Available operators: eq - equals lt - less than gt - greater than le - less than or equals ge - greater than or equals

severity

String

None Provided

query

String

A query string to search

type

String

Alert Type

order

String

None Provided

source_time_stamp

String

None Provided

source

String

None Provided

show_deleted

Boolean

None Provided

id

Acronis ID

None Provided

embed_alert

Boolean

None Provided

Response​

A key-value pair that includes the following keys:

Response​

KeyTypeDescription

items

Item

None Provided

Delete Alert(S)​

Request​

DELETE /api/alert_manager/v1/alerts

Query Params​

KeyTypeDescription

id

Array

None Provided

severity

String

None Provided

updated_at

String (?)

Unix Time in nanoseconds (1 billionth of a second) Available operators: eq - equals lt - less than gt - greater than le - less than or equals ge - greater than or equals

Get Alert​

Request​

GET /api/alert_manager/v1/alerts/{alert_id}

Path Params​

KeyTypeDescription

alert_id*

Acronis Alert

None Provided

Response​

A key-value pair that includes the following keys:

Response​

KeyTypeDescription

_links

Link

None Provided

createdAt

String

None Provided

details

Detail

None Provided

id

String

None Provided

receivedAt

String

None Provided

severity

String

None Provided

tenant

Tenant

None Provided

type

String

None Provided

updatedAt

String

None Provided

Get Stats Of Alerts​

Retrieve statistical data about system alerts.

Request​

GET /api/alert_manager/v1/stats

Response​

A key-value pair that includes the following keys:

Response​

KeyTypeDescription

_links

Link

None Provided

count

Number (float)

None Provided

modifiedAt

String

None Provided

Get Alerts Sync​

Retrieve synchronized alerts.

Request​

GET /api/alert_manager/v1/sync

Response​

A key-value pair that includes the following keys:

Response​

KeyTypeDescription

items

Item

None Provided


Objects​

Item​

KeyTypeDescription

createdAt

String

None Provided

deletedAt

String

None Provided

details

Detail

None Provided

id

String

None Provided

receivedAt

String

None Provided

severity

String

None Provided

tenant

Tenant

None Provided

type

String

None Provided

updatedAt

String

None Provided


Link​

KeyTypeDescription

href

String

None Provided

rel

String

None Provided


Detail​

KeyTypeDescription

errorDescription

String

None Provided

fileHashMD5

String

None Provided

fileHashSHA1

String

None Provided

fileHashSHA256

String

None Provided

fileName

String

None Provided

filePath

String

None Provided

resourceId

String

None Provided

resourceName

String

None Provided

threatName

String

None Provided


Tenant​

KeyTypeDescription

id

String

None Provided

locator

String

None Provided


Link​

KeyTypeDescription

href

String

None Provided

rel

String

None Provided

Antimalware Scan Stats

Get Anti Malware Scan Stats​

Get statistics about antimalware scan results.

Request​

GET /api/vault_manager/v1/antimalware_scan_stats

Query Params​

KeyTypeDescription

created

String (?)

Show backups created only within specified time range.

Response​

A key-value pair that includes the following keys:

Response​

KeyTypeDescription

_links

Link

None Provided

clean_count

Number (float)

None Provided

infected_count

Number (float)

None Provided

not_supported_clean_count

Number (float)

None Provided


Objects​

Link​

KeyTypeDescription

href

String

None Provided

rel

String

None Provided

Archives

List Archives​

Retrieve historical records or past versions of data.

Request​

GET /api/vault_manager/v1/archives

Query Params​

KeyTypeDescription

archiveId

Acronis Archive

None Provided

showDeleted

String

A flag that specifies what should be added to the list of returned backups

includeStats

String

Include additional information about archive. If false or not specified, the stats field will not be in the response data.

agentId

String (?)

Show a list of archives of specified agent ID.

name

String

Show a list of archives of specified archive name. Supports matching any number of characters using asterisk wildcard character if it's enabled with the wildcard query sring parameter.

wildcard

String (?)

Enable wildcard support in the name filter.

resourceId

String (?)

Show only archives that contain backups for at least one resource from the specified list.

storageType

String (?)

Show a list of Archives in vaults of specified storage types.

type

String (?)

Show a list of Archives of specified types.

format

String (?)

Show a list of Archives of specified formats.

backupPlanId

String (?)

Show only archives created by backup plan with specified ID.

centralizedPlanId

String (?)

Show only archives created by centralized plan with specified ID.

includeCatalogInfo

Boolean

Include cataloged status of archive. If false or not specified, cataloged_status and actions fields will not be incuded in the response data.

forensic

String (?)

Show only archives with forensic data or without forensic. If not specified, archives are listed regardless of forensic data.

includePrePatchManagement

String (?)

Include pre-patch management status of archive. If false or not specified, the pre_patch_management field will not be included in the response data.

prePatchManagementOnly

String (?)

Show only archives with at least one backup which was made before patch management. If false or not specified, archives are listed regardless of this filter.

includeMalwareFound

String (?)

Include malware assessment result of backups in the archive. If false or not specified, the malware_found field will not be included in the response data.

malwareFound

Boolean

Show only archives with backups that have the specified malware status. Possible malware statuses: notScanned - No backups were scanned in the archive. clean - Backups that don't contain malware. malware - Backups that contain malware.

fromDate

String (?)

Filters archives by the last updated date and time that is greater or equal to the given date and time.

toDate

String (?)

Filters archives by the last updated date and time that is less than or equal to the given date and time.

includeActions

String (?)

Calculate and include possible actions in the response.

targetAgentId

String (?)

Select target agent to calculate actions.

order

String

An ordering filter that orders the results by column name

Response​

A key-value pair that includes the following keys:

<