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
Activities
List Activities
Retrieve a list of activities with specific criteria.
Request
GET /api/task_manager/v2/activities
Query Params
Response
A key-value pair that includes the following keys:
Response
Objects
Item
Context
Executor
Policy
Progress
Resource
Result
Tenant
Persistent
Source
Runtime
Error
Payload
Warning
Itemkey
Context
Debug
Kblink
Src
Field
Suberror
Type
Agent Registration Tokens
List Registration Tokens
Retrieve list of registration tokens.
Request
GET /api/2/tenants/{tenant_id}/registration_tokens
Path Params
Get Registration Token
Request
POST /api/2/tenants/{tenant_id}/registration_tokens
Path Params
JSON Body
Delete Registration Token
Remove device registration identification for push notifications.
Request
DELETE /api/2/registration_tokens/{registration_token_id}
Path Params
Agents
List Tenant Agents
Request
GET /api/agent_manager/v2/agents
Query Params
Trigger Updating All Agents In The System
Request
POST /api/agent_manager/v2/agents/update:force
JSON Body
Response
Get Agent
Request
GET /api/agent_manager/v2/agents/{agent_id}
Path Params
Response
A key-value pair that includes the following keys:
Response
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
Get The Agents Update References
Retrieve agent references from the database.
Request
GET /api/agent_manager/v2/agent_update_references
Query Params
Response
A key-value pair that includes the following keys:
Response
Get Agent Configuration Information
Request
GET /api/agent_manager/v2/agent_update_settings/{agent_id}
Path Params
Query Params
Response
A key-value pair that includes the following keys:
Response
Update Tenant Agent Configuration
Request
GET /api/agent_manager/v2/agent_update_settings/{tenant_id}
Path Params
Query Params
Response
A key-value pair that includes the following keys:
Response
Objects
Core Version
Metum
Platform
Tenant
Unit
Version
Maintenancewindow
Maintenancewindow
Current
Atp
Component
Alert Types
Retrieve Registered Alert Types
Request
GET /api/alert_manager/v1/types
Response
A key-value pair that includes the following keys:
Response
Create An Alerts Type
Endpoint to create a new type of alert.
Request
POST /api/alert_manager/v1/types
JSON Body
Objects
Item
Alerts
List Alerts
Get list of filtered alerts based on specified criteria.
Request
GET /api/alert_manager/v1/alerts
Query Params
Response
A key-value pair that includes the following keys:
Response
Delete Alert(S)
Request
DELETE /api/alert_manager/v1/alerts
Query Params
Get Alert
Request
GET /api/alert_manager/v1/alerts/{alert_id}
Path Params
Response
A key-value pair that includes the following keys:
Response
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
Get Alerts Sync
Retrieve synchronized alerts.
Request
GET /api/alert_manager/v1/sync
Response
A key-value pair that includes the following keys:
Response
Objects
Item
Link
Detail
Tenant
Link
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
Response
A key-value pair that includes the following keys:
Response
Objects
Link
Archives
List Archives
Retrieve historical records or past versions of data.
Request
GET /api/vault_manager/v1/archives
Query Params
Response
A key-value pair that includes the following keys:
Response
Delete Archives
Permanently removes stored data.
Request
DELETE /api/vault_manager/v1/archives
Query Params
List Archive Backups
Retrieve previous versions of data backups.
Request
GET /api/vault_manager/v1/archives/{archiveId}/backups
Path Params
Query Params
Response
A key-value pair that includes the following keys:
Response
Objects
Link
Item
Link
Attribute
Backed Up Resources
List Backed Up Resources
previously-storedRetrieve previously-stored resources.
Request
GET /api/vault_manager/v1/backed_up_resources
Query Params
Backups
List Backups
Retrieve saved copies of data or system configurations.
Request
GET /api/vault_manager/v1/backups
Query Params
Response
A key-value pair that includes the following keys:
Response
Delete Backups
Delete all backup files.
Request
DELETE /api/vault_manager/v1/backups
Query Params
Objects
Link
Item
Attribute
Disk
Dynamicvolume
Volume
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
List Editions
Get all available editions
Request
GET /api/2/editions
Response
A key-value pair that includes the following keys:
Response
List Tenant Offering Items
Request
GET /api/2/tenants/{tenant_id}/offering_items
Path Params
Response
A key-value pair that includes the following keys:
Response
Objects
Application
Component
Item
Branding
Retrieve Brand Information For A Specific Tenant
Request
GET /api/2/tenants/{tenant_id}/brand
Path Params
Response
A key-value pair that includes the following keys:
Response
Update Tenant Branding Properties
Modify visual appearance of tenant's account.
Request
PUT /api/2/tenants/{tenant_id}/brand
Path Params
Response
A key-value pair that includes the following keys:
Response
Enable Custom Branding
API endpoint for setting custom branding across an application or platform.
Request
POST /api/2/tenants/{tenant_id}/brand
Path Params
Response
A key-value pair that includes the following keys:
Response
Disable Custom Branding
Remove user-defined branding options.
Request
DELETE /api/2/tenants/{tenant_id}/brand
Path Params
Response
A key-value pair that includes the following keys:
Response
Retrieve Tenant's Brand Logo Image
Request
GET /api/2/tenants/{tenant_id}/brand/logo
Path Params
Objects
Contact
Updatelock
Contact
Contacts
Create Contact
Add Partner Tenant's Contact Information To The System
Request
POST /api/2/contacts
JSON Body
Response
A key-value pair that includes the following keys:
Response
Retrieve Contacts For A Specified Partner Tenant
Request
GET /api/2/tenants/{tenant_id}/contacts
Path Params
Response
A key-value pair that includes the following keys:
Response
Get Contact
Request
GET /api/2/contacts/{contact_id}
Path Params
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
Legal Documents
Retrieve User's Legal Documents
Request
GET /api/2/users/{user_id}/legal_documents
Path Params
Initiate A Signature Process For Legal Documents
Request
POST /api/2/users/{user_id}/legal_documents
Path Params
JSON Body
Locations and Storage Management
Get Locations By Tenant
Request
GET /api/2/tenants/{tenant_id}/locations
Path Params
Query Params
Response
A key-value pair that includes the following keys:
Response
List Locations
Request
GET /api/2/locations
Headers
Query Params
Response
A key-value pair that includes the following keys:
Response
Get Location
Request
GET /api/2/locations/{location_uuid}
Path Params
List Storage Options By Tenant
Request
GET /api/2/tenants/{tenant_id}/infra
Path Params
Response
A key-value pair that includes the following keys:
Response
Get Storage Option
Request
GET /api/2/infra/{infra_uuid}
Path Params
Response
A key-value pair that includes the following keys:
Response
List Storage Options
Request
GET /api/2/infra
Headers
Query Params
Response
A key-value pair that includes the following keys:
Response
Objects
Item
Item
Reports Management
List Tenant Reports
Request
GET /api/2/tenants/{tenant_id}/reports
Path Params
Response
A key-value pair that includes the following keys:
Response
Get Report
Retrieve information about a specific report.
Request
GET /api/2/reports/{report_id}
Path Params
Response
A key-value pair that includes the following keys:
Response
Update Scheduled Report
Request
PUT /api/2/reports/{report_id}
Path Params
JSON Body
Response
A key-value pair that includes the following keys:
Response
Delete Report
Request
DELETE /api/2/reports/{report_id}
Path Params
Objects
Parameter
Schedule
Parameter
Period
Search
Text Search
Request
GET /api/2/search
Query Params
Response
A key-value pair that includes the following keys:
Response
Objects
Item
Search Index Size Stats
Get Archive Search Size Statistics
Request
GET /api/vault_manager/v1/search_index_size_stats/{tenantId}
Path Params
Query Params
Stats
Get Archive Stats
Get data on past activity or usage.
Request
GET /api/vault_manager/v1/stats
Query Params
Response
A key-value pair that includes the following keys:
Response
Objects
Link
Storage Dirs
Get Storage Folders
Get all folders stored in storage.
Request
GET /api/vault_manager/v1/storage_dirs/{storageId}
Path Params
Query Params
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
Query Params
Storage Nodes
Get Registered Storage Nodes
Retrieve list of registered storage nodes in the network.
Request
GET /api/vault_manager/v1/storage_nodes
Headers
Storage Usage Stats
Get Storage Usage Stats
Retrieve data about storage space utilization.
Request
GET /api/vault_manager/v1/storage_usage_stats
Headers
Response
A key-value pair that includes the following keys:
Response
Objects
Item
Sync
Get Archives Sync Info
Retrieve synchronization data related to archives.
Request
GET /api/vault_manager/v1/sync/archives
Query Params
Response
A key-value pair that includes the following keys:
Response
Get Backups Sync Info
Retrieve Information on Backup Synchronization.
Request
GET /api/vault_manager/v1/sync/backups
Query Params
Response
A key-value pair that includes the following keys:
Response
List Vault Sync Information
Get synchronization information for Vaults.
Request
GET /api/vault_manager/v1/sync/vaults
Query Params
Response
A key-value pair that includes the following keys:
Response
Objects
Item
Item
Link
Tasks
List Tasks
Retrieve a customized list of tasks.
Request
GET /api/task_manager/v2/tasks
Query Params
Response
A key-value pair that includes the following keys:
Response
Objects
Item
Context
Executor
Issuer
Policy
Progress
Resource
Result
Tenant
Runtime
Payload
Tenants
Get Tenant
Request
GET /api/2/tenants/{tenant_id}
Path Params
Query Params
Response
A key-value pair that includes the following keys:
Response
List Tenants
Request
GET /api/2/tenants
Query Params
Response
A key-value pair that includes the following keys:
Response
List User Roles By Tenant
Request
GET /api/2/tenants/{tenant_id}/applications/roles
Path Params
Response
A key-value pair that includes the following keys:
Response
List Tenant Children
Request
GET /api/2/tenants/{tenant_id}/children
Path Params
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
Response
A key-value pair that includes the following keys:
Response
List Tenant Client UUIDs
Retrieves UUIDs of Clients For A Tenant
Request
GET /api/2/tenants/{tenant_id}/clients
Path Params
Response
A key-value pair that includes the following keys:
Response
Get Tenant MFA Status
Request
GET /api/2/tenants/{tenant_id}/mfa/status
Path Params
Response
A key-value pair that includes the following keys:
Response
Get Tenant's Brand Information
Request
GET /api/2/tenants/{tenant_id}/brand
Path Params
Response
A key-value pair that includes the following keys:
Response
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
Get Tenant Logo
Retrieve Tenant Brand Logo Image
Request
GET /api/2/tenants/{tenant_id}/brand/logo
Path Params
Create Tenant
Create a new partner tenant
Request
POST /api/2/tenants
JSON Body
Update Tenant
Updates a new partner tenant's fields
Request
PUT /api/2/tenants/{tenant_id}
Path Params
JSON Body
Enable MFA For Tenant
Enable two-factor authentication for user's partner account.
Request
PUT /api/2/tenants/{tenant_id}/mfa/status
Path Params
JSON Body
Response
A key-value pair that includes the following keys:
Response
Delete Tenant
Remove a partner's associated tenant from database.
Request
DELETE /api/2/tenants/{tenant_id}
Path Params
Get Tenant Pricing
Request
GET /api/2/tenants/{tenant_id}/pricing
Path Params
Response
A key-value pair that includes the following keys:
Response
Update Tenant Pricing
Request
PUT /api/2/tenants/{tenant_id}/pricing
Path Params
JSON Body
Response
A key-value pair that includes the following keys:
Response
List Subtenants
Request
GET /api/2/tenants/{tenant_id}
Path Params
Get A Tenant Usage
Retrieve data on a tenant's resource consumption.
Request
GET /api/2/tenants/{tenant_id}/usages
Path Params
Query Params
Response
A key-value pair that includes the following keys:
Response
Objects
Contact
Updatelock
Item
Item
Setting
Users
List Users
Request
GET /api/2/users
Query Params
Get User
Retrieve information about a specific user.
Request
GET /api/2/users/{user_id}
Path Params
Response
A key-value pair that includes the following keys:
Response
Create User
Request
POST /api/2/users
JSON Body
Update User
Request
PUT /api/2/users/{user_id}
Path Params
JSON Body
Delete A User
Remove user data permanently.
Request
DELETE /api/2/users/{user_id}
Path Params
Send Activation Email To User
Request
POST /api/2/users/{user_id}/send-activation-email
Path Params
List Tenant Application Roles
Request
GET /api/2/tenants/{tenant_id}/applications/roles
Path Params
JSON Body
Get A User's Access Policies
Retrieve authorized user roles.
Request
GET /api/2/users/{user_id}/access_policies
Path Params
Response
A key-value pair that includes the following keys:
Response
List Tenant's Offered Items
Request
GET /api/2/tenants/{tenant_id}/offering_items
Path Params
Query Params
Response
A key-value pair that includes the following keys:
Response
Update Tenant's Products
Request
PUT /api/2/tenants/{tenant_id}/offering_items
Path Params
JSON Body
Response
A key-value pair that includes the following keys:
Response
Objects
Contact
Contact
Item
Product
Quotum
Vaults
Retrieve users' stored items credentials from secure data repository.
Request
GET /api/vault_manager/v1/vaults
Query Params
Response
A key-value pair that includes the following keys:
Response
Create Or Attach Vault
Create or attach a secure storage vault.
Request
POST /api/vault_manager/v1/vaults
JSON Body
Get Vault
Retrieve secure data from protected storage.
Request
GET /api/vault_manager/v1/vaults/{vaultId}
Path Params
Query Params
Response
A key-value pair that includes the following keys:
Response
Delete Vault
Removes a secure storage container and its contents.
Request
DELETE /api/vault_manager/v1/vaults/{vault_id}
JSON Body
List Vault Archives
Retrieve stored data backups from Vault.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/archives
Path Params
Query Params
Response
A key-value pair that includes the following keys:
Response
Get Vault Archive Backup
Retrieve backups of Vault archive.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/archives/{archiveId}/backups/{backupId}
Path Params
Query Params
Response
A key-value pair that includes the following keys:
Response
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
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
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
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
List Timestamps Of Backups For Vault Archive
Request
GET /api/vault_manager/v1/vaults/{vaultId}/archives/{archiveId}/backup_timestamps
Path Params
Query Params
Response
A key-value pair that includes the following keys:
Response
List Vault Archive Backups
Retrieve archives of Vault backups.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/archives/{archiveId}/backups
Path Params
Query Params
Response
A key-value pair that includes the following keys:
Response
Get Vault Configuration
Retrieve configuration settings for Vault.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/config
Path Params
Response
A key-value pair that includes the following keys:
Response
Get Vault Statistics
Retrieve usage data for your Vault storage.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/stats
Path Params
Response
A key-value pair that includes the following keys:
Response
Get Vault Agents
Retrieve information about deployed Vault Agents.
Request
GET /api/vault_manager/v1/vaults/{vaultId}/agents
Path Params
Objects
Link
Item
Config
Link
Setting
Status
Attribute
Disk
Storagesetting
Volume
Last updated
