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​

Key
Type
Description

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​

Key
Type
Description

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​

Key
Type
Description

items

Item

None Provided

size

Number (float)

None Provided

timeStamp

String

None Provided


Objects​

Item​

Key
Type
Description

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​

Key
Type
Description

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​

Key
Type
Description

clusterId

String

None Provided

id

String

None Provided


Policy​

Key
Type
Description

id

String

None Provided

name

String

None Provided

type

String

None Provided


Progress​

Key
Type
Description

current

Number (float)

None Provided

total

Number (float)

None Provided


Resource​

Key
Type
Description

id

String

None Provided

name

String

None Provided

type

String

None Provided


Result​

Key
Type
Description

code

String

None Provided

error

Error

None Provided

payload

Payload

None Provided

warnings

Warning

None Provided


Tenant​

Key
Type
Description

id

String

None Provided

locator

String

None Provided

name

String

None Provided


Persistent​

Key
Type
Description

Sources

Source

None Provided


Source​

Key
Type
Description

BackupType

String

None Provided

ItemKey

Item Key

None Provided

ItemPath

String

None Provided


Runtime​

Key
Type
Description

bytesProcessed

Number (float)

None Provided

bytesSaved

Number (float)

None Provided

sourceStamp

Number (float)

None Provided


Error​

Key
Type
Description

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​

Key
Type
Description

BackupActivitiesNumber

Number (float)

None Provided

UnresolvedItemsWarning

Key-Value pair (Dictionary)

None Provided


Warning​

Key
Type
Description

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​

Key
Type
Description

4B2A7A93-A44F-4155-BDE3-A023C57C9431

String

None Provided

ItemType

String

None Provided

LocalID

String

None Provided


Context​

Key
Type
Description

$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​

Key
Type
Description

msg

String

None Provided


Kblink​

Key
Type
Description

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​

Key
Type
Description

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​

Key
Type
Description

$module

String

None Provided

CommandID

String

None Provided


Suberror​

Key
Type
Description

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​

Key
Type
Description

$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​

Key
Type
Description

tenant_id*

Acronis Tenant

None Provided

Get Registration Token​

Request​

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

Path Params​

Key
Type
Description

tenant_id*

Acronis Tenant

None Provided

JSON Body​

Key
Type
Description

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​

Key
Type
Description

registration_token_id*

String

None Provided

Agents

List Tenant Agents​

Request​

GET /api/agent_manager/v2/agents

Query Params​

Key
Type
Description

tenant_id

Acronis Tenant

None Provided

Trigger Updating All Agents In The System​

Request​

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

JSON Body​

Key
Type
Description

agent_ids

Array

None Provided

Response​

Get Agent​

Request​

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

Path Params​

Key
Type
Description

agent_id*

Acronis Agent

None Provided

Response​

A key-value pair that includes the following keys:

Response​

Key
Type
Description

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