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
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
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
items
Item
None Provided
size
Number (float)
None Provided
timeStamp
String
None Provided
Objects
Item
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
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
clusterId
String
None Provided
id
String
None Provided
Policy
id
String
None Provided
name
String
None Provided
type
String
None Provided
Progress
current
Number (float)
None Provided
total
Number (float)
None Provided
Resource
id
String
None Provided
name
String
None Provided
type
String
None Provided
Result
code
String
None Provided
error
Error
None Provided
payload
Payload
None Provided
warnings
Warning
None Provided
Tenant
id
String
None Provided
locator
String
None Provided
name
String
None Provided
Persistent
Sources
Source
None Provided
Source
BackupType
String
None Provided
ItemKey
Item Key
None Provided
ItemPath
String
None Provided
Runtime
bytesProcessed
Number (float)
None Provided
bytesSaved
Number (float)
None Provided
sourceStamp
Number (float)
None Provided
Error
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
BackupActivitiesNumber
Number (float)
None Provided
UnresolvedItemsWarning
Key-Value pair (Dictionary)
None Provided
Warning
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
4B2A7A93-A44F-4155-BDE3-A023C57C9431
String
None Provided
ItemType
String
None Provided
LocalID
String
None Provided
Context
$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
msg
String
None Provided
Kblink
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
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
$module
String
None Provided
CommandID
String
None Provided
Suberror
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
$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
tenant_id*
Acronis Tenant
None Provided
Get Registration Token
Request
POST /api/2/tenants/{tenant_id}/registration_tokens
Path Params
tenant_id*
Acronis Tenant
None Provided
JSON Body
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
registration_token_id*
String
None Provided
Agents
List Tenant Agents
Request
GET /api/agent_manager/v2/agents
Query Params
tenant_id
Acronis Tenant
None Provided
Trigger Updating All Agents In The System
Request
POST /api/agent_manager/v2/agents/update:force
JSON Body
agent_ids
Array
None Provided
Response
Get Agent
Request
GET /api/agent_manager/v2/agents/{agent_id}
Path Params
agent_id*
Acronis Agent
None Provided
Response
A key-value pair that includes the following keys:
Response
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
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
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
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
agent_id*
Acronis Agent
None Provided
Query Params
master
String (?)
None Provided
Response
A key-value pair that includes the following keys:
Response
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
tenant_id*
Acronis Tenant
None Provided
Query Params
master
String (?)
None Provided
Response
A key-value pair that includes the following keys:
Response
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
current
Current
None Provided
Metum
atp
Atp
None Provided
Platform
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
id
String
None Provided
name
String
None Provided
Unit
meta
Metum
None Provided
name
String
None Provided
version
Version
None Provided
Version
build
String
None Provided
release_id
String
None Provided
release_name
String
None Provided
Maintenancewindow
days_of_week
Array
None Provided
time_from
String
None Provided
time_to
String
None Provided
Maintenancewindow
days_of_week
Array
None Provided
time_from
String
None Provided
time_to
String
None Provided
Current
build
String
None Provided
release_id
String
None Provided
Atp
components
Component
None Provided
Component
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
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
contextKeys
Array
None Provided
enabled
Boolean
None Provided
searchableDetails
Array
None Provided
severity
String
None Provided
supportedOS
Array
None Provided
Objects
Item
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
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
items
Item
None Provided
Delete Alert(S)
Request
DELETE /api/alert_manager/v1/alerts
Query Params
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
alert_id*
Acronis Alert
None Provided
Response
A key-value pair that includes the following keys:
Response
_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
_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
items
Item
None Provided
Objects
Item
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
href
String
None Provided
rel
String
None Provided
Detail
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
id
String
None Provided
locator
String
None Provided
Link
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
created
String (?)
Show backups created only within specified time range.
Response
A key-value pair that includes the following keys:
Response
_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
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
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:
Response
_links
Link
None Provided
items
Item
None Provided
Delete Archives
Permanently removes stored data.
Request
DELETE /api/vault_manager/v1/archives
Query Params
resourceId*
String
None Provided
changeTag
String
None Provided
List Archive Backups
Retrieve previous versions of data backups.
Request
GET /api/vault_manager/v1/archives/{archiveId}/backups
Path Params
archiveId*
Acronis Archive
None Provided
Query Params
order
String
An ordering filter that orders the results by column name
showDeleted
String
A flag that specifies what should be added to the list of returned backups: 1 - All deleted backups are added to the list of backups. 2 - Only deleted backups marked as immutable are added to the list of backups.
includeActions
String (?)
Calculate and include possible actions in the response.
targetAgentId
String (?)
Select target agent to calculate actions.
resourceId
String (?)
Show only backups for specified resources.
changeTag
String (?)
Show only backups for specified change tag.
embed
String (?)
An array of field names to include in the response. Each value represents the name of the extension field to be included in the base response.
created
String (?)
Show only backups created within specified time range.
protectedByPassword
String (?)
Show only backups in protected by password or unprotected by password archives. If not specified, backups are listed regardless of their password protection status.
backupType
String (?)
Show only backups of specified types.
triggeredBy
String (?)
Show a list of Backups triggered by specified reason.
avScanningDate
String
Show only backups scanned within the specified time range OR never scanned backups in "none" is specified.
vulnerabilityAssessmentStatus
String
Show only backups with specified Vulnerability Assessment Result statuses.
malwareAssessmentStatus
String (?)
Show only backups with specified Malware Assessment Result statuses.
tapeId
String
Show only backups for specified tapes
Response
A key-value pair that includes the following keys:
Response
_links
Link
None Provided
items
Item
None Provided
Objects
Link
href
String
None Provided
rel
String
None Provided
Item
actions
Array
None Provided
agent_id
String
None Provided
agent_name
String
None Provided
attributes
Attribute
None Provided
backup_plan_id
String
None Provided
backup_plan_name
String
None Provided
centralized_plan_id
String
None Provided
compressed_data_size
Number (float)
None Provided
consistent
Boolean
None Provided
created
String
None Provided
data_size
Number (float)
None Provided
deleted
Boolean
None Provided
deleted_immutable
Boolean
None Provided
description
String
None Provided
display_name
String
None Provided
encryption_algorithm
String
None Provided
file_name
String
None Provided
format
String
None Provided
id
String
None Provided
last_backup_created
String
None Provided
last_seen_at
String
None Provided
legacy_id
String
None Provided
logical_size
Number (float)
None Provided
marked_for_deletion
Boolean
None Provided
name
String
None Provided
original_data_size
Number (float)
None Provided
owner_id
String
None Provided
owner_name
String
None Provided
protected_by_password
Boolean
None Provided
resource_id
String
None Provided
resource_name
String
None Provided
resource_type
String
None Provided
size
Number (float)
None Provided
source_key
String
None Provided
source_usn
Number (float)
None Provided
tenant_id
String
None Provided
tenant_locator
String
None Provided
type
String
None Provided
updated
String
None Provided
vault_id
String
None Provided
Link
href
String
None Provided
rel
String
None Provided
Attribute
aaib
String
None Provided
uri
String
None Provided
Backed Up Resources
List Backed Up Resources
previously-storedRetrieve previously-stored resources.
Request
GET /api/vault_manager/v1/backed_up_resources
Query Params
order
String
An ordering filter that orders the results by column name
vaultId
Acronis Vault
ID of vault to search backups for.
archiveId
Acronis Archive
ID of archive to search backups for.
tapeId
String (?)
Filter backups for specified tapes.
Backups
List Backups
Retrieve saved copies of data or system configurations.
Request
GET /api/vault_manager/v1/backups
Query Params
count
String (?)
Show total count in the response.
order
String
An ordering filter that orders the results by column name
storageId
String
Show only backups located in vaults of the storage that is identified by specified storage ID.
agentId
Acronis Agent ID
Show only backups for specified agent.
type
String
Show only backups of specified resource type.
vaultId
Acronis Vault ID
ID of vault to search archives for.
regtime
String
Show only backups created or deleted within specified time range.
updated
String
Show only backups updated within specified time range.
storageType
String
Show only backups located in vaults of specified storage types.
forensic
String
Show only backups in archives with forensic data or without forensic. If not specified, backups are listed regardless of forensic data.
resourceId
String (?)
Show only backups for specified resources.
changeTag
String (?)
Show only backups for specified change tag.
showDeleted
String
A flag that specifies what should be added to the list of returned backups
embed
String (?)
An array of field names to include in the response. Each value represents the name of the extension field to be included in the base response.
created
String (?)
Show only backups created within specified time range.
protectedByPassword
String (?)
Show only backups in protected by password or unprotected by password archives. If not specified, backups are listed regardless of their password protection status.
backupType
String (?)
Show only backups of specified types.
tapeId
String (?)
Show only backups for specified tapes.
triggeredBy
String (?)
Show a list of Backups triggered by specified reason.
avScanningDate
String (?)
Show only backups scanned within the specified time range OR never scanned backups if "none" is specified.
vulnerabilityAssessmentStatus
String
Show only backups with specified Vulnerability Assessment Result Statuses
malwareAssessmentStatus
String (?)
Show only backups with specified Malware Assessment Result statuses.
includeActions
String (?)
Calculate and include possible actions in the response.
targentAgentId
Acronis Target Agent ID
Select target agent to calculate actions.
Response
A key-value pair that includes the following keys:
Response
_links
Link
None Provided
items
Item
None Provided
Delete Backups
Delete all backup files.
Request
DELETE /api/vault_manager/v1/backups
Query Params
resourceID*
Acronis Backup
None Provided
changeTag
String
Tag for run tasks.
Objects
Link
href
String
None Provided
rel
String
None Provided
Item
archive_id
String
None Provided
attributes
Attribute
None Provided
backed_up_data_size
Number (float)
None Provided
backup_id
String
None Provided
created
String
None Provided
created_in_network_isolation
Boolean
None Provided
deduplicated_size
Number (float)
None Provided
deleted
Boolean
None Provided
deleted_immutable
Boolean
None Provided
disks
Disk
None Provided
dynamic_volumes
Dynamic Volume
None Provided
items_added
Number (float)
None Provided
items_changed
Number (float)
None Provided
items_removed
Number (float)
None Provided
last_seen_at
String
None Provided
legacy_id
String
None Provided
marked_for_deletion
Boolean
None Provided
notarized
Boolean
None Provided
original_data_size
Number (float)
None Provided
resource_ids
Array
None Provided
size
Number (float)
None Provided
source_key
String
None Provided
source_usn
Number (float)
None Provided
tenant_id
String
None Provided
tenant_locator
String
None Provided
type
String
None Provided
vault_id
String
None Provided
Attribute
is_vm
String
None Provided
stream_name
String
None Provided
uri
String
None Provided
vm_kind
String
None Provided
Disk
device_model
String
None Provided
name
String
None Provided
size
Number (float)
None Provided
volumes
Volume
None Provided
Dynamicvolume
free_space
Number (float)
None Provided
is_bootable
Boolean
None Provided
is_system
Boolean
None Provided
name
String
None Provided
size
Number (float)
None Provided
Volume
free_space
Number (float)
None Provided
is_bootable
Boolean
None Provided
is_system
Boolean
None Provided
mount_strid
String
None Provided
name
String
None Provided
size
Number (float)
None Provided
Basic Platform Info
Get Platform Components Versions
Get current versions of the platform components
Request
GET /api/2/versions
Response
A key-value pair that includes the following keys:
Response
application
Application
None Provided
components
Component
None Provided
List Editions
Get all available editions
Request
GET /api/2/editions
Response
A key-value pair that includes the following keys:
Response
items
Array
None Provided
List Tenant Offering Items
Request
GET /api/2/tenants/{tenant_id}/offering_items
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
Objects
Application
edition
String
None Provided
name
String
None Provided
version
String
None Provided
Component
name
String
None Provided
version
String
None Provided
Item
edition
String
None Provided
name
String
None Provided
usage_name
String
None Provided
Branding
Retrieve Brand Information For A Specific Tenant
Request
GET /api/2/tenants/{tenant_id}/brand
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
account_server_url
String
None Provided
backup_console_url
String
None Provided
color
String
None Provided
color_scheme
String
None Provided
company_name
String
None Provided
help_url
String
None Provided
hide_predefined
Number (float)
None Provided
home_url
String
None Provided
id
String
None Provided
knowledgebase_url
String
None Provided
logotype
String
None Provided
owns_custom_legal_docs
Boolean
None Provided
platform_terms_url
String
None Provided
privacy_policy_url
String
None Provided
router_url
String
None Provided
service_name
String
None Provided
smtp_encryption
String
None Provided
smtp_override
Number (float)
None Provided
smtp_password
String
None Provided
smtp_port
Number (float)
None Provided
smtp_reply_address
String
None Provided
smtp_server
String
None Provided
smtp_user
String
None Provided
support_url
String
None Provided
terms_url
String
None Provided
upsell_url
String
None Provided
user_guide_url
String
None Provided
white_labeled_agent
Boolean
None Provided
Update Tenant Branding Properties
Modify visual appearance of tenant's account.
Request
PUT /api/2/tenants/{tenant_id}/brand
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
account_server_url
String
None Provided
backup_console_url
String
None Provided
color
String
None Provided
color_scheme
String
None Provided
company_name
String
None Provided
help_url
String
None Provided
hide_predefined
Number (float)
None Provided
home_url
String
None Provided
id
String
None Provided
knowledgebase_url
String
None Provided
logotype
String
None Provided
owns_custom_legal_docs
Boolean
None Provided
platform_terms_url
String
None Provided
privacy_policy_url
String
None Provided
router_url
String
None Provided
service_name
String
None Provided
smtp_encryption
String
None Provided
smtp_override
Number (float)
None Provided
smtp_password
String
None Provided
smtp_port
Number (float)
None Provided
smtp_reply_address
String
None Provided
smtp_server
String
None Provided
smtp_user
String
None Provided
support_url
String
None Provided
terms_url
String
None Provided
upsell_url
String
None Provided
user_guide_url
String
None Provided
white_labeled_agent
Boolean
None Provided
Enable Custom Branding
API endpoint for setting custom branding across an application or platform.
Request
POST /api/2/tenants/{tenant_id}/brand
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
ancestral_access
Boolean
None Provided
brand_id
Number (float)
None Provided
brand_uuid
String
None Provided
contact
Contact
None Provided
contacts
Array
None Provided
created_at
String
None Provided
customer_type
String
None Provided
default_idp_id
String
None Provided
enabled
Boolean
None Provided
has_children
Boolean
None Provided
id
String
None Provided
kind
String
None Provided
language
String
None Provided
mfa_status
String
None Provided
name
String
None Provided
parent_id
String
None Provided
pricing_mode
String
None Provided
update_lock
Update Lock
None Provided
updated_at
String
None Provided
version
Number (float)
None Provided
Disable Custom Branding
Remove user-defined branding options.
Request
DELETE /api/2/tenants/{tenant_id}/brand
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
ancestral_access
Boolean
None Provided
brand_id
Number (float)
None Provided
brand_uuid
String
None Provided
contact
Contact
None Provided
contacts
Array
None Provided
created_at
String
None Provided
customer_type
String
None Provided
default_idp_id
String
None Provided
enabled
Boolean
None Provided
has_children
Boolean
None Provided
id
String
None Provided
kind
String
None Provided
language
String
None Provided
mfa_status
String
None Provided
name
String
None Provided
parent_id
String
None Provided
pricing_mode
String
None Provided
update_lock
Update Lock
None Provided
updated_at
String
None Provided
version
Number (float)
None Provided
Retrieve Tenant's Brand Logo Image
Request
GET /api/2/tenants/{tenant_id}/brand/logo
Path Params
tenant_id*
Acronis Tenant
None Provided
Objects
Contact
created_at
String
None Provided
String
None Provided
firstname
String
None Provided
id
String
None Provided
lastname
String
None Provided
updated_at
String
None Provided
Updatelock
enabled
Boolean
None Provided
Contact
created_at
String
None Provided
String
None Provided
firstname
String
None Provided
id
String
None Provided
lastname
String
None Provided
updated_at
String
None Provided
Contacts
Create Contact
Add Partner Tenant's Contact Information To The System
Request
POST /api/2/contacts
JSON Body
String
None Provided
firstname
String
None Provided
lastname
String
None Provided
tenant_id
Acronis Tenant
None Provided
types
Array
None Provided
Response
A key-value pair that includes the following keys:
Response
created_at
String
None Provided
String
None Provided
firstname
String
None Provided
id
String
None Provided
lastname
String
None Provided
tenant_id
String
None Provided
types
Array
None Provided
updated_at
String
None Provided
Retrieve Contacts For A Specified Partner Tenant
Request
GET /api/2/tenants/{tenant_id}/contacts
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Array
None Provided
Get Contact
Request
GET /api/2/contacts/{contact_id}
Path Params
contact_id*
String
None Provided
Generic Request
Acronis API Request
Generic action for making authenticated requests against the Acronis API
Request
GET
Headers
Health Check
Health Check
Endpoint to verify service availability and status.
Request
GET /api/vault_manager/v1/healthcheck
Response
A key-value pair that includes the following keys:
Response
Arch
String
None Provided
BuildDate
String
None Provided
BuildNumber
String
None Provided
CommitHash
String
None Provided
GoVersion
String
None Provided
Manufacturer
String
None Provided
Name
String
None Provided
Os
String
None Provided
Version
String
None Provided
Legal Documents
Retrieve User's Legal Documents
Request
GET /api/2/users/{user_id}/legal_documents
Path Params
user_id*
Acronis User
None Provided
Initiate A Signature Process For Legal Documents
Request
POST /api/2/users/{user_id}/legal_documents
Path Params
user_id*
Acronis User
None Provided
JSON Body
items
Array
None Provided
Locations and Storage Management
Get Locations By Tenant
Request
GET /api/2/tenants/{tenant_id}/locations
Path Params
tenant_id*
Acronis Tenant
None Provided
Query Params
uuids*
Array
None Provided
Response
A key-value pair that includes the following keys:
Response
locations
Array
None Provided
List Locations
Request
GET /api/2/locations
Headers
X-Apigw-Tenant-Id*
Acronis Tenant
None Provided
Query Params
uuids*
Array
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
Get Location
Request
GET /api/2/locations/{location_uuid}
Path Params
location_uuid*
Acronis Location
None Provided
List Storage Options By Tenant
Request
GET /api/2/tenants/{tenant_id}/infra
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
infras
Array
None Provided
Get Storage Option
Request
GET /api/2/infra/{infra_uuid}
Path Params
infra_uuid*
Acronis Storage Option
None Provided
tenant_id
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
backend_type
String
None Provided
capabilities
Array
None Provided
id
String
None Provided
location_id
String
None Provided
name
String
None Provided
owner_tenant_id
String
None Provided
platform_owned
Boolean
None Provided
readonly
Boolean
None Provided
url
String
None Provided
version
Number (float)
None Provided
List Storage Options
Request
GET /api/2/infra
Headers
X-Apigw-Tenant-Id*
Acronis Tenant
None Provided
Query Params
uuids*
Array
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
Objects
Item
id
String
None Provided
name
String
None Provided
owner_tenant_id
String
None Provided
platform_owned
Boolean
None Provided
readonly
Boolean
None Provided
version
Number (float)
None Provided
Item
capabilities
Array
None Provided
id
String
None Provided
location_id
String
None Provided
name
String
None Provided
owner_tenant_id
String
None Provided
platform_owned
Boolean
None Provided
readonly
Boolean
None Provided
url
String
None Provided
version
Number (float)
None Provided
Reports Management
List Tenant Reports
Request
GET /api/2/tenants/{tenant_id}/reports
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Array
None Provided
Get Report
Retrieve information about a specific report.
Request
GET /api/2/reports/{report_id}
Path Params
report_id*
Acronis Report
None Provided
Response
A key-value pair that includes the following keys:
Response
generation_date
String
None Provided
id
String
None Provided
parameters
Parameter
None Provided
recipients
Array
None Provided
result_action
String
None Provided
schedule
Schedule
None Provided
version
Number (float)
None Provided
Update Scheduled Report
Request
PUT /api/2/reports/{report_id}
Path Params
report_id*
Acronis Report
None Provided
JSON Body
generation_date
String
None Provided
parameters
Parameter
None Provided
recipients
Array
None Provided
result_action
String
None Provided
schedule
Schedule
None Provided
Response
A key-value pair that includes the following keys:
Response
generation_date
String
None Provided
id
String
None Provided
parameters
Parameter
None Provided
recipients
Array
None Provided
result_action
String
None Provided
schedule
Schedule
None Provided
version
Number (float)
None Provided
Delete Report
Request
DELETE /api/2/reports/{report_id}
Path Params
report_id*
Acronis Report
None Provided
Objects
Parameter
formats
Array
None Provided
kind
String
None Provided
level
String
None Provided
period
Period
None Provided
tenant_id
String
None Provided
Schedule
enabled
Boolean
None Provided
type
String
None Provided
Parameter
formats
Array
None Provided
kind
String
None Provided
level
String
None Provided
period
Period
None Provided
Period
end
String
None Provided
start
String
None Provided
Search
Text Search
Request
GET /api/2/search
Query Params
text*
String
Text to search
tenant
Acronis Tenant
A tenant in which hierarchy the search will be performed
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
Objects
Item
first_name
String
None Provided
id
String
None Provided
kind
String
None Provided
last_name
String
None Provided
login
String
None Provided
name
String
None Provided
obj_type
String
None Provided
parent_id
String
None Provided
path
Array
None Provided
Search Index Size Stats
Get Archive Search Size Statistics
Request
GET /api/vault_manager/v1/search_index_size_stats/{tenantId}
Path Params
tenantId*
Acronis Tenant
None Provided
Query Params
archive_name
String
Archive Name
Stats
Get Archive Stats
Get data on past activity or usage.
Request
GET /api/vault_manager/v1/stats
Query Params
resourceId
String
Get statistics only for Archives that contain backups for specified resources.
storageType
String
Get statistics only for Archives in vaults of specified storage types.
Response
A key-value pair that includes the following keys:
Response
_links
Link
None Provided
occupied_data_size
Number (float)
None Provided
search_index_size
Number (float)
None Provided
Objects
Link
href
String
None Provided
rel
String
None Provided
Storage Dirs
Get Storage Folders
Get all folders stored in storage.
Request
GET /api/vault_manager/v1/storage_dirs/{storageId}
Path Params
storageId*
Acronis Storage Node
None Provided
Query Params
includeAttached
String
List all folders including the ones attached to vaults.
Retrieve Sub Folders Within A Given Directory Path
Retrieve sub-folders within a given directory path.
Request
GET /api/vault_manager/v1/storage_dirs/{storageId}/{path}
Path Params
storageId*
Acronis Storage Node
None Provided
path*
String
None Provided
Query Params
includeAttached
String
List all folders including the ones attached to vaults.
Storage Nodes
Get Registered Storage Nodes
Retrieve list of registered storage nodes in the network.
Request
GET /api/vault_manager/v1/storage_nodes
Headers
X-Apigw-Tenant-Id*
Acronis Tenant
None Provided
Storage Usage Stats
Get Storage Usage Stats
Retrieve data about storage space utilization.
Request
GET /api/vault_manager/v1/storage_usage_stats
Headers
X-Apigw-Tenant-Id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
Objects
Item
cloud_archive_count
Number (float)
None Provided
cloud_storage_usage
Number (float)
None Provided
local_archive_count
Number (float)
None Provided
local_storage_size
Number (float)
None Provided
local_storage_usage
Number (float)
None Provided
tenant
String
None Provided
Sync
Get Archives Sync Info
Retrieve synchronization data related to archives.
Request
GET /api/vault_manager/v1/sync/archives
Query Params
agentId
Acronis Agent
None Provided
sourceUsnGt
String (?)
Show only archives with source Update Sequence Number (USN) greater than requested.
order
String
An ordering filter that orders the results by column name
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
Get Backups Sync Info
Retrieve Information on Backup Synchronization.
Request
GET /api/vault_manager/v1/sync/backups
Query Params
agentId
Acronis Agent
None Provided
sourceUsnGt
String (?)
Show only archives with source Update Sequence Number (USN) greater than requested.
order
String
An ordering filter that orders the results by column name
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
List Vault Sync Information
Get synchronization information for Vaults.
Request
GET /api/vault_manager/v1/sync/vaults
Query Params
managingAgentId
Acronis Managing Agent ID
Filter vaults by agent ID.
sourceUsnGt
String (?)
Show only archives with source Update Sequence Number (USN) greater than requested.
order
String
An ordering filter that orders the results by column name
Response
A key-value pair that includes the following keys:
Response
_links
Link
None Provided
items
Item
None Provided
Objects
Item
source_key
String
None Provided
source_usn
Number (float)
None Provided
Item
source_key
String
None Provided
source_usn
Number (float)
None Provided
Link
href
String
None Provided
rel
String
None Provided
Tasks
List Tasks
Retrieve a customized list of tasks.
Request
GET /api/task_manager/v2/tasks
Query Params
lod
String
None Provided
state
String (?)
None Provided
completedAt
String (?)
None Provided
type
String
None Provided
policyType
String (?)
None Provided
resultCode
String (?)
None Provided
id
Acronis Task
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
size
Number (float)
None Provided
timeStamp
String
None Provided
Objects
Item
cancelRequested
Boolean
None Provided
cancellable
Boolean
None Provided
completedAt
String
None Provided
context
Context
None Provided
enqueuedAt
String
None Provided
executor
Executor
None Provided
id
Number (float)
None Provided
idString
String
None Provided
issuer
Issuer
None Provided
policy
Policy
None Provided
priority
String
None Provided
progress
Progress
None Provided
queue
String
None Provided
resource
Resource
None Provided
result
Result
None Provided
startedAt
String
None Provided
state
String
None Provided
tenant
Tenant
None Provided
type
String
None Provided
updatedAt
String
None Provided
uuid
String
None Provided
Context
BackupPlanName
String
None Provided
CommandID
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
ProcessID
Number (float)
None Provided
ProtectionPlanID
String
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
clusterId
String
None Provided
id
String
None Provided
Issuer
clusterId
String
None Provided
id
String
None Provided
Policy
id
String
None Provided
name
String
None Provided
type
String
None Provided
Progress
current
Number (float)
None Provided
total
Number (float)
None Provided
Resource
id
String
None Provided
name
String
None Provided
type
String
None Provided
Result
code
String
None Provided
payload
Payload
None Provided
Tenant
id
String
None Provided
locator
String
None Provided
name
String
None Provided
Runtime
sourceStamp
Number (float)
None Provided
Payload
BackupActivitiesNumber
Number (float)
None Provided
UnresolvedItemsWarning
Key-Value pair (Dictionary)
None Provided
Tenants
Get Tenant
Request
GET /api/2/tenants/{tenant_id}
Path Params
tenant_id*
Acronis Tenant
None Provided
Query Params
parent_id
Acronis Parent
None Provided
subtree_root_id
Acronis Subtree Root
None Provided
editions
Array
None Provided
tenants
Array
None Provided
usage_names
String
None Provided
Response
A key-value pair that includes the following keys:
Response
ancestral_access
Boolean
None Provided
brand_id
Number (float)
None Provided
brand_uuid
String
None Provided
contact
Contact
None Provided
customer_type
String
None Provided
default_idp_id
String
None Provided
enabled
Boolean
None Provided
has_children
Boolean
None Provided
id
String
None Provided
kind
String
None Provided
language
String
None Provided
name
String
None Provided
parent_id
String
None Provided
update_lock
Update Lock
None Provided
version
Number (float)
None Provided
List Tenants
Request
GET /api/2/tenants
Query Params
parent_id
Acronis Parent Tenant
None Provided
subtree_root_id*
Acronis Tenant Subtree Root
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
List User Roles By Tenant
Request
GET /api/2/tenants/{tenant_id}/applications/roles
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
List Tenant Children
Request
GET /api/2/tenants/{tenant_id}/children
Path Params
tenant_id*
Acronis Tenant
None Provided
List Tenant Users' UUIDs
Retrieve user data for a specific tenant in the system. Returns a list of the User's UUIDs.
Request
GET /api/2/tenants/{tenant_id}/users
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Array
None Provided
List Tenant Client UUIDs
Retrieves UUIDs of Clients For A Tenant
Request
GET /api/2/tenants/{tenant_id}/clients
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Array
None Provided
Get Tenant MFA Status
Request
GET /api/2/tenants/{tenant_id}/mfa/status
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
mfa_status
String
None Provided
update_allowed
Boolean
None Provided
users_count
Number (float)
None Provided
users_with_totp_enabled_count
Number (float)
None Provided
Get Tenant's Brand Information
Request
GET /api/2/tenants/{tenant_id}/brand
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
account_server_url
String
None Provided
backup_console_url
String
None Provided
color
String
None Provided
color_scheme
String
None Provided
company_name
String
None Provided
help_url
String
None Provided
hide_predefined
Number (float)
None Provided
home_url
String
None Provided
id
String
None Provided
knowledgebase_url
String
None Provided
logotype
String
None Provided
owns_custom_legal_docs
Boolean
None Provided
platform_terms_url
String
None Provided
privacy_policy_url
String
None Provided
router_url
String
None Provided
service_name
String
None Provided
smtp_encryption
String
None Provided
smtp_override
Number (float)
None Provided
smtp_password
String
None Provided
smtp_port
Number (float)
None Provided
smtp_reply_address
String
None Provided
smtp_server
String
None Provided
smtp_user
String
None Provided
support_url
String
None Provided
terms_url
String
None Provided
upsell_url
String
None Provided
user_guide_url
String
None Provided
white_labeled_agent
Boolean
None Provided
List Legal Documents For Tenant
Retrieve Legal Document Information For A Tenant's Account
Request
GET /api/2/tenants/{tenant_id}/legal_documents
Path Params
tenant_id*
Acronis Tenant
None Provided
Get Tenant Logo
Retrieve Tenant Brand Logo Image
Request
GET /api/2/tenants/{tenant_id}/brand/logo
Path Params
tenant_id*
Acronis Tenant
None Provided
Create Tenant
Create a new partner tenant
Request
POST /api/2/tenants
JSON Body
name*
String
None Provided
parent_id*
Acronis Parent Tenant
None Provided
enabled
Boolean
None Provided
kind*
String
None Provided
contact
Contact
None Provided
customer_id
String
ID from external system; for reporting purposes.
update_lock
Update Lock
None Provided
language
String
None Provided
ancestral_access
Boolean
Access to newly created tenant from ancestors?
settings
Setting
None Provided
Update Tenant
Updates a new partner tenant's fields
Request
PUT /api/2/tenants/{tenant_id}
Path Params
tenant_id*
Acronis Tenant
None Provided
JSON Body
name
String
None Provided
parent_id
Acronis Parent Tenant
None Provided
kind
String
None Provided
contact
Contact
None Provided
customer_id
String
ID from external system; for reporting purposes.
enabled
Boolean
None Provided
update_lock
Update Lock
None Provided
language
String
None Provided
ancestral_access
Boolean
Access to newly created tenant from ancestors?
settings
Setting
None Provided
Enable MFA For Tenant
Enable two-factor authentication for user's partner account.
Request
PUT /api/2/tenants/{tenant_id}/mfa/status
Path Params
tenant_id*
Acronis Tenant
None Provided
JSON Body
enabled
Boolean
None Provided
Response
A key-value pair that includes the following keys:
Response
mfa_status
String
None Provided
update_allowed
Boolean
None Provided
users_count
Number (float)
None Provided
users_with_totp_enabled_count
Number (float)
None Provided
Delete Tenant
Remove a partner's associated tenant from database.
Request
DELETE /api/2/tenants/{tenant_id}
Path Params
tenant_id*
Acronis Tenant
None Provided
Get Tenant Pricing
Request
GET /api/2/tenants/{tenant_id}/pricing
Path Params
tenant_id*
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
mode
String
None Provided
production_start_date
String
None Provided
version
Number (float)
None Provided
Update Tenant Pricing
Request
PUT /api/2/tenants/{tenant_id}/pricing
Path Params
tenant_id*
Acronis Tenant
None Provided
JSON Body
mode
String
None Provided
Response
A key-value pair that includes the following keys:
Response
mode
String
None Provided
version
Number (float)
None Provided
List Subtenants
Request
GET /api/2/tenants/{tenant_id}
Path Params
tenant_id*
Acronis Tenant
None Provided
Get A Tenant Usage
Retrieve data on a tenant's resource consumption.
Request
GET /api/2/tenants/{tenant_id}/usages
Path Params
tenant_id*
Acronis Tenant
None Provided
Query Params
editions
Array
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
Objects
Contact
String
None Provided
firstname
String
None Provided
lastname
String
None Provided
Updatelock
enabled
Boolean
None Provided
Item
ancestral_access
Boolean
None Provided
brand_id
Number (float)
None Provided
brand_uuid
String
None Provided
contact
Contact
None Provided
contacts
Array
None Provided
customer_type
String
None Provided
default_idp_id
String
None Provided
enabled
Boolean
None Provided
has_children
Boolean
None Provided
id
String
None Provided
internal_tag
String
None Provided
kind
String
None Provided
language
String
None Provided
mfa_status
String
None Provided
name
String
None Provided
parent_id
String
None Provided
pricing_mode
String
None Provided
update_lock
Update Lock
None Provided
version
Number (float)
None Provided
Item
application_id
String
None Provided
is_default
Boolean
None Provided
role
String
None Provided
type
String
None Provided
Setting
enhanced_security
Boolean
Enables PCI DSS mode
Users
List Users
Request
GET /api/2/users
Query Params
with_access_policies
Boolean
None Provided
updated_since
String
None Provided
lod
String
None Provided
subtree_root_tenant_id*
Acronis Subtree Root Tenant
None Provided
Get User
Retrieve information about a specific user.
Request
GET /api/2/users/{user_id}
Path Params
user_id*
Acronis User
None Provided
tenant_id
Acronis Tenant
None Provided
Response
A key-value pair that includes the following keys:
Response
activated
Boolean
None Provided
business_types
Array
None Provided
contact
Contact
None Provided
created_at
String
None Provided
enabled
Boolean
None Provided
id
String
None Provided
idp_id
String
None Provided
language
String
None Provided
login
String
None Provided
mfa_status
String
None Provided
notifications
Array
None Provided
personal_tenant_id
String
None Provided
tenant_id
String
None Provided
version
Number (float)
None Provided
Create User
Request
POST /api/2/users
JSON Body
enabled
String (?)
None Provided
business_types
Array
None Provided
contact
Contact
None Provided
idp_id
String (?)
None Provided
language
String (?)
None Provided
login*
String (?)
None Provided
external_id
String (?)
User's ID in external identity provider (e.g. SID in AD).
notifications
Array
None Provided
personal_tenant_id
String (?)
None Provided
tenant_id*
String (?)
None Provided
Update User
Request
PUT /api/2/users/{user_id}
Path Params
user_id*
Acronis User
None Provided
JSON Body
login
String
None Provided
tenant_id
String
None Provided
contact
Contact
None Provided
enabled
String (?)
None Provided
business_types
Array
None Provided
idp_id
String (?)
None Provided
language
String (?)
None Provided
external_id
String (?)
User's ID in external identity provider (e.g. SID in AD).
notifications
Array
None Provided
personal_tenant_id
String (?)
None Provided
Delete A User
Remove user data permanently.
Request
DELETE /api/2/users/{user_id}
Path Params
user_id*
Acronis User
None Provided
Send Activation Email To User
Request
POST /api/2/users/{user_id}/send-activation-email
Path Params
user_id*
Acronis User
None Provided
List Tenant Application Roles
Request
GET /api/2/tenants/{tenant_id}/applications/roles
Path Params
tenant_id*
Acronis Tenant
None Provided
JSON Body
enabled
Boolean
None Provided
version
String (?)
None Provided
Get A User's Access Policies
Retrieve authorized user roles.
Request
GET /api/2/users/{user_id}/access_policies
Path Params
user_id*
Acronis User
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
List Tenant's Offered Items
Request
GET /api/2/tenants/{tenant_id}/offering_items
Path Params
tenant_id*
Acronis Tenant
None Provided
Query Params
edition
Acronis Edition
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
Update Tenant's Products
Request
PUT /api/2/tenants/{tenant_id}/offering_items
Path Params
tenant_id*
Acronis Tenant
None Provided
JSON Body
offering_items
Product
None Provided
Response
A key-value pair that includes the following keys:
Response
items
Item
None Provided
Objects
Contact
String
None Provided
firstname
String
None Provided
lastname
String
None Provided
state
String
None Provided
Contact
email*
String (?)
None Provided
firstname
String (?)
None Provided
lastname
String (?)
None Provided
phone
String (?)
None Provided
state
String (?)
None Provided
address1
String (?)
None Provided
address2
String (?)
None Provided
title
String (?)
None Provided
website
String (?)
None Provided
email_confirmed
String (?)
None Provided
country
String (?)
None Provided
Item
id
String
None Provided
issuer_id
String
None Provided
role_id
String
None Provided
tenant_id
String
None Provided
trustee_id
String
None Provided
trustee_type
String
None Provided
version
Number (float)
None Provided
Product
application_id
Acronis Application
None Provided
deleted_at
String
A filter by date when the alert was dismissed. Must be a Unix timestamp in nanoseconds. Available operators: eq - equals lt - less than gt - greater than le - less than or equals ge - greater than or equals
edition
Acronis Edition
None Provided
infra_id
Acronis Infra
None Provided
locked
Boolean
None Provided
measurement_unit
String
None Provided
name
String
None Provided
quota
Quotum
None Provided
status
Number (float)
None Provided
tenant_id
Acronis Tenant
None Provided
type
String
None Provided
updated_at
String
None Provided
usage_name
String
None Provided
Quotum
overage
Number (float)
None Provided
value
Number (float)
None Provided
version
Number (float)
None Provided
Vaults
Retrieve users' stored items credentials from secure data repository.
Request
GET /api/vault_manager/v1/vaults
Query Params
hostname
String
Filter vaults by hostname. Supports matching any number of characters using asterisk wildcard character.
storageNodeId
Acronis Storage Node ID
ID of Storage node to search vaults for.
managed
String
Show only managed or unmanaged vaults. If not specified, all types of vaults are listed.
name
String
Filter vaults ny name. Supports matching any number of characters using asterisk wildcard character.
resourceId
String
Show only vaults which contain archives of specified resource ID.
uri
String
Filter vaults by URI. Supports matching any numbers using asterisk wildcard character.
type
String
Show only vaults of specified storage types.
storageId
String
Show only vaults in the storage with specified ID.
accessibleForAgent
String
Show only vaults that:
tenantId
Acronis Tenant ID
Show only vaults in specific Tenant ID (do not include its subtenants).
includeStats
String (?)
Calculate and include vault stats.
includeLastBackupTime
Boolean
Calculate and include vault's last backup time.
includeActions
String (?)
Calculate and include possible actions in the response.
count
String (?)
Show total count in the response.
order
String
An ordering filter that orders the results by column name
Response
A key-value pair that includes the following keys:
Response
_links
Link
None Provided
items
Item
None Provided
Create Or Attach Vault
Create or attach a secure storage vault.
Request
POST /api/vault_manager/v1/vaults
JSON Body
action
String
None Provided
config
Config
None Provided
Get Vault
Retrieve secure data from protected storage.
Request
GET /api/vault_manager/v1/vaults/{vaultId}
Path Params
vaultId*
Acronis Vault
None Provided
Query Params
includeStats
String (?)
Calculate and include vault stats.
includeLastBackupTime
Boolean
Calculate and include vault last backup time.
includeActions
String (?)
Calculate and include possible actions in the response.
Response
A key-value pair that includes the following keys:
Response
_links
Link
None Provided
access_address
String
None Provided
actions
Array
None Provided
consistent
Boolean
None Provided
free_space
Number (float)
None Provided
hostname
String
None Provided
id
String
None Provided
last_seen_at
String
None Provided
managing_agent_id
String
None Provided
name
String
None Provided
organizational
Boolean
None Provided
settings
Setting
None Provided
status
Status
None Provided
storage_type
String
None Provided
storage_uri
String
None Provided
tenant_id
String
None Provided
tenant_locator
String
None Provided
tenant_name
String
None Provided
total_space
Number (float)
None Provided
uri
String
None Provided
version
String
None Provided
Delete Vault
Removes a secure storage container and its contents.
Request
DELETE /api/vault_manager/v1/vaults/{vault_id}
JSON Body
action
String
None Provided
List Vault Archives
Retrieve stored data backups from Vault.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/archives
Path Params
vaultId*
Acronis Vault
None Provided
Query Params
archiveId
Acronis Archive
None Provided
showDeleted
String
A flag that specifies what should be added to the list of returned backups
includeStats
Boolean
Include additional information about archive
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 string 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 included 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 - Backup 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.
count
String (?)
Show total count in the response.
order
String
An ordering filter that orders the results by column name
Response
A key-value pair that includes the following keys:
Response
_links
Link
None Provided
items
Item
None Provided
Get Vault Archive Backup
Retrieve backups of Vault archive.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/archives/{archiveId}/backups/{backupId}
Path Params
vaultId*
Acronis Vault
None Provided
archiveId*
Acronis Archive
None Provided
backupId*
String
None Provided
Query Params
embed
String (?)
An array of field names to include in the response. Each value represents the name of the extension field to be included in the base response.
Response
A key-value pair that includes the following keys:
Response
_links
Link
None Provided
archive_id
String
None Provided
attributes
Attribute
None Provided
backed_up_data_size
Number (float)
None Provided
backup_id
String
None Provided
created
String
None Provided
created_in_network_isolation
Boolean
None Provided
deduplicated_size
Number (float)
None Provided
deleted
Boolean
None Provided
deleted_immutable
Boolean
None Provided
disks
Disk
None Provided
items_added
Number (float)
None Provided
items_changed
Number (float)
None Provided
items_removed
Number (float)
None Provided
last_seen_at
String
None Provided
legacy_id
String
None Provided
marked_for_deletion
Boolean
None Provided
notarized
Boolean
None Provided
original_data_size
Number (float)
None Provided
resource_ids
Array
None Provided
size
Number (float)
None Provided
source_key
String
None Provided
source_usn
Number (float)
None Provided
tenant_id
String
None Provided
tenant_locator
String
None Provided
type
String
None Provided
vault_id
String
None Provided
Returns Screenshot Of Complete Vault Archive Backup
Request
GET /api/vault_manager/v1/vaults/{vaultId}/archives/{archiveId}/backups/{backupId}/validation_status/screenshot_full
Path Params
vaultId*
Acronis Vault
None Provided
archiveId*
Acronis Archive
None Provided
backupId*
String
None Provided
Retrieve Thumbnail Image Of A Vault Archive Backup Screenshot
Request
GET /api/vault_manager/v1/vaults/{vaultId}/archives/{archiveId}/backups/{backupId}/validation_status/screenshot_preview
Path Params
vaultId*
Acronis Vault
None Provided
archiveId*
Acronis Archive
None Provided
backupId*
String
None Provided
Get Full Screenshot
Retrieve complete webpage visual.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/archives/{archiveId}/backups/{backupId}/automated_test_failover_validation_status/screenshot_full
Path Params
vaultId*
Acronis Vault
None Provided
archiveId*
Acronis Archive
None Provided
backupId*
String
None Provided
Get Screenshot Preview
Returns a preview image of a webpage.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/archives/{archiveId}/backups/{backupId}/automated_test_failover_validation_status/screenshot_preview
Path Params
vaultId*
Acronis Vault
None Provided
archiveId*
Acronis Archive
None Provided
backupId*
String
None Provided
List Timestamps Of Backups For Vault Archive
Request
GET /api/vault_manager/v1/vaults/{vaultId}/archives/{archiveId}/backup_timestamps
Path Params
vaultId*
Acronis Vault
None Provided
archiveId*
Acronis Archive
None Provided
Query Params
resourceId
String
Show timestamps only for specified resource.
created
String (?)
Show backups created only within specified time range.
granularity
String
Granularity interval of grouped backup in seconds.
tzOffset
String
Timezone difference from current timezone to UTC in minutes.
showDeleted
String
A flag that specifies what should be added to the list of returned backups
offset
String
The number of elements to skp before beginning to return elements.
count
String (?)
Show total count in the response.
Response
A key-value pair that includes the following keys:
Response
_links
Link
None Provided
items
Array
None Provided
List Vault Archive Backups
Retrieve archives of Vault backups.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/archives/{archiveId}/backups
Path Params
vaultId*
Acronis Vault
None Provided
archiveId*
Acronis Archive
None Provided
Query Params
resourceId
String (?)
Show only backups for specified resources.
changeTag
String (?)
Show only backups for specified change tag.
showDeleted
String
A flag that specifies what should be added to the list of returned backups
embed
String (?)
An array of field names to include in the response. Each value represents the name of the extension field to be included in the base response.
created
String (?)
Show only backups created within specified time range.
protectedByPassword
String (?)
Show only backups in protected by password or unprotected by password archives. If not specified, backups are listed regardless of their password protection status.
backupType
String
Show only backups of specified types
tapeId
String (?)
Show only backups for specified tapes.
triggeredBy
String (?)
Show a list of Backups triggered by specified reason.
avScanningDate
String (?)
Show only backups scanned within the specified time range OR never scanned backups if "none" is specified.
vulnerabilityAssessmentStatus
String
Show only backups with specified Vulnerability Assessment Result statuses
malwareAssessmentStatus
String (?)
Show only backups with specified Malware Assessment Result statuses.
includeActions
String (?)
Calculate and include possible actions in the response.
targetAgentId
String (?)
Select target agent to calculate actions.
count
String (?)
Show total count in the response.
order
String
An ordering filter that orders the results by column name
Response
A key-value pair that includes the following keys:
Response
_links
Link
None Provided
items
Item
None Provided
Get Vault Configuration
Retrieve configuration settings for Vault.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/config
Path Params
vaultId*
Acronis Vault
None Provided
Response
A key-value pair that includes the following keys:
Response
_links
Link
None Provided
access_address
String
None Provided
consistent
Boolean
None Provided
hostname
String
None Provided
id
String
None Provided
last_seen_at
String
None Provided
managing_agent_id
String
None Provided
name
String
None Provided
organizational
Boolean
None Provided
settings
Setting
None Provided
source_key
String
None Provided
source_usn
Number (float)
None Provided
storage_type
String
None Provided
storage_uri
String
None Provided
tenant_id
String
None Provided
tenant_locator
String
None Provided
tenant_name
String
None Provided
uri
String
None Provided
version
String
None Provided
Get Vault Statistics
Retrieve usage data for your Vault storage.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/stats
Path Params
vaultId*
Acronis Vault
None Provided
Response
A key-value pair that includes the following keys:
Response
_links
Link
None Provided
archive_count
Number (float)
None Provided
backed_up_data_size
Number (float)
None Provided
backup_count
Number (float)
None Provided
free_space
Number (float)
None Provided
logical_archive_size
Number (float)
None Provided
occupied_data_size
Number (float)
None Provided
original_data_size
Number (float)
None Provided
total_space
Number (float)
None Provided
Get Vault Agents
Retrieve information about deployed Vault Agents.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/agents
Path Params
vaultId*
Acronis Vault
None Provided
Objects
Link
href
String
None Provided
rel
String
None Provided
Item
access_address
String
None Provided
actions
Array
None Provided
consistent
Boolean
None Provided
free_space
Number (float)
None Provided
hostname
String
None Provided
id
String
None Provided
last_seen_at
String
None Provided
managing_agent_id
String
None Provided
name
String
None Provided
organizational
Boolean
None Provided
settings
Setting
None Provided
status
Status
None Provided
storage_type
String
None Provided
storage_uri
String
None Provided
tenant_id
String
None Provided
tenant_locator
String
None Provided
tenant_name
String
None Provided
total_space
Number (float)
None Provided
uri
String
None Provided
version
String
None Provided
Config
access_address
String
None Provided
hostname
String
None Provided
managing_agent_id
Acronis Managing Agent
None Provided
name
String
None Provided
settings
Storage Setting
None Provided
storage_id
Acronis Storage
None Provided
storage_type
String
None Provided
Link
href
String
None Provided
rel
String
None Provided
Setting
storage_uri
String
None Provided
Status
status
String
None Provided
status_error
String
None Provided
Attribute
is_vm
String
None Provided
stream_name
String
None Provided
uri
String
None Provided
vm_kind
String
None Provided
Disk
device_model
String
None Provided
name
String
None Provided
size
Number (float)
None Provided
volumes
Volume
None Provided
Storagesetting
comment
String
None Provided
storage_type
String
None Provided
storage_uri
String
None Provided
Volume
free_space
Number (float)
None Provided
is_bootable
Boolean
None Provided
is_system
Boolean
None Provided
mount_strid
String
None Provided
name
String
None Provided
size
Number (float)
None Provided
Last updated
