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:
Log in to the management portal.
Click Settings β API clients β Create API client.
Enter a name for the API client.
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 | 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β
Key | Type | Description |
---|---|---|
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β
Key | Type | Description |
---|---|---|
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β
Key | Type | Description |
---|---|---|
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β
Key | Type | Description |
---|---|---|
agent_id* | Acronis Agent | None Provided |
Query Paramsβ
Key | Type | Description |
---|---|---|
master | String (?) | None Provided |
Responseβ
A key-value pair that includes the following keys:
Responseβ
Key | Type | Description |
---|---|---|
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β
Key | Type | Description |
---|---|---|
tenant_id* | Acronis Tenant | None Provided |
Query Paramsβ
Key | Type | Description |
---|---|---|
master | String (?) | None Provided |
Responseβ
A key-value pair that includes the following keys:
Responseβ
Key | Type | Description |
---|---|---|
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β
Key | Type | Description |
---|---|---|
current | Current | None Provided |
Metumβ
Key | Type | Description |
---|---|---|
atp | Atp | None Provided |
Platformβ
Key | Type | Description |
---|---|---|
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β
Key | Type | Description |
---|---|---|
id | String | None Provided |
name | String | None Provided |
Unitβ
Key | Type | Description |
---|---|---|
meta | Metum | None Provided |
name | String | None Provided |
version | Version | None Provided |
Versionβ
Key | Type | Description |
---|---|---|
build | String | None Provided |
release_id | String | None Provided |
release_name | String | None Provided |
Maintenancewindowβ
Key | Type | Description |
---|---|---|
days_of_week | Array | None Provided |
time_from | String | None Provided |
time_to | String | None Provided |
Maintenancewindowβ
Key | Type | Description |
---|---|---|
days_of_week | Array | None Provided |
time_from | String | None Provided |
time_to | String | None Provided |
Currentβ
Key | Type | Description |
---|---|---|
build | String | None Provided |
release_id | String | None Provided |
Atpβ
Key | Type | Description |
---|---|---|
components | Component | None Provided |
Componentβ
Key | Type | Description |
---|---|---|
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β
Key | Type | Description |
---|---|---|
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β
Key | Type | Description |
---|---|---|
contextKeys | Array | None Provided |
enabled | Boolean | None Provided |
searchableDetails | Array | None Provided |
severity | String | None Provided |
supportedOS | Array | None Provided |
Objectsβ
Itemβ
Key | Type | Description |
---|---|---|
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β
Key | Type | Description |
---|---|---|
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β
Key | Type | Description |
---|---|---|
items | Item | None Provided |
Delete Alert(S)β
Requestβ
DELETE /api/alert_manager/v1/alerts
Query Paramsβ
Key | Type | Description |
---|---|---|
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β
Key | Type | Description |
---|---|---|
alert_id* | Acronis Alert | None Provided |
Responseβ
A key-value pair that includes the following keys:
Responseβ
Key | Type | Description |
---|---|---|
_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β
Key | Type |
---|