Acronis
App · 25 actions
Manage Acronis Cyber Protect Cloud: create and update customer tenants and users, check usage, follow backups and other tasks, read and dismiss alerts, see workloads' protection status, and apply or run protection plans. Start workflows on new alerts, finished tasks, and new tenants, users or workloads.
Actions
| Action | What it does |
|---|---|
| Apply protection plan | Apply a protection plan to workloads, so they are backed up and protected on its schedule. |
| Create tenant | Create a customer, partner, folder or unit under a tenant. |
| Create user | Create a user account in a tenant, give it a role and, if you choose, email them a link to activate it. |
| Delete tenant | Disable and permanently delete a tenant, with every tenant and user under it and all their backups and data. |
| Delete user | Disable and permanently delete a user account and all its data. |
| Dismiss alert | Dismiss an alert, as the console's Dismiss button does, once the problem is handled. |
| Find tenants and users | Find tenants and users by name, login, email or external id, anywhere under a tenant. |
| Get alert | Get one alert, dismissed or not: its severity, details and tenant. |
| Get task | Get one task: its state, result, workload, plan and times. |
| Get tenant | Get a tenant (a partner, folder, customer or unit): its name, kind, status, contact and pricing mode. |
| Get tenant usage | Get how much of each service a tenant uses, such as backup storage, workloads or seats. |
| Get user | Get a user account: login, contact, whether it is enabled and activated, and its two-factor status. |
| List activities | List activities, newest first: the steps tasks are made of, as the console's Activities tab shows them. |
| List alerts | List alerts, newest first, such as failed backups or malware found. |
| List protection plans | List protection plans with what each does (backup, antivirus, patching and the rest) and whether it is enabled. |
| List protection status | List workloads with their protection status (protected, running, warning, error, not protected) and when each plan last ran and last succeeded. |
| List tasks | List tasks, newest first: backups, restores and the other jobs Acronis runs, with how each ended. |
| List tenants | List the tenants directly under a tenant: your customers, partners, folders or a customer's units. |
| List users | List a tenant's user accounts, up to 100 at a time. |
| List workloads | List the workloads Acronis knows: machines, virtual machines, mailboxes and the rest, optionally only one tenant's, one type or those with no protection plan. |
| Revoke protection plan | Take a protection plan off workloads. |
| Run protection plan now | Start a protection plan now, outside its schedule, such as a backup before a change. |
| Send activation email | Email a user a new link to set their password and activate their account. |
| Update tenant | Rename a tenant, enable or disable it, or change its contact, external id or internal tag. |
| Update user | Change a user's name or phone number, or enable or disable their account. |
Apply protection plan
Apply a protection plan to workloads, so they are backed up and protected on its schedule. The workloads need the service quota the plan uses.
Inputs
- Protection plan
plan_idtextRequired - The protection plan. Pick one, or give its id from an earlier step.
- Workloads
resource_idslistRequired - The workloads to protect with it.
Outputs
issueslist- Problems Acronis reported, if any
plan_idtext- The protection plan
resource_idslist- The workloads
Example output
{
"issues": [],
"plan_id": "dac6c7c4-6b3f-4b46-9aa8-b78a189a0f10",
"resource_ids": [
"5c350066-2ba6-4eeb-aa91-1213dd35f033"
]
}Create tenant
Create a customer, partner, folder or unit under a tenant. It starts in trial mode with no services turned on; set its services and quotas in the Management Portal.
Inputs
- Name
nametextRequired - The tenant's name, such as the customer's company.
- Kind
tenant_kindtext - What it is. Defaults to Customer.One of:
customer,partner,folder,unit(Unit (inside a customer)). - Under tenant
parent_tenant_idtext - Create it under this tenant. Leave empty for the tenant your API client belongs to.
- Contact email
contact_emailtext - The contact's email address.
- Contact first name
first_nametext - The contact's first name.
- Contact last name
last_nametext - The contact's last name.
- Contact phone
phonetext - The contact's phone number.
- External id
external_idtext - Its id in another system, such as your CRM or PSA, for reports.
- Internal tag
internal_tagtext - A tag only you see, to group tenants.
Outputs
tenantobject- The tenant
Example output
{
"tenant": {
"contact": {
"email": "johndoe@example.com",
"firstname": "John",
"lastname": "Doe",
"phone": ""
},
"created_at": "2026-11-02T09:14:00+00:00",
"customer_id": "CRM-1042",
"enabled": true,
"has_children": false,
"id": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7",
"internal_tag": "",
"kind": "customer",
"name": "Example Customer",
"parent_id": "ede9f834-70b3-476c-83d9-736f9f8c7dae",
"pricing_mode": "trial",
"updated_at": "2026-11-02T09:14:00+00:00",
"version": 3
}
}Create user
Create a user account in a tenant, give it a role and, if you choose, email them a link to activate it. A user with no role can't use any service.
Inputs
- Tenant
tenant_idtextRequired - The tenant to create them in. Pick one, or give its id.
- Login
logintextRequired - The name they sign in with, at least 3 characters. An email address works.
- Email
emailtextRequired - Their email address, where the activation link goes.
- First name
first_nametext - Their first name.
- Last name
last_nametext - Their last name.
- Phone
phonetext - Their phone number.
- Role
roletext - What they can do. A partner administrator only fits a partner tenant, a company administrator a customer.One of:
backup_user(User (protects their own devices)),company_admin(Company administrator),unit_admin(Unit administrator),partner_admin(Partner administrator),readonly_admin(Read-only administrator),restore_operator(Restore operator). - Send activation email
send_activation_emailtrue/false - Email them a link to set a password and activate it.
Outputs
activation_email_senttrue/false- Whether the activation email was sent
roletext- The role given, if any
userobject- The new user
Example output
{
"activation_email_sent": true,
"role": "company_admin",
"user": {
"activated": false,
"contact": {
"email": "johndoe@example.com",
"firstname": "John",
"lastname": "Doe",
"phone": ""
},
"created_at": "2026-11-02T09:20:00+00:00",
"enabled": true,
"id": "1c234e69-5469-424a-a6d1-ff5658b387a6",
"language": "en",
"login": "JohnDoe",
"mfa_status": "disabled",
"personal_tenant_id": "e18a5b6f-5ba4-44b0-8b41-2a4c2b1fd5a3",
"tenant_id": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7",
"updated_at": "2026-11-02T09:20:00+00:00",
"version": 1
}
}Delete tenant
Disable and permanently delete a tenant, with every tenant and user under it and all their backups and data. This can't be undone.
Inputs
- Tenant
tenant_idtextRequired - The tenant to delete. Pick one, or give its id.
Outputs
deletedtrue/false- True once deleted
tenant_idtext- The tenant deleted
Example output
{
"deleted": true,
"tenant_id": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7"
}Delete user
Disable and permanently delete a user account and all its data. This can't be undone.
Inputs
- User
acronis_user_idtextRequired - The user. Pick one, or give their id from an earlier step.
Outputs
deletedtrue/false- True once deleted
user_idtext- The user deleted
Example output
{
"deleted": true,
"user_id": "1c234e69-5469-424a-a6d1-ff5658b387a6"
}Dismiss alert
Dismiss an alert, as the console's Dismiss button does, once the problem is handled.
Inputs
- Alert id
alert_idtextRequired - The alert's id, from 'List alerts' or a trigger.
Outputs
alert_idtext- The alert dismissed
dismissedtrue/false- True once dismissed
Example output
{
"alert_id": "887E19F7-59F5-44DC-9721-64B1C48B4117",
"dismissed": true
}Find tenants and users
Find tenants and users by name, login, email or external id, anywhere under a tenant.
Inputs
- Search for
texttextRequired - The words to look for.
- Tenant
tenant_idtext - Look under this tenant. Leave empty for the tenant your API client belongs to.
- At most
limitnumber - At most this many results.From 1 to 1000.
Outputs
countnumber- How many were returned
resultslist- What was found
Example output
{
"count": 1,
"results": [
{
"first_name": "John",
"id": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7",
"kind": "customer",
"last_name": "Doe",
"login": "",
"name": "Example Customer",
"obj_type": "tenant",
"parent_id": "ede9f834-70b3-476c-83d9-736f9f8c7dae",
"path": [
"Example Partner"
]
}
]
}Get alert
Get one alert, dismissed or not: its severity, details and tenant.
Inputs
- Alert id
alert_idtextRequired - The alert's id, from 'List alerts' or a trigger.
Outputs
alertobject- The alert
Example output
{
"alert": {
"category": "Backup",
"createdAt": "2026-11-12T23:14:41Z",
"deletedAt": "",
"details": {
"category": "Backup",
"description": "Backup of DESKTOP-JRPTA4A failed.",
"title": "Backup failed"
},
"id": "887E19F7-59F5-44DC-9721-64B1C48B4117",
"receivedAt": "2026-11-12T23:14:42Z",
"severity": "error",
"tenant": {
"id": "286",
"locator": "/1/281/282/285/286/",
"uuid": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7"
},
"type": "BackupFailed",
"updatedAt": "2026-11-12T23:14:42Z"
}
}Get task
Get one task: its state, result, workload, plan and times.
Inputs
- Task number
task_idtextRequired - The task's number ('id'), from 'List tasks' or a trigger.
Outputs
taskobject- The task
Example output
{
"task": {
"completedAt": "2026-11-12T23:14:41Z",
"enqueuedAt": "2026-11-12T23:00:00Z",
"id": 944455285181775872,
"policy": {
"id": "dac6c7c4-6b3f-4b46-9aa8-b78a189a0f10",
"name": "New protection plan",
"type": "policy.protection.total"
},
"resource": {
"id": "5c350066-2ba6-4eeb-aa91-1213dd35f033",
"name": "DESKTOP-JRPTA4A",
"type": "resource.machine"
},
"result": {
"code": "ok"
},
"startedAt": "2026-11-12T23:00:03Z",
"startedByUser": "Scheduler",
"state": "completed",
"tenant": {
"id": "1496265",
"name": "Example Customer",
"uuid": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7"
},
"type": "backup",
"updatedAt": "2026-11-12T23:14:41Z",
"uuid": "38045860-8901-426e-b51f-fc6d24d1cbe0"
}
}Get tenant
Get a tenant (a partner, folder, customer or unit): its name, kind, status, contact and pricing mode. Leave the tenant empty for the one your API client belongs to.
Inputs
- Tenant
tenant_idtext - The tenant. Pick one, or give its id from an earlier step. Leave empty for the tenant your API client belongs to.
Outputs
tenantobject- The tenant
Example output
{
"tenant": {
"contact": {
"email": "johndoe@example.com",
"firstname": "John",
"lastname": "Doe",
"phone": ""
},
"created_at": "2026-11-02T09:14:00+00:00",
"customer_id": "CRM-1042",
"enabled": true,
"has_children": false,
"id": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7",
"internal_tag": "",
"kind": "customer",
"name": "Example Customer",
"parent_id": "ede9f834-70b3-476c-83d9-736f9f8c7dae",
"pricing_mode": "trial",
"updated_at": "2026-11-02T09:14:00+00:00",
"version": 3
}
}Get tenant usage
Get how much of each service a tenant uses, such as backup storage, workloads or seats. Acronis updates it about every half hour, so don't bill from it.
Inputs
- Tenant
tenant_idtext - The tenant. Pick one, or give its id from an earlier step. Leave empty for the tenant your API client belongs to.
- Only these usages
usage_namestext - Usage names to return, separated by commas, such as storage,local_storage. Leave empty for all.
Outputs
countnumber- How many were returned
tenant_idtext- The tenant
usageslist- Each service's usage
Example output
{
"count": 1,
"tenant_id": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7",
"usages": [
{
"application_id": "6e6d758d-8e74-3ae3-ac84-50eb0dff12eb",
"edition": "standard",
"measurement_unit": "bytes",
"name": "storage",
"range_start": "2026-11-01T00:00:00+00:00",
"type": "infra",
"usage_name": "storage",
"value": 1073741824
}
]
}Get user
Get a user account: login, contact, whether it is enabled and activated, and its two-factor status.
Inputs
- User
acronis_user_idtextRequired - The user. Pick one, or give their id from an earlier step.
Outputs
userobject- The user
Example output
{
"user": {
"activated": false,
"contact": {
"email": "johndoe@example.com",
"firstname": "John",
"lastname": "Doe",
"phone": ""
},
"created_at": "2026-11-02T09:20:00+00:00",
"enabled": true,
"id": "1c234e69-5469-424a-a6d1-ff5658b387a6",
"language": "en",
"login": "JohnDoe",
"mfa_status": "disabled",
"personal_tenant_id": "e18a5b6f-5ba4-44b0-8b41-2a4c2b1fd5a3",
"tenant_id": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7",
"updated_at": "2026-11-02T09:20:00+00:00",
"version": 1
}
}List activities
List activities, newest first: the steps tasks are made of, as the console's Activities tab shows them. Filter by task, state, result, workload, plan or when they finished.
Inputs
- Task number
task_idtext - Only this task's activities.
- State
statetext - Only activities in this state.One of:
enqueued(Waiting to start),assigned,started(Running),paused,completed(Finished). - Result
resulttext - Only finished activities that ended this way.One of:
ok(Succeeded),warning(Succeeded with warnings),error(Failed),cancelled,abandoned,timedout(Timed out). - Workload
resource_idtext - Only this workload (a machine, mailbox or other protected resource). Pick one, or give its id.
- Protection plan
plan_idtext - Only activities this protection plan started.
- Finished after
finished_afterdate and time - Only activities that finished after this time.
- How many
page_sizenumber - How many to return, newest first, 1 to 1,000. Defaults to 50.From 1 to 1000.
Outputs
activitieslist- The activities
countnumber- How many were returned
Example output
{
"activities": [
{
"completedAt": "2026-11-12T23:14:40Z",
"createdAt": "2026-11-12T23:00:03Z",
"id": 944455285181775873,
"policy": {
"id": "dac6c7c4-6b3f-4b46-9aa8-b78a189a0f10",
"name": "New protection plan",
"type": "policy.protection.total"
},
"resource": {
"id": "5c350066-2ba6-4eeb-aa91-1213dd35f033",
"name": "DESKTOP-JRPTA4A",
"type": "resource.machine"
},
"result": {
"code": "ok"
},
"startedAt": "2026-11-12T23:00:03Z",
"state": "completed",
"taskId": 944455285181775872,
"tenant": {
"id": "1496265",
"name": "Example Customer",
"uuid": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7"
},
"type": "backup",
"uuid": "9b3f5f2e-58a1-4d0b-8d55-0a0c8f6a3c11"
}
],
"count": 1
}List alerts
List alerts, newest first, such as failed backups or malware found. Filter by severity, category, words in the plan or workload name, or when they were raised.
Inputs
- Severity
severitytext - Only alerts this severe or worse.One of:
information(Information and worse),warning(Warning and worse),error(Error and worse),critical(Critical only). - Category
categorytext - Only alerts in this category, such as Backup.
- Plan or workload name contains
search_texttext - Only alerts whose plan or workload name has these words.
- Raised after
created_afterdate and time - Only alerts raised after this time.
- Include dismissed
include_dismissedtrue/false - Also list alerts that were dismissed.
- How many
page_sizenumber - How many to return, 1 to 1,000. Defaults to 50.From 1 to 1000.
Outputs
alertslist- The alerts
countnumber- How many were returned
Example output
{
"alerts": [
{
"category": "Backup",
"createdAt": "2026-11-12T23:14:41Z",
"deletedAt": "",
"details": {
"category": "Backup",
"description": "Backup of DESKTOP-JRPTA4A failed.",
"title": "Backup failed"
},
"id": "887E19F7-59F5-44DC-9721-64B1C48B4117",
"receivedAt": "2026-11-12T23:14:42Z",
"severity": "error",
"tenant": {
"id": "286",
"locator": "/1/281/282/285/286/",
"uuid": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7"
},
"type": "BackupFailed",
"updatedAt": "2026-11-12T23:14:42Z"
}
],
"count": 1
}List protection plans
List protection plans with what each does (backup, antivirus, patching and the rest) and whether it is enabled.
Inputs
- Tenant
tenant_idtext - Only this tenant's plans. Leave empty for every plan the API client can see.
- Enabled only
enabled_onlytrue/false - Only plans that are enabled.
- How many
page_sizenumber - How many to return, 1 to 1,000. Defaults to 50.From 1 to 1000.
- Next page
pagetext - The 'next_page' from an earlier run of this step, to get the page after it.
Outputs
countnumber- How many are on this page
next_pagetext- Give this as 'Next page' to get the next page; empty on the last page
planslist- The protection plans
totalnumber- How many there are in all
Example output
{
"count": 1,
"next_page": "",
"plans": [
{
"created_at": "2026-10-07T08:41:38Z",
"enabled": true,
"id": "dac6c7c4-6b3f-4b46-9aa8-b78a189a0f10",
"name": "New protection plan",
"parts": [
{
"enabled": true,
"id": "4d7d580c-32ac-468e-9688-e74906f5d765",
"type": "policy.backup.machine"
}
],
"tenant_id": "16",
"type": "policy.protection.total",
"updated_at": "2026-10-07T08:41:38Z"
}
],
"total": 1
}List protection status
List workloads with their protection status (protected, running, warning, error, not protected) and when each plan last ran and last succeeded.
Inputs
- Tenant
tenant_idtext - Only this tenant's workloads. Leave empty for every workload the API client can see.
- Workload
resource_idtext - Only this workload (a machine, mailbox or other protected resource). Pick one, or give its id.
- Workload type
resource_typetext - Only workloads of this type, such as resource.machine or resource.virtual_machine.mshyperv.
- How many
page_sizenumber - How many to return, 1 to 1,000. Defaults to 50.From 1 to 1000.
- Next page
pagetext - The 'next_page' from an earlier run of this step, to get the page after it.
Outputs
countnumber- How many are on this page
next_pagetext- Give this as 'Next page' to get the next page; empty on the last page
statuseslist- Each workload's status
totalnumber- How many there are in all
Example output
{
"count": 1,
"next_page": "",
"statuses": [
{
"aggregate": {
"names": "New protection plan",
"status": "idle"
},
"context": {
"agent_id": "f7358a00-8469-45ae-a0c3-22952e9ed12f",
"created_at": "2026-02-03T14:57:07Z",
"id": "5c350066-2ba6-4eeb-aa91-1213dd35f033",
"name": "DESKTOP-JRPTA4A",
"tenant_id": "17",
"type": "resource.machine",
"updated_at": "2026-11-04T07:19:51Z",
"user_defined_name": "DESKTOP-JRPTA4A"
},
"policies": [
{
"last_run_time": "2026-11-12T23:00:03Z",
"last_success_run_time": "2026-11-12T23:14:41Z",
"next_run_time": "2026-11-13T23:00:00Z",
"type": "policy.backup.machine"
}
],
"resource_name": "DESKTOP-JRPTA4A",
"status": "idle"
}
],
"total": 1
}List tasks
List tasks, newest first: backups, restores and the other jobs Acronis runs, with how each ended. Filter by state, result, workload, plan or when they finished.
Inputs
- State
statetext - Only tasks in this state.One of:
enqueued(Waiting to start),assigned,started(Running),paused,completed(Finished). - Result
resulttext - Only finished tasks that ended this way.One of:
ok(Succeeded),warning(Succeeded with warnings),error(Failed),cancelled,abandoned,timedout(Timed out). - Workload
resource_idtext - Only this workload (a machine, mailbox or other protected resource). Pick one, or give its id.
- Protection plan
plan_idtext - Only tasks this protection plan started.
- Finished after
finished_afterdate and time - Only tasks that finished after this time.
- How many
page_sizenumber - How many to return, newest first, 1 to 1,000. Defaults to 50.From 1 to 1000.
Outputs
countnumber- How many were returned
taskslist- The tasks
Example output
{
"count": 1,
"tasks": [
{
"completedAt": "2026-11-12T23:14:41Z",
"enqueuedAt": "2026-11-12T23:00:00Z",
"id": 944455285181775872,
"policy": {
"id": "dac6c7c4-6b3f-4b46-9aa8-b78a189a0f10",
"name": "New protection plan",
"type": "policy.protection.total"
},
"resource": {
"id": "5c350066-2ba6-4eeb-aa91-1213dd35f033",
"name": "DESKTOP-JRPTA4A",
"type": "resource.machine"
},
"result": {
"code": "ok"
},
"startedAt": "2026-11-12T23:00:03Z",
"startedByUser": "Scheduler",
"state": "completed",
"tenant": {
"id": "1496265",
"name": "Example Customer",
"uuid": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7"
},
"type": "backup",
"updatedAt": "2026-11-12T23:14:41Z",
"uuid": "38045860-8901-426e-b51f-fc6d24d1cbe0"
}
]
}List tenants
List the tenants directly under a tenant: your customers, partners, folders or a customer's units. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Under tenant
parent_tenant_idtext - List the tenants under this one. Leave empty for the tenant your API client belongs to.
- How many
page_sizenumber - How many to return, 1 to 1,000. Defaults to 50.From 1 to 1000.
- Next page
pagetext - The 'next_page' from an earlier run of this step, to get the page after it.
Outputs
countnumber- How many are on this page
next_pagetext- Give this as 'Next page' to get the next page; empty on the last page
parent_tenant_idtext- The tenant they are under
tenantslist- The tenants
totalnumber- How many there are in all
Example output
{
"count": 1,
"next_page": "",
"parent_tenant_id": "ede9f834-70b3-476c-83d9-736f9f8c7dae",
"tenants": [
{
"contact": {
"email": "johndoe@example.com",
"firstname": "John",
"lastname": "Doe",
"phone": ""
},
"created_at": "2026-11-02T09:14:00+00:00",
"customer_id": "CRM-1042",
"enabled": true,
"has_children": false,
"id": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7",
"internal_tag": "",
"kind": "customer",
"name": "Example Customer",
"parent_id": "ede9f834-70b3-476c-83d9-736f9f8c7dae",
"pricing_mode": "trial",
"updated_at": "2026-11-02T09:14:00+00:00",
"version": 3
}
],
"total": 1
}List users
List a tenant's user accounts, up to 100 at a time. To see more, run it again with the next offset it gives.
Inputs
- Tenant
tenant_idtext - The tenant. Pick one, or give its id from an earlier step. Leave empty for the tenant your API client belongs to.
- How many
page_sizenumber - How many to return, 1 to 100. Defaults to 50.From 1 to 100.
- Skip
offsetnumber - Skip this many users first: the 'next_offset' from an earlier run of this step.At least 0.
Outputs
countnumber- How many are on this page
next_offsetnumber- Give this as 'Skip' to get the next page; 0 on the last page
totalnumber- How many users the tenant has
userslist- The users
Example output
{
"count": 1,
"next_offset": 0,
"total": 1,
"users": [
{
"activated": false,
"contact": {
"email": "johndoe@example.com",
"firstname": "John",
"lastname": "Doe",
"phone": ""
},
"created_at": "2026-11-02T09:20:00+00:00",
"enabled": true,
"id": "1c234e69-5469-424a-a6d1-ff5658b387a6",
"language": "en",
"login": "JohnDoe",
"mfa_status": "disabled",
"personal_tenant_id": "e18a5b6f-5ba4-44b0-8b41-2a4c2b1fd5a3",
"tenant_id": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7",
"updated_at": "2026-11-02T09:20:00+00:00",
"version": 1
}
]
}List workloads
List the workloads Acronis knows: machines, virtual machines, mailboxes and the rest, optionally only one tenant's, one type or those with no protection plan.
Inputs
- Tenant
tenant_idtext - Only this tenant's workloads. Leave empty for every workload the API client can see.
- Workload type
resource_typetext - Only workloads of this type, such as resource.machine or resource.virtual_machine.mshyperv.
- Unprotected only
unprotected_onlytrue/false - Only workloads with no protection plan applied.
- How many
page_sizenumber - How many to return, 1 to 1,000. Defaults to 50.From 1 to 1000.
- Next page
pagetext - The 'next_page' from an earlier run of this step, to get the page after it.
Outputs
countnumber- How many are on this page
next_pagetext- Give this as 'Next page' to get the next page; empty on the last page
resourceslist- The workloads
totalnumber- How many there are in all
Example output
{
"count": 1,
"next_page": "",
"resources": [
{
"agent_id": "f7358a00-8469-45ae-a0c3-22952e9ed12f",
"created_at": "2026-02-03T14:57:07Z",
"id": "5c350066-2ba6-4eeb-aa91-1213dd35f033",
"name": "DESKTOP-JRPTA4A",
"tenant_id": "17",
"type": "resource.machine",
"updated_at": "2026-11-04T07:19:51Z",
"user_defined_name": "DESKTOP-JRPTA4A"
}
],
"total": 1
}Revoke protection plan
Take a protection plan off workloads. Their existing backups stay.
Inputs
- Protection plan
plan_idtextRequired - The protection plan. Pick one, or give its id from an earlier step.
- Workloads
resource_idslistRequired - The workloads to take it off.
Outputs
issueslist- Problems Acronis reported, if any
plan_idtext- The protection plan
resource_idslist- The workloads
Example output
{
"issues": [],
"plan_id": "dac6c7c4-6b3f-4b46-9aa8-b78a189a0f10",
"resource_ids": [
"5c350066-2ba6-4eeb-aa91-1213dd35f033"
]
}Run protection plan now
Start a protection plan now, outside its schedule, such as a backup before a change. Follow it with 'List tasks'.
Inputs
- Protection plan
plan_idtextRequired - The protection plan. Pick one, or give its id from an earlier step.
- Workloads
resource_idslist - Only on these workloads. Leave empty for every workload the plan is applied to.
Outputs
plan_idtext- The protection plan
resource_idslist- The workloads, if any were named
startedtrue/false- True once Acronis accepted it
Example output
{
"plan_id": "dac6c7c4-6b3f-4b46-9aa8-b78a189a0f10",
"resource_ids": [
"5c350066-2ba6-4eeb-aa91-1213dd35f033"
],
"started": true
}Send activation email
Email a user a new link to set their password and activate their account.
Inputs
- User
acronis_user_idtextRequired - The user. Pick one, or give their id from an earlier step.
Outputs
senttrue/false- True once sent
user_idtext- The user it was sent to
Example output
{
"sent": true,
"user_id": "1c234e69-5469-424a-a6d1-ff5658b387a6"
}Update tenant
Rename a tenant, enable or disable it, or change its contact, external id or internal tag. Fields left empty keep their value. Disabling a tenant stops its services and sign-ins.
Inputs
- Tenant
tenant_idtextRequired - The tenant to change. Pick one, or give its id.
- Name
nametext - A new name. Leave empty to keep it.
- Status
statustext - Enable or disable it. Leave empty to keep it as it is.One of:
enable,disable. - Contact email
contact_emailtext - A new contact email address.
- Contact first name
first_nametext - The contact's first name.
- Contact last name
last_nametext - The contact's last name.
- Contact phone
phonetext - The contact's phone number.
- External id
external_idtext - Its id in another system, such as your CRM or PSA, for reports.
- Internal tag
internal_tagtext - A tag only you see, to group tenants.
Outputs
tenantobject- The tenant
Example output
{
"tenant": {
"contact": {
"email": "johndoe@example.com",
"firstname": "John",
"lastname": "Doe",
"phone": ""
},
"created_at": "2026-11-02T09:14:00+00:00",
"customer_id": "CRM-1042",
"enabled": true,
"has_children": false,
"id": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7",
"internal_tag": "",
"kind": "customer",
"name": "Example Customer",
"parent_id": "ede9f834-70b3-476c-83d9-736f9f8c7dae",
"pricing_mode": "trial",
"updated_at": "2026-11-02T09:14:00+00:00",
"version": 3
}
}Update user
Change a user's name or phone number, or enable or disable their account. Fields left empty keep their value.
Inputs
- User
acronis_user_idtextRequired - The user. Pick one, or give their id from an earlier step.
- First name
first_nametext - A new first name.
- Last name
last_nametext - A new last name.
- Phone
phonetext - A new phone number.
- Status
statustext - Enable or disable it. Leave empty to keep it as it is.One of:
enable,disable.
Outputs
userobject- The user
Example output
{
"user": {
"activated": false,
"contact": {
"email": "johndoe@example.com",
"firstname": "John",
"lastname": "Doe",
"phone": ""
},
"created_at": "2026-11-02T09:20:00+00:00",
"enabled": true,
"id": "1c234e69-5469-424a-a6d1-ff5658b387a6",
"language": "en",
"login": "JohnDoe",
"mfa_status": "disabled",
"personal_tenant_id": "e18a5b6f-5ba4-44b0-8b41-2a4c2b1fd5a3",
"tenant_id": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7",
"updated_at": "2026-11-02T09:20:00+00:00",
"version": 1
}
}