Acronis Integration Setup

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

This Integration supports multiple instances

Check out the instructions to set up multiple instances here.

Setup

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

  1. Log in to the management portal.

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

  3. Enter a name for the API client.

  4. Click Next.

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

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

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

Having issues? Review Acronis' Documentation Here.

Actions

Abgw Storages

Unregister Storage​

Removes registered storage from a user's account.

Request​

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

Path Params​

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​

ordereddict([('label', 'Headers'), ('description', 'Custom HTTP headers to be sent with the request')])

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​

Request​

GET /api/2/users/{user_id}/legal_documents

Path Params​

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​

Request​

GET /api/2/search

Query Params​

Response​

A key-value pair that includes the following keys:

Response​


Objects​

Item​