Skip to main content
Tools Reference

Acronis Cyber Protect Cloud Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Acronis Cyber Protect Cloud Tools

acronis_ · 272 tools · Free 136 · Pro 136 Acronis Cyber Protect Cloud spans twelve APIs behind one credential: alerts, backup tasks and activities, protection agents, protected resources and protection policies, endpoint detection and response, the tenant tree with its users, offering items, usage and pricing, vaults and archives and backups, disaster recovery with test and production failover, the platform event stream, price lists, and Acronis's own PSA and file-sync products. Tool names are prefixed acronis_ and the family word is part of the name wherever twelve sub-APIs would otherwise repeat a resource word. Authentication is an API client (a client id and secret) created in the Acronis console, and the data center URL Acronis issues alongside it is required — an account lives in exactly one data center with no access between them.

All connector tools · Acronis Cyber Protect Cloud setup guide

Acronis Cyber Protect Cloud tool groups

Alerts

ToolPlanAccessSummary
acronis_create_alertProWriteCreate an alert.
acronis_dismiss_alertProDestructiveDismiss an alert by ID.
acronis_dismiss_alerts_by_filterProDestructiveDismiss the alerts by filter.
acronis_get_alertFreeRead-onlyFetch an alert by ID.
acronis_get_alert_countersFreeRead-onlyFetch alert counters.
acronis_get_alert_resource_statusFreeRead-onlyFetch resources containing the highest severity alerts.
acronis_get_alert_typeFreeRead-onlyFetch an alert type by ID.
acronis_get_alert_vault_archive_statsFreeRead-onlyGet count of active alerts and last modification time.
acronis_get_alerts_by_scopeFreeRead-onlyFetch alerts grouped by scope.
acronis_get_customer_alerts_countFreeRead-onlyFetch partner's customer alerts count.
acronis_list_alert_categoriesFreeRead-onlyFetch categories.
acronis_list_alert_typesFreeRead-onlyFetch all alert types.
acronis_list_alertsFreeRead-onlyFetch all alerts.
acronis_list_customer_alertsFreeRead-onlyFetch alerts grouped per customer.
acronis_mark_alert_false_positiveProWriteMark alert as false positive.
acronis_register_alert_typeProWriteRegister new alert type.
acronis_unregister_alert_typeProDestructiveUnregister an alert type by ID.

[Acronis Cyber Protect Cloud] Create an alert. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Dismiss an alert by ID. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal). DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
idstringyesID of an alert.

[Acronis Cyber Protect Cloud] Dismiss the alerts by filter. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal). Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts show_deleted_only, source, source_time_stamp, type, updated_at, created_at, category, planId, resourceId, planName, resourceName here. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
deletedAtstringnonullA 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
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"show_deleted_only":"..."}. Acronis accepts show_deleted_only, source, source_time_stamp, type, updated_at, created_at, category, planId, resourceId, planName, resourceName on this endpoint.
idstringnonullCase-insensitive IDs of the alerts to return in the results.
querystringnonullA text to search for within `planName` or `resourceName` fields of the alerts. The search is case-insensitive.
severitystringnonullA filter by the alert severity. Available operators: * `eq` - equals to the specified value: eq(warning) * `or` - equals to one of the specified values: or(warning,critical) * `lt` - less than the specified value: lt(warning) * `gt` - greater than the specified value: gt(warning) * `le` - less than or equals to the specified value: le(warning) * `ge` - greater than or equals to the specified value: ge(warning)
showDeletedstringnonullIf true, dismissed alerts will be included in the response.

[Acronis Cyber Protect Cloud] Fetch an alert by ID. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal).

ParamTypeRequiredDefaultDescription
idstringyesID of an alert.
showDeletedstringnonullIf true, dismissed alerts will be included in the response.

[Acronis Cyber Protect Cloud] Fetch alert counters. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal).

ParamTypeRequiredDefaultDescription
embedCategoriesstringnonullIf true, alert counters will be grouped by alert categories. This parameter is mutually exclusive with the `embed_types` and `embed_severities` parameters.
embedSeveritiesstringnonullIf true, alert counters will be grouped by alert severities. When combined with `embed_types` alert counters will be grouped first by severities and then by types. This parameter is mutually exclusive with the `embed_categories` parameter.
embedTenantsstringnonullIf true, alert counters will be grouped by tenants.
embedTypesstringnonullIf true, alert counters will be grouped by alert types. When combined with `embed_severities` alert counters will be grouped first by severities and then by types. This parameter is mutually exclusive with the `embed_categories` parameter.

[Acronis Cyber Protect Cloud] Fetch resources containing the highest severity alerts. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal).

ParamTypeRequiredDefaultDescription
embedAlertstringnonullIf true, the entire alert object will be included in the response.
idstringnonullIDs of the resources; if omitted, the response will contain statuses for all resources that have alerts. For resources with multiple IDs, the client must specify resource's IDs by using the `or()` operator: * Example: `id=or(ID3,ID4,ID5)` - looks for status of a single resource * Example: `id=ID1&id=or(ID3,ID4,ID5)&id=or(ID6,ID7)&id=ID8` - looks for status of four resources

[Acronis Cyber Protect Cloud] Fetch an alert type by ID. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal).

ParamTypeRequiredDefaultDescription
idstringyesID of an alert type.

[Acronis Cyber Protect Cloud] Get count of active alerts and last modification time. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal).

[Acronis Cyber Protect Cloud] Fetch alerts grouped by scope. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal). Acronis REQUIRES scopeKey on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
scopeKeystringyesREQUIRED. Groups the results by the context key or searchable details. See registered alert types for available context keys and searchable details.
scopeValuestringnonullScope values to filter alerts by. If omitted, the response will contain the last most critical status among available alerts. Client may group statuses for multiple scope values by using the `or()` operator: * Example: `scope_key=KEY&scope_value=VAL1&scope_value=VAL2` - looks for two statuses * Example: `scope_key=KEY&scope_value=or(VAL1,VAL2)` - looks for single status * Example...

[Acronis Cyber Protect Cloud] Fetch partner's customer alerts count. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal). Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts show_deleted_only, source, source_time_stamp, type, updated_at, created_at, category, planId, resourceId, planName, resourceName here.

ParamTypeRequiredDefaultDescription
deletedAtstringnonullA 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
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"show_deleted_only":"..."}. Acronis accepts show_deleted_only, source, source_time_stamp, type, updated_at, created_at, category, planId, resourceId, planName, resourceName on this endpoint.
idstringnonullCase-insensitive IDs of the alerts to return in the results.
querystringnonullA text to search for within `planName` or `resourceName` fields of the alerts. The search is case-insensitive.
severitystringnonullA filter by the alert severity. Available operators: * `eq` - equals to the specified value: eq(warning) * `or` - equals to one of the specified values: or(warning,critical) * `lt` - less than the specified value: lt(warning) * `gt` - greater than the specified value: gt(warning) * `le` - less than or equals to the specified value: le(warning) * `ge` - greater than or equals to the specified...
showDeletedstringnonullIf true, dismissed alerts will be included in the response.

[Acronis Cyber Protect Cloud] Fetch categories. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal).

ParamTypeRequiredDefaultDescription
includeDisabledstringnonullIf true, both enabled and disabled categories are returned.

[Acronis Cyber Protect Cloud] Fetch all alert types. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal).

ParamTypeRequiredDefaultDescription
categorystringnonullA filter by list of type categories. A list of registered categories can be obtained by sending a GET request to the `/categories` endpoint. * Example: `category=Backup&category=Monitoring`
orderstringnonullAn ordering filter that orders the results by column name. If no operator provided, the column will be ordered in ascending order. Following columns can be used: * `id` * `severity` * `category` Available operators: * `asc` - ascending * `desc` - descending
osTypestringnonullA filter by the list of operating systems supported by the alert types.

[Acronis Cyber Protect Cloud] Fetch all alerts. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Pass limit to bound the result set (capped at 1000). Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts show_deleted, show_deleted_only, source, source_time_stamp, type, updated_at, created_at, category, planId, resourceId, planName, resourceName, order here.

ParamTypeRequiredDefaultDescription
deletedAtstringnonullA 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
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"show_deleted":"..."}. Acronis accepts show_deleted, show_deleted_only, source, source_time_stamp, type, updated_at, created_at, category, planId, resourceId, planName, resourceName, order on this endpoint.
idstringnonullCase-insensitive IDs of the alerts to return in the results.
limitintegerno100A limit on number of objects to be returned. Capped at 1000.
querystringnonullA text to search for within `planName` or `resourceName` fields of the alerts. The search is case-insensitive.
severitystringnonullA filter by the alert severity. Available operators: * `eq` - equals to the specified value: eq(warning) * `or` - equals to one of the specified values: or(warning,critical) * `lt` - less than the specified value: lt(warning) * `gt` - greater than the specified value: gt(warning) * `le` - less than or equals to the specified value: le(warning) * `ge` - greater than or equals to the specified...
skipstringnonullIDs of the alerts to exclude from the response.
tenantstringnonullA filter by the alert tenant ID.

[Acronis Cyber Protect Cloud] Fetch alerts grouped per customer. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal). Acronis REQUIRES customerId on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts show_deleted, show_deleted_only, source, source_time_stamp, type, updated_at, created_at, category, planId, resourceId, planName, resourceName here.

ParamTypeRequiredDefaultDescription
customerIdstringyesREQUIRED. IDs of the customers whose alerts must be returned.
deletedAtstringnonullA 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
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"show_deleted":"..."}. Acronis accepts show_deleted, show_deleted_only, source, source_time_stamp, type, updated_at, created_at, category, planId, resourceId, planName, resourceName on this endpoint.
idstringnonullCase-insensitive IDs of the alerts to return in the results.
querystringnonullA text to search for within `planName` or `resourceName` fields of the alerts. The search is case-insensitive.
severitystringnonullA filter by the alert severity. Available operators: * `eq` - equals to the specified value: eq(warning) * `or` - equals to one of the specified values: or(warning,critical) * `lt` - less than the specified value: lt(warning) * `gt` - greater than the specified value: gt(warning) * `le` - less than or equals to the specified value: le(warning) * `ge` - greater than or equals to the specified...

[Acronis Cyber Protect Cloud] Mark alert as false positive. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
idstringyesID of an alert.

[Acronis Cyber Protect Cloud] Register new alert type. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Unregister an alert type by ID. Served by the Alert Manager API (partner-wide and per-customer alert roll-ups, alert types and dismissal). DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
idstringyesID of an alert type.

Tasks and Activities

ToolPlanAccessSummary
acronis_get_activityFreeRead-onlyFetch an activity.
acronis_get_taskFreeRead-onlyFetch a task.
acronis_list_activitiesFreeRead-onlyFetch a list of activities.
acronis_list_tasksFreeRead-onlyFetch a list of tasks.

[Acronis Cyber Protect Cloud] Fetch an activity. Served by the Task Management API (backup tasks and activities, which is how you answer "did last night's backup run and did it succeed").

ParamTypeRequiredDefaultDescription
activityIdstringyesThe Acronis activity-id.
allowDeletedstringnonullIf true, allows to work with deleted entities.
lodstringnonullThe Acronis lod query parameter.

[Acronis Cyber Protect Cloud] Fetch a task. Served by the Task Management API (backup tasks and activities, which is how you answer "did last night's backup run and did it succeed").

ParamTypeRequiredDefaultDescription
allowDeletedstringnonullIf true, allows to work with deleted entities.
lodstringnonullThe Acronis lod query parameter.
taskIdstringyesThe Acronis task-id.

[Acronis Cyber Protect Cloud] Fetch a list of activities. Served by the Task Management API (backup tasks and activities, which is how you answer "did last night's backup run and did it succeed"). Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts startedBy, policyId, policyName, policyType, resourceId, resourceName, resourceType, taskId, workflowId, parentActivityId, state, resultCode, createdAt, startedAt, and more here.

ParamTypeRequiredDefaultDescription
afterstringnonullThe page token with the next page of the results. Can be used only with the `limit` query string parameter.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"startedBy":"..."}. Acronis accepts startedBy, policyId, policyName, policyType, resourceId, resourceName, resourceType, taskId, workflowId, parentActivityId, state, resultCode, createdAt, startedAt on this endpoint.
idstringnonullAn ID filter. Multiple entries are accepted.
limitintegerno100A number of activities to return in one page. This parameter restricts usage of the query string parameters to `after`. Capped at 1000.
lodstringnonullThe Acronis lod query parameter.
orderstringnonullAn ordering filter (position-dependent). Available ordering operators are: - `asc(field)` - ascending order - `desc(field)` - descending order Where "field" is one of the following values: `id`, `uuid`, `type`, `startedByUser`, `state`, `createdAt`, `startedAt`, `updatedAt`, `completedAt`.
typestringnonullA type filter. Multiple entries are accepted.
uuidstringnonullA UUID filter. Multiple entries are accepted.

[Acronis Cyber Protect Cloud] Fetch a list of tasks. Served by the Task Management API (backup tasks and activities, which is how you answer "did last night's backup run and did it succeed"). Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts type, queue, priority, startedBy, policyId, policyName, policyType, resourceId, resourceName, resourceType, workflowId, state, resultCode, enqueuedAt, and more here.

ParamTypeRequiredDefaultDescription
afterstringnonullThe page token with the next page of the results. Can be used only with the `limit` query string parameter.
executorIdstringnonullfilter per task executor ID.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"type":"..."}. Acronis accepts type, queue, priority, startedBy, policyId, policyName, policyType, resourceId, resourceName, resourceType, workflowId, state, resultCode, enqueuedAt on this endpoint.
idstringnonullAn ID filter. Multiple entries are accepted.
limitintegerno100A number of tasks to return in one page. This parameter restricts usage of the query string parameters to `after`. Capped at 1000.
lodstringnonullThe Acronis lod query parameter.
orderstringnonullA position-dependent ordering filter. Available ordering operators are: - `asc(field)` - ascending order - `desc(field)` - descending order Where "field" is one of the following values: `id`, `uuid`, `type`, `priority`, `startedByUser`, `state`, `enqueuedAt`, `assignedAt`, `startedAt`, `updatedAt`, `completedAt`.
uuidstringnonullA UUID filter. Multiple entries are accepted.

Protection Agents

ToolPlanAccessSummary
acronis_delete_agentProDestructiveDESTRUCTIVE: this deregisters ONE protection agent, named by the agentId path parameter.
acronis_delete_agent_by_idProDestructiveDESTRUCTIVE: this deregisters ONE protection agent, named by the required id query parameter.
acronis_delete_agent_update_settingProDestructiveDeleteAgentUpdateSettings.
acronis_delete_agent_update_settingsProDestructiveDeleteAgentUpdateSettingsCollection.
acronis_force_agent_updateProDestructiveRunAgentUpdateNow.
acronis_get_agentFreeRead-onlyFetchAgent.
acronis_get_agent_update_settingFreeRead-onlyFetchAgentUpdateSettings.
acronis_get_hardware_nodeFreeRead-onlyFetchHardwareNode.
acronis_list_agent_update_referencesFreeRead-onlyFetchAgentUpdateReferenceByAttributes.
acronis_list_agentsFreeRead-onlyFetchAgents.
acronis_list_hardware_nodesFreeRead-onlyFetchHardwareNodes.
acronis_update_agent_update_settingsProDestructiveUploadAgentUpdateSettings.

[Acronis Cyber Protect Cloud] DESTRUCTIVE: this deregisters ONE protection agent, named by the agentId path parameter. The agent is removed from Acronis and the machine stops being protected until an operator reinstalls and re-registers it; nothing in StackJack can put it back. Served by the Agents API (agent inventory, agent health, hardware nodes and agent updates). Get the agentId from acronis_list_agents and confirm the machine name in that response before you call this. acronis_delete_agent_by_id performs the same deregistration through the agent collection, with id in the query string, and the two are equivalent. Set force to true only when you have accepted that the last agent protecting a resource is going away.

ParamTypeRequiredDefaultDescription
agentIdstringyesThe registered agent ID.
forcestringnonullFlag specifying whether agent registration should be cancelled even if this is the last agent instance associated with a resource it manages. This flag is only respected for an agent that has MMS unit. Any other agent is deleted unconditionally.

[Acronis Cyber Protect Cloud] DESTRUCTIVE: this deregisters ONE protection agent, named by the required id query parameter. The agent is removed from Acronis and the machine stops being protected until an operator reinstalls and re-registers it; nothing in StackJack can put it back. Served by the Agents API (agent inventory, agent health, hardware nodes and agent updates). Acronis REQUIRES id on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave it blank. Get the id from acronis_list_agents and confirm the machine name in that response before you call this. Acronis publishes this as a filtered DELETE on the agent collection, but id is the only selector it accepts and the vendor requires it. acronis_delete_agent performs the same deregistration through the path-scoped endpoint and the two are equivalent. Set force to true only when you have accepted that the last agent protecting a resource is going away.

ParamTypeRequiredDefaultDescription
forcestringnonullFlag specifying whether agent registration should be cancelled even if this is the last agent instance associated with a resource it manages. This flag is only respected for agents that have MMS unit. Other agents are deleted unconditionally.
idstringyesREQUIRED. Identifier of agent to be deleted.

[Acronis Cyber Protect Cloud] DeleteAgentUpdateSettings. Served by the Agents API (agent inventory, agent health, hardware nodes and agent updates). DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
idstringyesIf query parameter is false or missing, this is a registered agent ID. Otherwise, this is a tenant ID.
masterstringnonullBoolean flag specifying whether master unattended agent update settings are to be deleted. If the value is true then `` is interpreted as the ID of tenant the settings belong to. Otherwise, the `` is interpreted as the agent ID.

[Acronis Cyber Protect Cloud] DeleteAgentUpdateSettingsCollection. Served by the Agents API (agent inventory, agent health, hardware nodes and agent updates). Acronis REQUIRES id on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
idstringyesREQUIRED. Identifier of agent or tenant which unattended agent update settings to be deleted.
masterstringnonullBoolean flag specifying whether master unattended agent update settings are to be deleted. If the value is true then `id` query parameter is interpreted as ID of tenant the settings belong to. Otherwise, the `id` is interpreted as agent ID.

[Acronis Cyber Protect Cloud] RunAgentUpdateNow. Served by the Agents API (agent inventory, agent health, hardware nodes and agent updates). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] FetchAgent. Served by the Agents API (agent inventory, agent health, hardware nodes and agent updates).

ParamTypeRequiredDefaultDescription
agentIdstringyesThe registered agent ID.

[Acronis Cyber Protect Cloud] FetchAgentUpdateSettings. Served by the Agents API (agent inventory, agent health, hardware nodes and agent updates).

ParamTypeRequiredDefaultDescription
idstringyesIf query parameter is false or missing, this is a registered agent ID. Otherwise, this is a tenant ID.
masterstringnonullBoolean flag specifying whether master unattended agent update settings should be returned. If the value is true then `` is interpreted as the ID of tenant the settings belong to. Otherwise, the `` is interpreted as the agent ID.

[Acronis Cyber Protect Cloud] FetchHardwareNode. Served by the Agents API (agent inventory, agent health, hardware nodes and agent updates).

ParamTypeRequiredDefaultDescription
nodeIdstringyesThe node ID.

[Acronis Cyber Protect Cloud] FetchAgentUpdateReferenceByAttributes. Served by the Agents API (agent inventory, agent health, hardware nodes and agent updates). Acronis REQUIRES updateChannel, osFamily, osArch on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
osArchstringyesREQUIRED. CPU architecture of operating system the update was built for.
osFamilystringyesREQUIRED. Name of operating system family the update was built for.
updateChannelstringyesREQUIRED. Update channel the agent update belongs to.
whiteLabeledstringnonullFlag specifying whether information about the update package that installs an agent that does not contain references to Acronis as its manufacturer ought to be returned.

[Acronis Cyber Protect Cloud] FetchAgents. Served by the Agents API (agent inventory, agent health, hardware nodes and agent updates). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts up_to_date here.

ParamTypeRequiredDefaultDescription
afterstringnonullCursor that designates the last element of a previously returned registered agent subset (page). If this parameter is provided, the next agent page will be returned in the response (according to ordering requirements that were specified in the first request). This parameter is mutually exclusive with all other but limit query parameters. Client must treat it as opaque string.
beforestringnonullCursor that designates the first element of a previously returned registered agent subset (page). If this parameter is provided, the previous agent page will be returned in the response (according to ordering requirements that were specified in the first request). This parameter is mutually exclusive with all other but limit query parameters. Client must treat it as opaque string.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"up_to_date":"..."}. Acronis accepts up_to_date on this endpoint.
hostnamestringnonullEither a full name or a name segment (name mask) of a host where registered agent is installed. If this parameter is provided, only agents which host names match the parameter value are returned. Name mask is specified using one of match-like functions: - `hlike` - host name starts with specified string. - `like` - host name contains specified string in any position.
limitintegerno100Maximum number of registered agents to return in the response. If this parameter is not provided or set to zero, there is no limit on number of returned agents. Capped at 1000.
onlinestringnonullFlag that filters returned registered agents by their current responsiveness. If true, only responsive agents will be returned. If false, only irresponsive agents will be returned.
orderstringnonullOrdering requirements on returned sequence of registered agents. They are specified as a comma-separated list of order specifications for agent attributes. Each attribute order specification is either asc (non-descending order) or desc (non-ascending order) function applied to an attribute name.
osFamilystringnonullParameter that filters registered agents by OS family name they were built for. OS family name is case-insensitive.
tenantIdstringnonullIdentifier of a tenant subtree root. Only agents that belong to tenants of this subtree are returned. If this parameter is missing, value from `X-Apigw-Tenant-Id` header is used. If this header is also missing, tenant identifiers from relevant elements of scope collection of access token are used.
unitstringnonullName of registered agent unit. If this parameter is provided, only agents that have at least one of specified units are returned.

[Acronis Cyber Protect Cloud] FetchHardwareNodes. Served by the Agents API (agent inventory, agent health, hardware nodes and agent updates).

[Acronis Cyber Protect Cloud] UploadAgentUpdateSettings. Served by the Agents API (agent inventory, agent health, hardware nodes and agent updates). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

Protection Policies and Resources

ToolPlanAccessSummary
acronis_apply_policy_to_resourcesProDestructiveApply a protection policy to resources.
acronis_create_draft_policiesProWriteAdd a policy to a draft.
acronis_create_draftsProWriteCreate a draft, which is a staging area for policy edits that does not touch live protection until it is applied.
acronis_create_policiesProWriteCreate a protection policy.
acronis_delete_draftProDestructiveDelete a draft and the staged edits it holds.
acronis_delete_draft_policyProDestructiveRemove one policy from a draft.
acronis_delete_policiesProDestructiveDelete protection policies selected by filter, not by a single ID.
acronis_delete_policyProDestructiveDelete one protection policy by ID.
acronis_delete_resourcesProDestructiveDelete resource records selected by filter.
acronis_get_draftFreeRead-onlyFetch one draft of policy edits by ID, including the policies staged inside it.
acronis_get_policyFreeRead-onlyFetch one protection policy by ID.
acronis_get_resourceFreeRead-onlyFetch one resource by ID.
acronis_get_resources_countFreeRead-onlyCount the resources matching a filter without listing them.
acronis_list_applications_issues_statisticsFreeRead-onlyFetch statistics about issues with policy applications, which is how you find protection that is failing rather than merely assigned.
acronis_list_policiesFreeRead-onlyList protection policies.
acronis_list_policy_applicationsFreeRead-onlyList policy applications, that is the links between policies and the resources they protect.
acronis_list_policy_statusesFreeRead-onlyList application statuses grouped by policy, which answers whether a policy is actually running where it was assigned.
acronis_list_resource_attributesFreeRead-onlyList the attributes Acronis holds for one resource.
acronis_list_resource_statusesFreeRead-onlyList the protection status of resources, which is the direct answer to whether a customer machine is protected.
acronis_list_resourcesFreeRead-onlyList the resources, that is the machines and workloads, known to Resource and Policy Management.
acronis_revoke_policy_applicationsProDestructiveRevoke policy applications, which unlinks policies from the resources they protect.
acronis_run_policy_executionProDestructiveStart a policy execution now instead of waiting for its schedule.
acronis_update_draft_contextProDestructiveReplace the context of a draft, which is the scope and the resources the staged edits are written against.
acronis_update_draft_disabled_applications_contextProDestructiveReplace the disabled-applications context of a draft, that is the record of which policy applications the draft switches off.
acronis_update_draft_enabled_policiesProDestructiveReplace the set of policies a draft enables.
acronis_update_draft_nameProWriteRename a draft.
acronis_update_draft_policy_commentProWriteSet the comment on a policy inside a draft.
acronis_update_draft_policy_enabledProDestructiveEnable or disable one policy inside a draft.
acronis_update_draft_policy_nameProWriteRename a policy inside a draft.
acronis_update_draft_policy_settingsProDestructiveReplace the settings of a policy inside a draft, for example its schedule or its retention.
acronis_update_draft_policy_typeProDestructiveSet the type of a policy inside a draft, that is which kind of protection it performs.
acronis_update_draft_stateProDestructiveChange the state of a draft, which is how a staged draft is moved toward being applied.
acronis_update_policyProDestructiveChange fields on a live protection policy.
acronis_update_policy_favoritesProDestructiveChange the favorite order and the related display properties of policies.

[Acronis Cyber Protect Cloud] Apply a protection policy to resources. In Resource and Policy Management an application is the link between a policy and the resources it protects, so creating one changes live protection even though the vendor calls the operation a create. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes what is protected on real machines and takes effect at once. Confirm the policy with acronis_get_policy and the targets with acronis_list_resources first; undo it with acronis_revoke_policy_applications.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Add a policy to a draft. A draft is a staged set of policy edits that protects nothing until it is applied, which is why this is not marked destructive. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Create a draft, which is a staging area for policy edits that does not touch live protection until it is applied. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Read one back with acronis_get_draft.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Create a protection policy. A new policy protects nothing until acronis_apply_policy_to_resources links it to resources, which is why this is not marked destructive. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Delete a draft and the staged edits it holds. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). DESTRUCTIVE: the staged work is lost and cannot be recovered from StackJack. Read acronis_get_draft first. Live protection is unaffected, because a draft is not applied.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.

[Acronis Cyber Protect Cloud] Remove one policy from a draft. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). DESTRUCTIVE: the staged policy is dropped from the draft and cannot be recovered from StackJack. Read acronis_get_draft first.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.
policyIdstringyesThe Acronis policy_id.

[Acronis Cyber Protect Cloud] Delete protection policies selected by filter, not by a single ID. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. DESTRUCTIVE: a deleted policy stops protecting every resource it is applied to, so machines silently lose backup and security coverage. Run acronis_list_policies with the same filters first, and read acronis_list_policy_applications to see what each one currently protects.

ParamTypeRequiredDefaultDescription
policyIdstringnonullFilter by one or more policy IDs. Maximum 100 items.
policySelectionIdstringnonullFilter by policies that are in the policy selection.
tenantIdstringnonullFilter by one or more tenant IDs or UUIDs. Maximum 100 items.

[Acronis Cyber Protect Cloud] Delete one protection policy by ID. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). DESTRUCTIVE: every resource the policy protects loses that protection. Read acronis_get_policy and acronis_list_policy_applications first to see what depends on it.

ParamTypeRequiredDefaultDescription
policyIdstringyesThe Acronis policy_id.

[Acronis Cyber Protect Cloud] Delete resource records selected by filter. A resource is a machine or workload Acronis knows about. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). DESTRUCTIVE: removing a resource record drops it out of the protection inventory and out of every policy application that named it. Run acronis_list_resources with the same filters first.

ParamTypeRequiredDefaultDescription
agentIdstringnonullFilter by one agent UUID. Maximum 100 items.
resourceIdstringnonullFilter by one or more resource IDs. The IDs are of type `ScopedExternalID`. Maximum 100 items.
resourceTagstringnonullFilter by resource tag

[Acronis Cyber Protect Cloud] Fetch one draft of policy edits by ID, including the policies staged inside it. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application).

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.

[Acronis Cyber Protect Cloud] Fetch one protection policy by ID. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). See what it currently protects with acronis_list_policy_applications.

ParamTypeRequiredDefaultDescription
fullCompositestringnonullIf `` is a composite policy root, then all composite policies will be returned. If `` is a non-root policy - just one corresponding policy object will be returned.
includeAppliedContextstringnonullInclude the context that the policy is applied to. Populates the `context` field of the `BoundCompositePolicy` object.
includeSettingsstringnonullInclude policy settings.
linksAndIssuesstringnonullRequest to calculate and return links and / or constraints on them. If `embed_brief` is requested - only non-constrained ('available') links should be returned (in `LinksAndIssues._linkIDs` array). If `embed_detailed` is requested - both links (non-constrained and constrained) and their constraint descriptions should be returned (in `LinksAndIssues._links` and `LinksAndIssues._issues` arrays).
policyIdstringyesThe Acronis policy_id.

[Acronis Cyber Protect Cloud] Fetch one resource by ID. The path takes either the Acronis internal ID or the external ID, which is why the parameter names both. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application).

ParamTypeRequiredDefaultDescription
includeAttributeNamespacesstringnonullIncludes resource's attributes from specific namespaces. Mutually exclusive with `include_attributes`.
includeAttributesstringnonullIf true, includes resource's attributes in the response. Mutually exclusive with `include_attribute_namespaces`.
linksAndIssuesstringnonullRequest to calculate and return links and / or constraints on them. If `embed_brief` is requested - only non-constrained ('available') links should be returned (in `LinksAndIssues._linkIDs` array). If `embed_detailed` is requested - both links (non-constrained and constrained) and their constraint descriptions should be returned (in `LinksAndIssues._links` and `LinksAndIssues._issues` arrays).
resourceInternalOrExternalIdstringyesThe Acronis resource_internal_or_external_id.

[Acronis Cyber Protect Cloud] Count the resources matching a filter without listing them. Use it to size a query before running acronis_list_resources. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts search, not_applied_only, applicable_to_policy_id, applicable_to_policy_selection_id, applied_only, applied_to_policy_id, applied_to_policy_selection_id, include_deleted, allowed_actions, updated_at, is_group here.

ParamTypeRequiredDefaultDescription
agentIdstringnonullFilter by one or more agent UUIDs. Maximum 100 items.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"search":"..."}. Acronis accepts search, not_applied_only, applicable_to_policy_id, applicable_to_policy_selection_id, applied_only, applied_to_policy_id, applied_to_policy_selection_id, include_deleted, allowed_actions, updated_at, is_group on this endpoint.
hasMemberIdstringnonullFilter by one or more member UUIDs. Maximum 100 items.
parentIdstringnonullFilter by one or more parent UUIDs. Maximum 100 items.
resourceIdstringnonullFilter by one or more resource UUIDs. Maximum 100 items.
tenantIdstringnonullFilter by one or more tenant IDs or UUIDs. Maximum 100 items.
typestringnonullFilter by one or more resource types. Items are of type `ResourceType` or `cti.CTI` (for workloads derived from `cti.a.p.wm.workload.v1.0`). Maximum 10 items.

[Acronis Cyber Protect Cloud] Fetch statistics about issues with policy applications, which is how you find protection that is failing rather than merely assigned. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application).

ParamTypeRequiredDefaultDescription
contextIdstringnonullFilter by one or more resource IDs. Maximum 10 items.
linksAndIssuesstringnonullRequest to calculate and return links and / or constraints on them. If `embed_brief` is requested - only non-constrained ('available') links should be returned (in `LinksAndIssues._linkIDs` array). If `embed_detailed` is requested - both links (non-constrained and constrained) and their constraint descriptions should be returned (in `LinksAndIssues._links` and `LinksAndIssues._issues` arrays).
policyIdstringnonullFilter by one or more policy IDs. Maximum 30 items.

[Acronis Cyber Protect Cloud] List protection policies. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts search, applicable_to_context_id, applicable_to_context_selection_id, dependency_namespace, dependency_path, os_type, include_settings, include_settings_constraints, include_applied_context, templates_only, include_templates, include_temporaries, favorite, default here. Fetch one policy with acronis_get_policy.

ParamTypeRequiredDefaultDescription
afterstringnonullCursor after the current page.
beforestringnonullCursor before the current page.
enabledstringnonullFilter only enabled or disabled policies.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"search":"..."}. Acronis accepts search, applicable_to_context_id, applicable_to_context_selection_id, dependency_namespace, dependency_path, os_type, include_settings, include_settings_constraints, include_applied_context, templates_only, include_templates, include_temporaries, favorite, default on this endpoint.
limitintegerno100Number of element in the page. Capped at 1000.
parentIdsstringnonullFilter by one or more parent IDs. Maximum 100 items. If this filter is set, policies with matching 'parent policies' will be returned. If this filter is used but no actual values are provided in the query (e.g. `parent_ids=`), only 'root policies' (with empty 'parent policies') will be returned.
policyIdstringnonullFilter by one or more policy IDs. Maximum 100 items.
policySelectionIdstringnonullFetch all policies that are in the policy selection.
tenantIdstringnonullFilter by one or more tenant IDs or UUIDs. Maximum 100 items.
typesstringnonullFilter by one or more policy types. Items are of type `PolicyType`. Maximum 10 items.

[Acronis Cyber Protect Cloud] List policy applications, that is the links between policies and the resources they protect. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts policy_type, include_temporaries, context_type, deployment_state, execution_state, status, issue_types, enabled_only, direct_only, empty_link_only, include_multiple_applications_conflict, include_validation_issues, include_deployment_errors, include_running_blockers, and more here. Create an application with acronis_apply_policy_to_resources.

ParamTypeRequiredDefaultDescription
afterstringnonullCursor after the current page.
agentIdstringnonullFilter by one or more agent IDs. Maximum 100 items.
beforestringnonullCursor before the current page.
contextIdstringnonullFilter by one or more context IDs. Maximum 100 items.
contextSelectionIdstringnonullFetch all applications applied to the resources in the context selection.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"policy_type":"..."}. Acronis accepts policy_type, include_temporaries, context_type, deployment_state, execution_state, status, issue_types, enabled_only, direct_only, empty_link_only, include_multiple_applications_conflict, include_validation_issues, include_deployment_errors, include_running_blockers on this endpoint.
limitintegerno100Number of element in the page. Capped at 1000.
policyIdstringnonullFilter by one or more policy IDs. Maximum 100 items.
policySelectionIdstringnonullFetch all applications of the policies in the policy selection.
tenantIdstringnonullFilter by one or more tenant IDs or UUIDs. Maximum 100 items.

[Acronis Cyber Protect Cloud] List application statuses grouped by policy, which answers whether a policy is actually running where it was assigned. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts policy_type, policy_id, policy_selection_id, created_at, updated_at, include_validation_issues, include_aggregate_status, order, links_and_issues here.

ParamTypeRequiredDefaultDescription
afterstringnonullCursor after the current page.
beforestringnonullCursor before the current page.
contextIdstringnonullFilter by one or more resource IDs. Maximum 100 items.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"policy_type":"..."}. Acronis accepts policy_type, policy_id, policy_selection_id, created_at, updated_at, include_validation_issues, include_aggregate_status, order, links_and_issues on this endpoint.
joinNotAppliedstringnonullInclude statuses for policies that have no applications.
limitintegerno100Number of element in the page. Capped at 1000.
parentIdstringnonullFilter by one or more parent IDs. Maximum 100 items. If this filter is set, parent policies (i.e., root policies) will be excluded from the response.
searchstringnonullTODO
statusstringnonullFilter by one or more statuses. Items are of type `ExecutionStatus`. Maximum 10 items.
tenantIdstringnonullFilter by one or more tenant IDs or UUIDs. Maximum 100 items.

[Acronis Cyber Protect Cloud] List the attributes Acronis holds for one resource. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Fetch the resource itself with acronis_get_resource.

ParamTypeRequiredDefaultDescription
resourceInternalOrExternalIdstringyesThe Acronis resource_internal_or_external_id.

[Acronis Cyber Protect Cloud] List the protection status of resources, which is the direct answer to whether a customer machine is protected. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts selection_id, search, include_deleted, include_attributes, include_attribute_namespaces, updated_at, order here.

ParamTypeRequiredDefaultDescription
afterstringnonullCursor after the current page.
agentIdstringnonullFilter by one or more agent UUIDs. Maximum 100 items.
beforestringnonullCursor before the current page.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"selection_id":"..."}. Acronis accepts selection_id, search, include_deleted, include_attributes, include_attribute_namespaces, updated_at, order on this endpoint.
hasMemberIdstringnonullFilter by one or more member UUIDs. Maximum 100 items.
limitintegerno100Number of element in the page. Capped at 1000.
parentIdstringnonullFilter by one or more parent UUIDs. Maximum 100 items.
resourceIdstringnonullFilter by one or more resource UUIDs. Maximum 100 items.
tenantIdstringnonullFilter by one or more tenant IDs or UUIDs. Maximum 100 items.
typestringnonullFilter by one or more resource types. Items are of type `ResourceType`. Maximum 10 items.

[Acronis Cyber Protect Cloud] List the resources, that is the machines and workloads, known to Resource and Policy Management. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts type, resource_id, search, not_applied_only, applicable_to_policy_id, applicable_to_policy_selection_id, applied_only, applied_to_policy_id, applied_to_policy_selection_id, include_deleted, allowed_actions, updated_at, is_group here. Fetch one with acronis_get_resource.

ParamTypeRequiredDefaultDescription
afterstringnonullCursor after the current page.
agentIdstringnonullFilter by one or more agent UUIDs. Maximum 100 items.
beforestringnonullCursor before the current page.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"type":"..."}. Acronis accepts type, resource_id, search, not_applied_only, applicable_to_policy_id, applicable_to_policy_selection_id, applied_only, applied_to_policy_id, applied_to_policy_selection_id, include_deleted, allowed_actions, updated_at, is_group on this endpoint.
hasMemberIdstringnonullFilter by one or more member UUIDs. Maximum 100 items.
includeAttributeNamespacesstringnonullIncludes resources' attributes from specific namespaces. Mutually exclusive with `include_attributes`.
includeAttributesstringnonullIf true, includes resources' attributes in the response. Mutually exclusive with `include_attribute_namespaces`.
limitintegerno100Number of element in the page. Capped at 1000.
parentIdstringnonullFilter by one or more parent UUIDs. Maximum 100 items.
tenantIdstringnonullFilter by one or more tenant IDs or UUIDs. Maximum 100 items.

[Acronis Cyber Protect Cloud] Revoke policy applications, which unlinks policies from the resources they protect. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). DESTRUCTIVE: every matched resource loses the protection that application provided, immediately and without a warning to the customer. List the applications with acronis_list_policy_applications first.

ParamTypeRequiredDefaultDescription
contextIdstringnonullDelete applications by one or more context IDs. Maximum 100 items.
contextSelectionIdstringnonullDelete all applications for the resources in the context selection with the given ID.
policyIdstringnonullDelete applications by one or more policy IDs. Maximum 100 items.
policySelectionIdstringnonullDelete all applications for the policies in the policy selection with the given ID.

[Acronis Cyber Protect Cloud] Start a policy execution now instead of waiting for its schedule. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this dispatches real work to live machines, for example a backup or a scan, and it consumes storage and endpoint resources. Confirm the target with acronis_list_policy_applications first, then follow the run with acronis_list_tasks.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Replace the context of a draft, which is the scope and the resources the staged edits are written against. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this is a PUT that replaces the whole context block, so anything you omit is lost from the draft. Read acronis_get_draft first.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Replace the disabled-applications context of a draft, that is the record of which policy applications the draft switches off. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this is a PUT that replaces the whole block, so omitted entries are lost and applying the draft can disable protection you did not intend to disable. Read acronis_get_draft first.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Replace the set of policies a draft enables. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this is a PUT that replaces the whole set, so a policy left out of the body is no longer enabled by the draft. Read acronis_get_draft first.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Rename a draft. It changes one label on a staged draft and touches no live protection, which is why it is not marked destructive. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Set the comment on a policy inside a draft. It changes one text field on a staged draft and touches no live protection, which is why it is not marked destructive. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
policyIdstringyesThe Acronis policy_id.

[Acronis Cyber Protect Cloud] Enable or disable one policy inside a draft. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: the flag decides whether that policy protects anything once the draft is applied, so clearing it removes protection at apply time. Read acronis_get_draft first.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
policyIdstringyesThe Acronis policy_id.

[Acronis Cyber Protect Cloud] Rename a policy inside a draft. It changes one label on a staged draft, which is why it is not marked destructive. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
policyIdstringyesThe Acronis policy_id.

[Acronis Cyber Protect Cloud] Replace the settings of a policy inside a draft, for example its schedule or its retention. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this is a PUT that replaces the whole settings block, so omitted values fall away and the applied policy can protect less than it did. Read acronis_get_draft first and send the whole block back.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
policyIdstringyesThe Acronis policy_id.

[Acronis Cyber Protect Cloud] Set the type of a policy inside a draft, that is which kind of protection it performs. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: changing the type changes what the policy does once the draft is applied, and settings that belonged to the old type do not carry over. Read acronis_get_draft first.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
policyIdstringyesThe Acronis policy_id.

[Acronis Cyber Protect Cloud] Change the state of a draft, which is how a staged draft is moved toward being applied. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: moving a draft into an applied state pushes every staged edit onto live protection at once. Read acronis_get_draft and confirm the staged content before you send this.

ParamTypeRequiredDefaultDescription
draftIdstringyesThe Acronis draft_id.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Change fields on a live protection policy. This is a PATCH, so only the fields you send are merged. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: the policy is live, so a changed schedule or retention takes effect on every resource it protects. Read acronis_get_policy and acronis_list_policy_applications first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
policyIdstringyesThe Acronis policy_id.

[Acronis Cyber Protect Cloud] Change the favorite order and the related display properties of policies. Served by the Resource and Policy Management API (protected resources, protection policies, policy drafts and policy application). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this writes across the policy set rather than one policy, so it can reorder or re-flag policies you did not name. List them with acronis_list_policies first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

Endpoint Detection and Response

ToolPlanAccessSummary
acronis_get_incidentFreeRead-onlyGET /incidents/.
acronis_get_incident_response_actionFreeRead-onlyGET /incidents//response_action.
acronis_list_incidentsFreeRead-onlyGET /incidents.
acronis_run_incident_response_actionProDestructiveRun an EDR containment or remediation action against the workload behind one security incident.
acronis_set_incident_investigation_stateProWritePOST /incidents//investigation_state.
acronis_set_incidents_investigation_stateProWritePOST /incidents/investigation_state.

[Acronis Cyber Protect Cloud] GET /incidents/. Served by the Endpoint Detection and Response API (security incidents, investigation state and endpoint response actions). Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts updated_since, with_activities here.

ParamTypeRequiredDefaultDescription
analyticsSourcestringnonullName of a component that use the API or a vendor name, used for API usage analytics only.
customerIdstringnonullCustomer ID, if it isn't provided tenant_id from the authentication token is used. Must be specified if the request is not authenticated with customer scoped token, i.e. partner level or root level.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"updated_since":"..."}. Acronis accepts updated_since, with_activities on this endpoint.
incidentIdstringyesThe Acronis incident_id.
withDetectionPerTypeLimitstringnonullLimit the number of detections per detection type in the response. If not provided, all detections are returned. Note: for internal use only.
withDetectionsstringnonullInclude detections in the response.
withIncidentActionsstringnonullInclude response actions in the response.

[Acronis Cyber Protect Cloud] GET /incidents//response_action. Served by the Endpoint Detection and Response API (security incidents, investigation state and endpoint response actions). Acronis REQUIRES activityId on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
activityIdstringyesREQUIRED. Activity ID corresponding to the initiated response action.
analyticsSourcestringnonullName of a component that use the API or a vendor name, used for API usage analytics only.
customerIdstringnonullCustomer ID, if it isn't provided tenant_id from the authentication token is used. Must be specified if the request is not authenticated with customer scoped token, i.e. partner level or root level.
incidentIdstringyesThe Acronis incident_id.

[Acronis Cyber Protect Cloud] GET /incidents. Served by the Endpoint Detection and Response API (security incidents, investigation state and endpoint response actions). Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts created_at, updated_at, is_mitigated, mitigation_state, state, severity, positivity, verdict, incident_category, workload_id, analytics_source here.

ParamTypeRequiredDefaultDescription
cursorstringnonullThe cursor that points to the next batch of records returned from the previous request. All other filtering and sorting parameters MUST remain exactly the same between requests.
customerIdstringnonullA filter by customer IDs (specific customer tenant ID(s) or customer IDs of specified partner tenant ID). If not specified, the tenant ID provided in the token will be used. If the user is authenticated in the scope of the partner tenant or above, this parameter is required. The HTTP error 400 Bad Request will be returned if the parameter is missing or non-compliant.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"created_at":"..."}. Acronis accepts created_at, updated_at, is_mitigated, mitigation_state, state, severity, positivity, verdict, incident_category, workload_id, analytics_source on this endpoint.
incidentIdstringnonullList of incident IDs. Can only be used for single customer, either specified in customer_id parameter or extracted from the authentication token. Supported operators: * `= value`: filters by the specified value; * `or(value1, value2, ...)`: filters by any value in the specified set.
limitintegerno100Maximum number of items to return. Capped at 1000.
orderstringnonullSort order of the returned items. Supported operators: * `asc(customer_id), asc(created_at)`: ascending order of customer and then created_at.
withMultiWorkloadstringnonullInclude multi-workload incidents in the response. If true, for multi-workload incidents the "workloads" field will be present and root level WorkloadInfo fields will be omitted.
withTransferredstringnonullInclude incidents that were transferred to another incident.

[Acronis Cyber Protect Cloud] Run an EDR containment or remediation action against the workload behind one security incident. DESTRUCTIVE: action is the verb and it reaches the endpoint itself - WORKLOAD_ISOLATE and WORKLOAD_DEISOLATE cut the machine off the network and put it back, WORKLOAD_SHUTDOWN and WORKLOAD_RESTART stop or reboot it, PROCESS_STOP and PROCESS_STOP_TREE kill a running process and its children, PROCESS_FILE_QUARANTINE and PROCESS_FILE_DELETE move or erase the file on disk, WORKLOAD_ROLLBACK reverts the machine to a restore point, WORKLOAD_PATCH installs a patch, ACQUIRE_FORENSIC_BACKUP takes a memory and disk image, and ADD_TO_ALLOW, ADD_TO_BLOCK and the ADD_ALL_PROCESS_FILE_URL_TO_ALLOW_LIST / ADD_ALL_PROCESS_FILE_URL_TO_BLOCK_LIST pair change the tenant's allow and block lists. None of it can be undone from StackJack. Served by the Endpoint Detection and Response API (security incidents, investigation state and endpoint response actions). Acronis REQUIRES action on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave it blank. Each verb reads its own operands: processes and files for the allow and block list verbs and for PROCESS_STOP, patchId for WORKLOAD_PATCH, restorePointName for WORKLOAD_ROLLBACK, backupLocation with forensicDumpMode and forensicRunningProcessesSnapshot for ACQUIRE_FORENSIC_BACKUP, policyId and delay for the isolation verbs, and workloadId when the incident spans more than one workload. Read the incident with acronis_get_incident first and confirm the workload.

ParamTypeRequiredDefaultDescription
actionstringyesREQUIRED. Action, e.g., "WORKLOAD_ISOLATE", see ResponseAction.
analyticsSourcestringnonullName of a component that use the API or a vendor name, used for API usage analytics only.
backupLocationstringnonullBackup location.
delaystringnonullDelay in minutes before action is performed.
filesstringnonullList of file IDs to add to allow/block list.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"customer_id":"..."}. Acronis accepts customer_id, urls, archive_name, exclusion_description, credentials_id, comment, workflow_id on this endpoint.
forensicDumpModestringnonullForensic backup memory dump type.
forensicRunningProcessesSnapshotstringnonullWhether forensic backup should be done by snapshotting the running processes.
incidentIdstringyesThe Acronis incident_id.
patchIdstringnonullPatch unique identifier.
policyIdstringnonullProtection policy ID.
processesstringnonullList of process image file IDs to add to allow/block list.
restorePointNamestringnonullHuman-readable string to display.
workloadIdstringnonullWorkload ID where the action should be performed. If not provided, the action is performed on the workload associated with the incident. Required for multi-workload incidents.

[Acronis Cyber Protect Cloud] POST /incidents//investigation_state. Served by the Endpoint Detection and Response API (security incidents, investigation state and endpoint response actions). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
analyticsSourcestringnonullName of a component that use the API or a vendor name, used for API usage analytics only.
customerIdstringnonullCustomer ID, if it isn't provided tenant_id from the authentication token is used. Must be specified if the request is not authenticated with customer scoped token, i.e. partner level or root level.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
incidentIdstringyesThe Acronis incident_id.
workflowIdstringnonullWorkflow ID in case if executed by workflow. Requires "edr_mgmtsvc automation" scope. Headers `X-Apigw-Session-User-Id`, `X-Apigw-Session-Login?` might be omitted.

[Acronis Cyber Protect Cloud] POST /incidents/investigation_state. Served by the Endpoint Detection and Response API (security incidents, investigation state and endpoint response actions). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
analyticsSourcestringnonullName of a component that use the API or a vendor name, used for API usage analytics only.
customerIdstringnonullCustomer ID, if it isn't provided tenant_id from the authentication token is used. Must be specified if the request is not authenticated with customer scoped token, i.e. partner level or root level.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
workflowIdstringnonullWorkflow ID in case if executed by workflow. Requires "edr_mgmtsvc automation" scope. Headers `X-Apigw-Session-User-Id`, `X-Apigw-Session-Login?` might be omitted.

Tenants, Users and Licensing

ToolPlanAccessSummary
acronis_check_tenant_edition_switchFreeRead-onlyPerformTenantEditionSwitchCheck.
acronis_check_user_passwordFreeRead-onlyCheckPassword.
acronis_create_clientsProDestructiveCreateClient.
acronis_create_infraProWriteRegisterInfrastructure.
acronis_create_locationsProWriteCreateInfrastructuresLocation.
acronis_create_registration_tokensProDestructiveCreateRegistrationToken_0. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).
acronis_create_reportsProDestructiveCreateReport.
acronis_create_tenant_registration_tokensProDestructiveCreateRegistrationToken_1. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).
acronis_create_tenantsProDestructiveCreateTenant.
acronis_create_usersProDestructiveCreateUser.
acronis_delete_application_settings_tenantProDestructiveDeleteTenantApplicationSetting.
acronis_delete_clientProDestructiveDeleteClient.
acronis_delete_infraProDestructiveUnregisterInfrastructure.
acronis_delete_locationProDestructiveDeleteInfrastructuresLocation.
acronis_delete_registration_tokenProDestructiveDeleteRegistrationToken.
acronis_delete_reportProDestructiveDeleteReport.
acronis_delete_tenantProDestructiveDeleteTenant.
acronis_delete_userProDestructiveDeleteUser.
acronis_disable_tenant_applicationProDestructiveTurnOffTenantApplication.
acronis_disable_tenant_brandingProDestructiveDisableCustomBranding.
acronis_enable_tenant_applicationProDestructiveTurnOnTenantApplication.
acronis_enable_tenant_brandingProWriteEnableCustomBranding.
acronis_get_applicationFreeRead-onlyFetchApplication.
acronis_get_application_settings_tenantFreeRead-onlyFetchTenantApplicationSetting.
acronis_get_clientFreeRead-onlyFetchClient.
acronis_get_infraFreeRead-onlyFetchInfrastructure.
acronis_get_locationFreeRead-onlyFetchInfrastructuresLocation.
acronis_get_reportFreeRead-onlyFetchReport.
acronis_get_report_storedFreeRead-onlyFetchStoredReports.
acronis_get_tenantFreeRead-onlyFetchTenant.
acronis_get_tenant_brandFreeRead-onlyFetchCustomBrandingOptions.
acronis_get_tenant_mfa_statusFreeRead-onlyFetchTenantMFAStatus.
acronis_get_tenant_offering_items_available_for_childFreeRead-onlyFetchOfferingItemsAvailableForTenantChild.
acronis_get_tenant_offering_items_pricingFreeRead-onlyFetchTenantOfferingItemsPrices.
acronis_get_tenant_pricingFreeRead-onlyFetchTenantPricingSettings.
acronis_get_userFreeRead-onlyFetchUser.
acronis_get_user_access_policiesFreeRead-onlyFetchUserAccessPolicies.
acronis_get_users_check_loginFreeRead-onlyCheckLoginNameAvailability.
acronis_get_users_meFreeRead-onlyFetchCurrentUserInfo.
acronis_list_account_applicationsFreeRead-onlyFetchApplications.
acronis_list_clientsFreeRead-onlyFetchClientsBatch.
acronis_list_infraFreeRead-onlyFetchInfrastructuresBatch.
acronis_list_location_infraFreeRead-onlyFetchLocationInfrastructures.
acronis_list_locationsFreeRead-onlyFetchInfrastructuresLocationsBatch.
acronis_list_registration_tokensFreeRead-onlyFetchRegistrationTokens_0. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).
acronis_list_searchFreeRead-onlySearch.
acronis_list_tenant_applicationsFreeRead-onlyFetchAvailableTenantApplications.
acronis_list_tenant_childrenFreeRead-onlyFetchTenantChildren.
acronis_list_tenant_locationsFreeRead-onlyFetchTenantInfrastructureLocations.
acronis_list_tenant_offering_itemsFreeRead-onlyFetchTenantOfferingItems.
acronis_list_tenant_registration_tokensFreeRead-onlyFetchRegistrationTokens_1. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).
acronis_list_tenant_reportsFreeRead-onlyFetchTenantReports.
acronis_list_tenant_usagesFreeRead-onlyFetchTenantUsages.
acronis_list_tenant_usersFreeRead-onlyFetchTenantUsers.
acronis_list_tenantsFreeRead-onlyFetchTenantsBatch.
acronis_list_tenants_applicationsFreeRead-onlyFetchTenantsApplicationsBatch.
acronis_list_tenants_offering_itemsFreeRead-onlyFetchTenantOfferingItemsBatch.
acronis_list_tenants_usagesFreeRead-onlyFetchTenantsUsagesBatch.
acronis_list_usersFreeRead-onlyFetchUsersBatch.
acronis_restore_deleted_tenantProDestructiveRestoreDeletedTenant.
acronis_restore_deleted_userProDestructiveRestoreDeletedUser.
acronis_send_user_activation_emailProDestructiveSendActivationEmail.
acronis_set_user_passwordProDestructiveSetUserPassword.
acronis_switch_tenant_editionProDestructiveSwitchTenantEdition.
acronis_update_application_settings_tenantProDestructiveUpdateTenantApplicationSetting.
acronis_update_clientProDestructiveUpdateClient.
acronis_update_infraProDestructiveUpdateInfrastructure.
acronis_update_locationProDestructiveUpdateInfrastructuresLocation.
acronis_update_reportProDestructiveUpdateReport.
acronis_update_tenantProDestructiveUpdateTenant.
acronis_update_tenant_brandingProDestructiveModifyCustomBranding.
acronis_update_tenant_default_idpProDestructiveUpdateTenantDefaultIdpId.
acronis_update_tenant_mfa_statusProDestructiveManageTenantMFAStatus.
acronis_update_tenant_offering_itemsProDestructiveSetTenantOfferingItems.
acronis_update_tenant_offering_items_pricingProDestructiveUpdateTenantOfferingItemsPrices.
acronis_update_tenant_pricingProDestructiveUpdateTenantPricingSettings.
acronis_update_tenants_usagesProDestructiveUpdateTenantsUsages.
acronis_update_userProDestructiveUpdateUser.
acronis_update_user_access_policiesProDestructiveUpdateUserAccessPolicies.
acronis_update_user_mfa_statusProDestructiveManageUserMFAStatus.

[Acronis Cyber Protect Cloud] PerformTenantEditionSwitchCheck. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES targetEdition, applicationId on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
applicationIdstringyesREQUIRED. Application UUID.
targetEditionstringyesREQUIRED. A target edition to switch to.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] CheckPassword. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] CreateClient. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] RegisterInfrastructure. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] CreateInfrastructuresLocation. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] CreateRegistrationToken_0. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] CreateReport. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] CreateRegistrationToken_1. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] CreateTenant. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] CreateUser. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] DeleteTenantApplicationSetting. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
applicationIdstringyesApplication ID (UUID).
settingNamestringyesA name of the application's setting.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] DeleteClient. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
clientIdstringyesClient ID (UUID).

[Acronis Cyber Protect Cloud] UnregisterInfrastructure. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES version on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
forcestringnonullIf true, existing usage will be ignored in case there are no customer tenants having offering items associated with this infrastructure component turned on.
infraIdstringyesInfrastructure component ID (UUID).
versionstringyesREQUIRED. Growing number of object internal version.

[Acronis Cyber Protect Cloud] DeleteInfrastructuresLocation. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES version on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
locationIdstringyesInfrastructures location ID (UUID).
versionstringyesREQUIRED. Growing number of object internal version.

[Acronis Cyber Protect Cloud] DeleteRegistrationToken. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
tokenIdstringyesRegistration Token ID (UUID).

[Acronis Cyber Protect Cloud] DeleteReport. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES version on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
reportIdstringyesReport ID (UUID)
versionstringyesREQUIRED. Growing number of object internal version.

[Acronis Cyber Protect Cloud] DeleteTenant. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES version on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
tenantIdstringyesTenant ID (UUID).
versionstringyesREQUIRED. Growing number of object internal version.

[Acronis Cyber Protect Cloud] DeleteUser. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES version on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
userIdstringyesUser ID (UUID).
versionstringyesREQUIRED. Growing number of object internal version.

[Acronis Cyber Protect Cloud] TurnOffTenantApplication. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
applicationIdstringyesApplication ID (UUID).
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] DisableCustomBranding. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES version on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
tenantIdstringyesTenant ID (UUID).
versionstringyesREQUIRED. Growing number of object internal version.

[Acronis Cyber Protect Cloud] TurnOnTenantApplication. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
applicationIdstringyesApplication ID (UUID).
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] EnableCustomBranding. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES version on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
tenantIdstringyesTenant ID (UUID).
versionstringyesREQUIRED. Growing number of object internal version.

[Acronis Cyber Protect Cloud] FetchApplication. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
applicationIdstringyesApplication ID (UUID).

[Acronis Cyber Protect Cloud] FetchTenantApplicationSetting. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
applicationIdstringyesApplication ID (UUID).
settingNamestringyesA name of the application's setting.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchClient. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
clientIdstringyesClient ID (UUID).

[Acronis Cyber Protect Cloud] FetchInfrastructure. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
infraIdstringyesInfrastructure component ID (UUID).

[Acronis Cyber Protect Cloud] FetchInfrastructuresLocation. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
locationIdstringyesInfrastructures location ID (UUID).

[Acronis Cyber Protect Cloud] FetchReport. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
reportIdstringyesReport ID (UUID)

[Acronis Cyber Protect Cloud] FetchStoredReports. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
reportIdstringyesReport ID (UUID)

[Acronis Cyber Protect Cloud] FetchTenant. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
allowDeletedstringnonullIf true, deleted tenant may be returned.
embedPathstringnonullIf true, tenant path will be embedded in the result.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchCustomBrandingOptions. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
effectivestringnonullIf true, parent tenant's brand will be returned
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchTenantMFAStatus. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchOfferingItemsAvailableForTenantChild. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
editionstringnonullA filter of the offering items by edition. If "*" is provided, all editions will be returned. Offering items without an edition are not filtered out in any case.
kindstringnonullA kind of hypothetical child tenant for which available offering items will be returned.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchTenantOfferingItemsPrices. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchTenantPricingSettings. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchUser. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
allowDeletedstringnonullIf true, deleted users may be returned.
userIdstringyesUser ID (UUID).

[Acronis Cyber Protect Cloud] FetchUserAccessPolicies. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
includeUserGroupPoliciesstringnonullIf set true, security group policies will be included in response.
userIdstringyesUser ID (UUID).

[Acronis Cyber Protect Cloud] CheckLoginNameAvailability. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES username on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
usernamestringyesREQUIRED. A login name to check.

[Acronis Cyber Protect Cloud] FetchCurrentUserInfo. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). USER-SESSION ONLY: Acronis refuses this endpoint for the API-client token StackJack authenticates with (401, authN flags do not match, have API client), so it cannot succeed on a StackJack connection whatever rights the client has. To identify the calling API client and the tenant it belongs to, call acronis_get_client with the connector's client id instead.

[Acronis Cyber Protect Cloud] FetchApplications. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

[Acronis Cyber Protect Cloud] FetchClientsBatch. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
allowDeletedstringnonullIf true, info for deleted clients may be returned.
originIdstringnonullA filter by clients origin ID. Can be used together with uuids or separately.
uuidsstringnonullA filter by comma-separated list of client's UUIDs.

[Acronis Cyber Protect Cloud] FetchInfrastructuresBatch. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES uuids on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
uuidsstringyesREQUIRED. Comma-separated list of infrastructures' UUIDs.

[Acronis Cyber Protect Cloud] FetchLocationInfrastructures. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
locationIdstringyesInfrastructures location ID (UUID).

[Acronis Cyber Protect Cloud] FetchInfrastructuresLocationsBatch. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES uuids on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
uuidsstringyesREQUIRED. Comma-separated list of infrastructures locations' UUIDs.

[Acronis Cyber Protect Cloud] Search. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Acronis REQUIRES tenant, text on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. Pass limit to bound the result set (capped at 1000).

ParamTypeRequiredDefaultDescription
allowDeletedstringnonullIf true, deleted tenants and users may be returned.
limitintegerno100Limit the number of found objects. Capped at 1000.
tenantstringyesREQUIRED. An ID of the tenant where the search will be performed.
textstringyesREQUIRED. Search in all available properties for the supplied text.

[Acronis Cyber Protect Cloud] FetchAvailableTenantApplications. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
forUistringnonullIf true, the list of applications will be returned in a form that is appropriate for the UI. Currently, applications on a grace period will be filtered out.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchTenantChildren. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
afterstringnonullCursor to fetch the next children page. The cursor encodes all the filtering and sorting arguments, thus client does not need to provide all them for the next page, only cursor should be provided. Client can get the cursor from `paging.cursors.after` field of the previous page response.
allowDeletedstringnonullIf true, children may be returned.
orderstringnonullOrders the result by one of parameters: `as_is`, `name`, `status`, `usage`. Reverse order can be performed using the `-` operator before the parameter. For order by `usage`, the usage name should be specified after a dot, e.g. `usage.workstations`. For storage-dependent usages, the storage UUID should be added after a dot, e.g. `usage.storage.c05d399b-ba6b-41e9-a638-cd7ffc7ec87a`.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchTenantInfrastructureLocations. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchTenantOfferingItems. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts status, include_secondary, type here.

ParamTypeRequiredDefaultDescription
availableOnlystringnonullIf true, return only infrastructures and offering items available for the enablement according to internal business rules.
editionstringnonullA filter of the offering items by edition. If "*" is provided, all editions will be returned. Offering items without an edition are not filtered out in any case.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"status":"..."}. Acronis accepts status, include_secondary, type on this endpoint.
forUistringnonullIf true, the list of offering items will be returned in a form that is appropriate for the UI. Currently, offering items on a grace period will be filtered out.
infraUuidstringnonullA filter by infrastructure UUID.
tenantIdstringyesTenant ID (UUID).
usageNamesstringnonullA filter by comma-separated list of usage names.
ParamTypeRequiredDefaultDescription
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchTenantReports. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchTenantUsages. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
editionsstringnonullA filter by comma-separated list of editions.
tenantIdstringyesTenant ID (UUID).
usageNamesstringnonullA filter by comma-separated list of usage names.

[Acronis Cyber Protect Cloud] FetchTenantUsers. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status).

ParamTypeRequiredDefaultDescription
allowDeletedstringnonullIf true, deleted users may be returned.
includeGrandChildrenstringnonullIf true for a customer tenant, the UUIDs of the users from all nested unit tenants will be included in the response. If true for a non customer tenant, the UUIDs of the users from all nested folder tenants will be included in the response.
includeHiddenstringnonullIf true, hidden users may be included in the response.
orderstringnonullOrders the result by one of parameters: `as_is`, `login`, `status`, `name`, `roles`, `level`, `usage`, `mfa_status`, `contact_types`. Reverse order can be performed using the `-` operator before the parameter. To order by `usage`, the usage name should be specified after a dot, e.g. `usage.workstations`. For storage-dependent usages, the storage UUID is not required.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] FetchTenantsBatch. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts with_contacts, with_offering_items, with_infra_offering_items, expand_offering_items, include_relative_path, allow_deleted here.

ParamTypeRequiredDefaultDescription
afterstringnonullCursor to fetch the next tenants page. The cursor encodes all the filtering and sorting arguments, thus client does not need to provide all them for the next page, only cursor should be provided. Client can get the cursor from `paging.cursors.after` field of the previous page response.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"with_contacts":"..."}. Acronis accepts with_contacts, with_offering_items, with_infra_offering_items, expand_offering_items, include_relative_path, allow_deleted on this endpoint.
limitintegerno100Number of elements to return in current offering items page of the response. Capped at 1000.
lodstringnonullA predefined level of details for the tenant object to return. The following levels of details can be specified: - `stamps` - includes `id`, `parent_id`, `version`, `created_at`, `updated_at`, `deleted_at`, `contacts`, `offering_items`. - `basic` - includes all stamps fields plus `name`, `kind`, `enabled`.
parentIdstringnonullThe UUID of a tenant which child tenants will be fetched. Is mutually exclusive with `subtree_root_id` and `uuids`.
subtreeRootIdstringnonullFilter to fetch tenants hierarchy starting from (including) the specified one. Sorting by tenant level is always assumed. Is mutually exclusive with `uuids` and `parent_id`.
updatedSincestringnonullA filter by tenants that were updated after the specified RFC3339 timestamp in UTC time zone.
uuidsstringnonullA filter by comma-separated list of tenants' UUIDs. Maximum of 100 UUIDs. Is mutually exclusive with `subtree_root_id` and `parent_id`.

[Acronis Cyber Protect Cloud] FetchTenantsApplicationsBatch. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Acronis REQUIRES tenants on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
tenantsstringyesREQUIRED. A filter of applications by comma-separated list of tenants' UUIDs.

[Acronis Cyber Protect Cloud] FetchTenantOfferingItemsBatch. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES subtreeRootTenantId on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts allow_deleted here.

ParamTypeRequiredDefaultDescription
afterstringnonullCursor to fetch the next offering items page. The cursor encodes all the filtering and sorting arguments, thus client does not need to provide all them for the next page, only cursor should be provided. Client can get the cursor from `paging.cursors.after` field of the previous page response.
editionsstringnonullA filter of offering items by comma-separated list of editions.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"allow_deleted":"..."}. Acronis accepts allow_deleted on this endpoint.
limitintegerno100Number of elements to return in current offering items page of the response. Capped at 1000.
offeringItemsstringnonullA filter of offering items by comma-separated offering item names.
subtreeRootTenantIdstringyesREQUIRED. A filter by tenants tree starting from the specified tenant ID. Sorting by tenant level is always assumed.
updatedSincestringnonullA filter by offering items that were updated after the specified RFC3339 timestamp in UTC time zone.
usageNamesstringnonullA filter of offering items by comma-separated list of usage names.

[Acronis Cyber Protect Cloud] FetchTenantsUsagesBatch. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Acronis REQUIRES tenants on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
editionsstringnonullA filter of usages by comma-separated list of editions.
tenantsstringyesREQUIRED. A filter of usages by comma-separated list of tenants' UUIDs.
usageNamesstringnonullA filter of usages by comma-separated list of usage names.

[Acronis Cyber Protect Cloud] FetchUsersBatch. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts lod, with_access_policies, allow_deleted, inside_organization, access_policies, tenant_kinds, target_tenant_id here.

ParamTypeRequiredDefaultDescription
afterstringnonullCursor to fetch the next users page. The cursor encodes all the filtering and sorting arguments, thus client does not need to provide all them for the next page, only cursor should be provided. Client can get the cursor from `paging.cursors.after` field of the previous page response.
externalIdsstringnonullA filter by comma-separated list of users' UUIDs in the external Identity Provider. Maximum of 100 UUIDs. Is mutually exclusive with `subtree_root_tenant_id` and `uuids`.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"lod":"..."}. Acronis accepts lod, with_access_policies, allow_deleted, inside_organization, access_policies, tenant_kinds, target_tenant_id on this endpoint.
limitintegerno100Number of elements in current users page of the response. Capped at 1000.
originIdstringnonullA filter by specific origin ID
subtreeRootTenantIdstringnonullA filter by tenants tree starting from the specified tenant ID. Is mutually exclusive with `uuids` and `tenant_id`.
tenantIdstringnonullA filter by specific tenant ID. Required when searching the users by `external_id`. Not used otherwise.
updatedSincestringnonullA filter by users that were updated after the specified RFC3339 timestamp in UTC time zone.
uuidsstringnonullA filter by comma-separated list of users' UUIDs. Maximum of 100 UUIDs. Is mutually exclusive with `subtree_root_tenant_id`, `external_ids` and `tenant_id`.

[Acronis Cyber Protect Cloud] RestoreDeletedTenant. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
forcestringnonullDefines if tenant should be restored in in case of a conflict with another tenant or user who has taken the same name or login. In such a case restored tenant will have postfix added.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] RestoreDeletedUser. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
enablestringnonullDefines if the user should be re-enabled.
forcestringnonullDefines if the user should be restored in case of a conflict with another user who has taken the same login. In such a case restored user will have a postfix added.
userIdstringyesUser ID (UUID).

[Acronis Cyber Protect Cloud] SendActivationEmail. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
userIdstringyesUser ID (UUID).

[Acronis Cyber Protect Cloud] SetUserPassword. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
userIdstringyesUser ID (UUID).

[Acronis Cyber Protect Cloud] SwitchTenantEdition. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] UpdateTenantApplicationSetting. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
applicationIdstringyesApplication ID (UUID).
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
settingNamestringyesA name of the application's setting.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] UpdateClient. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
clientIdstringyesClient ID (UUID).
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] UpdateInfrastructure. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
infraIdstringyesInfrastructure component ID (UUID).

[Acronis Cyber Protect Cloud] UpdateInfrastructuresLocation. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
locationIdstringyesInfrastructures location ID (UUID).

[Acronis Cyber Protect Cloud] UpdateReport. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
reportIdstringyesReport ID (UUID)

[Acronis Cyber Protect Cloud] UpdateTenant. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] ModifyCustomBranding. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Acronis REQUIRES version on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringyesTenant ID (UUID).
versionstringyesREQUIRED. Growing number of object internal version.

[Acronis Cyber Protect Cloud] UpdateTenantDefaultIdpId. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] ManageTenantMFAStatus. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] SetTenantOfferingItems. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] UpdateTenantOfferingItemsPrices. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] UpdateTenantPricingSettings. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringyesTenant ID (UUID).

[Acronis Cyber Protect Cloud] UpdateTenantsUsages. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] UpdateUser. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
userIdstringyesUser ID (UUID).

[Acronis Cyber Protect Cloud] UpdateUserAccessPolicies. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
userIdstringyesUser ID (UUID).

[Acronis Cyber Protect Cloud] ManageUserMFAStatus. Served by the Account Management API (tenant tree, users, offering items, quotas, usage, pricing, reports, branding and MFA status). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
userIdstringyesUser ID (UUID).

Vaults, Archives and Backups

ToolPlanAccessSummary
acronis_change_vault_credentialsProDestructiveReplace the credentials Acronis uses to reach the storage behind a vault.
acronis_change_vault_passwordProDestructiveChange the encryption password of an encrypted vault, supplying the current password and the new one.
acronis_check_storage_node_user_accessFreeRead-onlyCheck whether a user account can reach a storage node.
acronis_create_storage_nodesProWriteRegister a storage node with the Vault Manager, so vaults can be created on it.
acronis_create_vaultsProWriteCreate a vault, or attach a storage location that already holds backups as a vault.
acronis_delete_abgw_storageProDestructiveUnregister an Acronis Backup Gateway storage.
acronis_delete_archivesProDestructiveDelete backup archives belonging to one protected resource.
acronis_delete_backupsProDestructiveDelete individual backups, that is single recovery points, belonging to one protected resource.
acronis_delete_vaultProDestructiveDelete one vault by ID.
acronis_delete_vault_archive_backupsProDestructiveDelete named recovery points from one archive in one vault.
acronis_delete_vault_archive_backups_by_idProDestructiveDelete recovery points from one archive in one vault, naming them in the request body.
acronis_delete_vault_archivesProDestructiveDelete named archives held in one vault.
acronis_find_vault_by_storage_locationFreeRead-onlyFind which vault occupies a storage path on a storage node.
acronis_get_antimalware_scan_statsFreeRead-onlyFetch antimalware scan statistics for backups, which is how you show that backed-up data was scanned for malware.
acronis_get_healthcheckFreeRead-onlyCheck that the Acronis Vault Manager service is answering.
acronis_get_search_index_size_statFreeRead-onlyFetch the size of the archive search index for one tenant.
acronis_get_storage_dir_by_pathFreeRead-onlyList the storage folders under one path on a storage.
acronis_get_storage_dir_by_storageFreeRead-onlyList the top-level storage folders on a storage.
acronis_get_storage_usage_statsFreeRead-onlyFetch how much storage the vaults consume, which is the figure an MSP bills and capacity-plans from.
acronis_get_vaultFreeRead-onlyFetch one vault by ID.
acronis_get_vault_archive_backupFreeRead-onlyFetch one backup, that is one recovery point, from an archive in a vault.
acronis_get_vault_archive_replication_statusFreeRead-onlyFetch the geo-replication status of an archive, which tells you whether its backups reached the second location.
acronis_get_vault_configFreeRead-onlyFetch the configuration of one vault.
acronis_get_vault_statsFreeRead-onlyFetch the statistics of one vault, including how much of its capacity is used.
acronis_get_vault_vault_archive_statsFreeRead-onlyFetch archive statistics across the Vault Manager.
acronis_list_archive_backupsFreeRead-onlyList the recovery points in one archive, wherever that archive lives in the partner scope.
acronis_list_archivesFreeRead-onlyList archives across the partner scope.
acronis_list_backed_up_resourcesFreeRead-onlyList the resources that actually hold backup data, which answers which machines are protected rather than merely licensed.
acronis_list_backupsFreeRead-onlyList backups, that is recovery points, across the partner scope.
acronis_list_storage_nodesFreeRead-onlyList the storage nodes registered with the Vault Manager.
acronis_list_vault_agentsFreeRead-onlyList the protection agents that use one vault.
acronis_list_vault_archive_backup_timestampsFreeRead-onlyList only the timestamps of the recovery points in an archive, which is the cheap way to draw a backup calendar without pulling every backup record.
acronis_list_vault_archive_backupsFreeRead-onlyList the recovery points in one archive in one vault.
acronis_list_vault_archivesFreeRead-onlyList the archives held in one vault.
acronis_list_vaultsFreeRead-onlyList the vaults, that is the backup storage destinations, in the partner scope.
acronis_refresh_vault_archivesProWriteAsk Acronis to re-read one vault from its storage, so the archive list reflects what is really on disk.
acronis_refresh_vaultsProWriteAsk Acronis to re-read every vault from its storage.
acronis_replace_vault_passwordProDestructiveOverwrite the stored password of an encrypted vault.
acronis_update_vault_archive_backup_atf_validationProWriteRecord the result of an automated test failover against one recovery point.
acronis_update_vault_archive_backup_validation_statusProWriteRecord whether a check of one recovery point passed.
acronis_update_vault_configProWriteChange the configuration of one vault, sending only the fields you want changed.
acronis_update_vault_statsProWriteAsk Acronis to recompute the statistics of one vault.

[Acronis Cyber Protect Cloud] Replace the credentials Acronis uses to reach the storage behind a vault. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Read the vault with acronis_get_vault and its settings with acronis_get_vault_config before you change anything. DESTRUCTIVE: the new pair replaces the stored one immediately. Credentials the storage rejects leave every archive in the vault unreachable, and StackJack cannot put the previous pair back.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Change the encryption password of an encrypted vault, supplying the current password and the new one. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Compare with acronis_replace_vault_password, which overwrites the stored password without proving the current one. DESTRUCTIVE: the password protects the encryption key of the vault. Acronis cannot recover data in an encrypted vault whose password is lost, so record the new password before you send this.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Check whether a user account can reach a storage node. This is a POST that only reads: the account to test travels in the request body, which is why it is not a GET. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Find the node IDs with acronis_list_storage_nodes.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
storageNodeIDstringyesThe Acronis storageNodeID.

[Acronis Cyber Protect Cloud] Register a storage node with the Vault Manager, so vaults can be created on it. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Check what is already registered with acronis_list_storage_nodes.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Create a vault, or attach a storage location that already holds backups as a vault. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Run acronis_list_vaults first so an attach does not duplicate a vault that is already registered.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Unregister an Acronis Backup Gateway storage. ABGW in the path is the vendor abbreviation for that gateway. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). DESTRUCTIVE: unregistering the gateway detaches every vault served through it, so agents can no longer write backups to it or restore from it. Confirm the target with acronis_list_vaults and acronis_get_vault first.

ParamTypeRequiredDefaultDescription
lastSeenAtstringnonullDate and time in RFC 3339 when the storage was last seen.
storageIDstringyesThe Acronis storageID.
tenantIDstringnonullTenant ID (where the vault will be removed from) to separate the target tenant from the effective one

[Acronis Cyber Protect Cloud] Delete backup archives belonging to one protected resource. DESTRUCTIVE: every backup inside a matched archive goes with it and nothing in StackJack can bring it back. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Acronis REQUIRES resourceId and changeTag on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank, and setting either to null inside filtersJson is refused for the same reason. resourceId is the machine whose archives are destroyed, so this is not a partner-wide sweep unless you point it at each resource in turn. Narrow it further with vaultId. Run acronis_list_archives for the same resource first and read the result, because one call destroys the whole backup history of that machine.

ParamTypeRequiredDefaultDescription
changeTagstringyesREQUIRED. Tag for run tasks.
clusterIdstringnonullLimit affinity to this cluster.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"targetAgentId":"..."}. Acronis accepts targetAgentId on this endpoint.
locationCredentialsIdstringnonullID of credentials to access vault.
resourceIdstringyesREQUIRED. ID of resource.
vaultIdstringnonullID of vault.

[Acronis Cyber Protect Cloud] Delete individual backups, that is single recovery points, belonging to one protected resource. DESTRUCTIVE: each matched recovery point is removed permanently, so a restore to that point in time becomes impossible. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Acronis REQUIRES resourceID on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave it blank, and setting it to null inside filtersJson is refused for the same reason. Confirm the exact set with acronis_list_backups for the same resource first.

ParamTypeRequiredDefaultDescription
changeTagstringnonullTag for run tasks.
resourceIDstringyesREQUIRED. ID of resource.

[Acronis Cyber Protect Cloud] Delete one vault by ID. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). DESTRUCTIVE: deleting a vault removes the storage destination and every archive it holds. Read acronis_get_vault and acronis_list_vault_archives first, and check acronis_list_vault_agents, because agents still pointed at the vault fail their next backup.

ParamTypeRequiredDefaultDescription
tenantIDstringnonullTenant ID (where the vault will be removed from) to separate the target tenant from the effective one
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Delete named recovery points from one archive in one vault. This tool and acronis_delete_vault_archive_backups_by_id are two spellings of the SAME destructive act, published twice by Acronis; the difference is the request shape, never the blast radius. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). DESTRUCTIVE: the named recovery points are deleted permanently from the archive. Acronis REQUIRES backupId and changeTag on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank, and setting either to null inside filtersJson is refused for the same reason. backupId is what limits the call to the recovery points you named rather than the whole archive. List them with acronis_list_vault_archive_backups first.

ParamTypeRequiredDefaultDescription
archiveIDstringyesThe Acronis archiveID.
backupIdstringyesREQUIRED. IDs of backups.
changeTagstringyesREQUIRED. Tag for run tasks.
tenantIdstringnonullTenant ID to reduce the scope.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Delete recovery points from one archive in one vault, naming them in the request body. This is NOT a narrower or safer sibling of acronis_delete_vault_archive_backups: Acronis publishes the same delete twice, once as a DELETE with query filters and once as this POST with a body, and both destroy the same data. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: every recovery point named in the body is deleted permanently from the archive. Confirm each ID with acronis_list_vault_archive_backups or acronis_get_vault_archive_backup first.

ParamTypeRequiredDefaultDescription
archiveIDstringyesThe Acronis archiveID.
backupIDstringnonullBackup ID to delete.
changeTagstringnonullTag for run tasks.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringnonullTenant ID to reduce the scope.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Delete named archives held in one vault. DESTRUCTIVE: every backup in each named archive goes with it. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Acronis REQUIRES changeTag and archiveId on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank, and setting either to null inside filtersJson is refused for the same reason. archiveId is what limits the call to the archives you named rather than the whole vault, so read acronis_list_vault_archives first and confirm each id.

ParamTypeRequiredDefaultDescription
archiveIdstringyesREQUIRED. ID of archive.
changeTagstringyesREQUIRED. Tag for run tasks.
clusterIdstringnonullLimit affinity to this cluster.
locationCredentialsIdstringnonullID of credentials to access vault.
targetAgentIdstringnonullID of the agent to execute the task.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Find which vault occupies a storage path on a storage node. This is a POST that only reads: the path travels in the request body. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Follow up with acronis_get_vault for the full vault record.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
storageNodeIDstringyesThe Acronis storageNodeID.

[Acronis Cyber Protect Cloud] Fetch antimalware scan statistics for backups, which is how you show that backed-up data was scanned for malware. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation).

ParamTypeRequiredDefaultDescription
archiveTypestringnonullShow only backups of specified archive types.
createdstringnonullShow backups created only within specified time range.

[Acronis Cyber Protect Cloud] Check that the Acronis Vault Manager service is answering. This reports the health of the vendor service, not the state of any customer vault; for that use acronis_get_vault_stats. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation).

[Acronis Cyber Protect Cloud] Fetch the size of the archive search index for one tenant. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Discover tenant IDs with acronis_list_tenants.

ParamTypeRequiredDefaultDescription
archiveNamestringnonullArchive Name.
tenantIDstringyesThe Acronis tenantID.

[Acronis Cyber Protect Cloud] List the storage folders under one path on a storage. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Use acronis_get_storage_dir_by_storage for the top level of the same storage.

ParamTypeRequiredDefaultDescription
includeAttachedstringnonullList all folders including the ones attached to vaults.
pathstringyesThe Acronis path.
storageIDstringyesThe Acronis storageID.

[Acronis Cyber Protect Cloud] List the top-level storage folders on a storage. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Drill into one of them with acronis_get_storage_dir_by_path.

ParamTypeRequiredDefaultDescription
includeAttachedstringnonullList all folders including attached to vaults.
storageIDstringyesThe Acronis storageID.

[Acronis Cyber Protect Cloud] Fetch how much storage the vaults consume, which is the figure an MSP bills and capacity-plans from. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation).

[Acronis Cyber Protect Cloud] Fetch one vault by ID. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Find the ID with acronis_list_vaults, read its settings with acronis_get_vault_config and its size with acronis_get_vault_stats.

ParamTypeRequiredDefaultDescription
includeActionsstringnonullCalculate and include possible actions in the response.
includeLastBackupTimestringnonullCalculate and include vault last backup time.
includeStatsstringnonullCalculate and include vault stats.
includeStorageStatsstringnonullInclude storage-side stats about vault calculated at DC and return them in the `immutable_size` field. If false or not specified, the `immutable_size` field will not be included in the response data.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Fetch one backup, that is one recovery point, from an archive in a vault. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). List the recovery points first with acronis_list_vault_archive_backups.

ParamTypeRequiredDefaultDescription
archiveIDstringyesThe Acronis archiveID.
backupIDstringyesThe Acronis backupID.
embedstringnonullAn 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.
showDeletedstringnonullA flag that specifies if the backup must be returned: * 1 - All backups belonging to alive, deleted or immutable archives are taken into account. * 2 - (Default) Only backups belonging to alive or immutable are returned. * 3 - Only backup belonging to deleted archives are returned. * 0 - Backups belonging to deleted or immutable archives are not returned.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Fetch the geo-replication status of an archive, which tells you whether its backups reached the second location. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation).

ParamTypeRequiredDefaultDescription
archiveIDstringyesThe Acronis archiveID.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Fetch the configuration of one vault. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Change it with acronis_update_vault_config.

ParamTypeRequiredDefaultDescription
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Fetch the statistics of one vault, including how much of its capacity is used. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation).

ParamTypeRequiredDefaultDescription
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Fetch archive statistics across the Vault Manager. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Do not confuse this with acronis_get_alert_vault_archive_stats, which has a near-identical name but counts ALERTS in the Alert Manager API.

ParamTypeRequiredDefaultDescription
resourceIDstringnonullGet statistics only for Archives that contain backups for specified resources.
storageTypestringnonullGet statistics only for Archives in vaults of specified storage types.

[Acronis Cyber Protect Cloud] List the recovery points in one archive, wherever that archive lives in the partner scope. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts showDeleted, targetAgentId, triggeredBy, order, includeActions, backupType, vulnerabilityAssessmentStatus, changeTag, avScanningDate, malwareAssessmentStatus, created here. Vault Manager also accepts an offset alongside those cursors, which most Acronis families do not. Use acronis_list_vault_archive_backups when you already know the vault.

ParamTypeRequiredDefaultDescription
afterstringnonullBase64-encoded token obtained from the previous response. Points to the start of the page.
archiveIDstringyesThe Acronis archiveID.
beforestringnonullBase64-encoded token obtained from the previous response. Points to the end of the page.
countstringnonullShow total count in the response.
embedstringnonullAn 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.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"showDeleted":"..."}. Acronis accepts showDeleted, targetAgentId, triggeredBy, order, includeActions, backupType, vulnerabilityAssessmentStatus, changeTag, avScanningDate, malwareAssessmentStatus, created on this endpoint.
limitintegerno100Limit the number of elements to return in one page. Capped at 1000.
offsetintegerno0The number of elements to skip before beginning to return elements.
protectedByPasswordstringnonullShow only backups in protected by password or unprotected by password archives. If not specified, backups are listed regardless of their password protection status.
resourceIdstringnonullShow only backups for specified resources.
tapeIdstringnonullShow only backups for specified tapes.

[Acronis Cyber Protect Cloud] List archives across the partner scope. One archive is the backup chain of a single protected resource. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts name, wildcard, resourceId, storageType, type, format, backupPlanId, centralizedPlanId, includeCatalogInfo, forensic, includePrePatchManagement, prePatchManagementOnly, includeMalwareFound, malwareFound, and more here. Vault Manager also accepts an offset alongside those cursors, which most Acronis families do not. Narrow to one vault with acronis_list_vault_archives.

ParamTypeRequiredDefaultDescription
afterstringnonullBase64-encoded token obtained from the previous response. Points to the start of the page.
agentIdstringnonullShow a list of archives of specified agent ID.
archiveIdstringnonullShow a list of archives of specified archive IDs.
beforestringnonullBase64-encoded token obtained from the previous response. Points to the end of the page.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"name":"..."}. Acronis accepts name, wildcard, resourceId, storageType, type, format, backupPlanId, centralizedPlanId, includeCatalogInfo, forensic, includePrePatchManagement, prePatchManagementOnly, includeMalwareFound, malwareFound on this endpoint.
includeStatsstringnonullInclude additional information about archive. If false or not specified, the `stats` field will not be included in the response data.
includeStorageStatsstringnonullInclude storage-side stats about archive calculated at DC and return them in the `immutable_size` field. If false or not specified, the `immutable_size` field will not be included in the response data.
limitintegerno100Limit the number of elements to return in one page. Capped at 1000.
offsetintegerno0The number of elements to skip before beginning to return elements.
showDeletedstringnonullA flag that specifies what should be added to the list of returned archives: * 1 - All deleted archives are added to the list of archives. * 2 - Only deleted archives marked as immutable are added to the list of archives. * 3 - Only deleted archives are included to the list of archives, other ones are excluded. * 0 - No deleted archives are added to the list of archives.

[Acronis Cyber Protect Cloud] List the resources that actually hold backup data, which answers which machines are protected rather than merely licensed. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts order here. Vault Manager also accepts an offset alongside those cursors, which most Acronis families do not. Cross-check policy coverage with acronis_list_resource_statuses.

ParamTypeRequiredDefaultDescription
afterstringnonullBase64-encoded token obtained from the previous response. Points to the start of the page.
archiveIdstringnonullID of archive to search backups for.
beforestringnonullBase64-encoded token obtained from the previous response. Points to the end of the page.
countstringnonullShow total count in the response.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"order":"..."}. Acronis accepts order on this endpoint.
limitintegerno100Limit the number of elements to return in one page. Capped at 1000.
offsetintegerno0The number of elements to skip before beginning to return elements.
showDeletedstringnonullA flag that specifies what should be added to the list of returned returned backed up resources: * 1 - Resources contained in live and deleted archives. * 2 - Resources contained only in live and immutable archives. * 3 - Resources contained in deleted archives only. * 0 - Resources contained in live archives only.
tapeIdstringnonullFilter backups for specified tapes.
vaultIdstringnonullID of vault to search backups for.

[Acronis Cyber Protect Cloud] List backups, that is recovery points, across the partner scope. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts storageType, storageId, forensic, resourceId, changeTag, showDeleted, embed, created, protectedByPassword, backupType, tapeId, triggeredBy, avScanningDate, vulnerabilityAssessmentStatus, and more here. Vault Manager also accepts an offset alongside those cursors, which most Acronis families do not. Delete a selected set with acronis_delete_backups.

ParamTypeRequiredDefaultDescription
afterstringnonullBase64-encoded token obtained from the previous response. Points to the start of the page.
agentIdstringnonullShow only backups for specified agent.
beforestringnonullBase64-encoded token obtained from the previous response. Points to the end of the page.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"storageType":"..."}. Acronis accepts storageType, storageId, forensic, resourceId, changeTag, showDeleted, embed, created, protectedByPassword, backupType, tapeId, triggeredBy, avScanningDate, vulnerabilityAssessmentStatus on this endpoint.
limitintegerno100Limit the number of elements to return in one page. Capped at 1000.
offsetintegerno0The number of elements to skip before beginning to return elements.
regtimestringnonullShow only backups created or deleted within specified time range.
typestringnonullShow only backups of specified archive types.
updatedstringnonullShow only backups updated within specified time range.
vaultIdstringnonullID of vault to search archives for.

[Acronis Cyber Protect Cloud] List the storage nodes registered with the Vault Manager. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation).

[Acronis Cyber Protect Cloud] List the protection agents that use one vault. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Read this before acronis_delete_vault, because these agents lose their backup destination.

ParamTypeRequiredDefaultDescription
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] List only the timestamps of the recovery points in an archive, which is the cheap way to draw a backup calendar without pulling every backup record. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts created here. Vault Manager also accepts an offset alongside those cursors, which most Acronis families do not.

ParamTypeRequiredDefaultDescription
afterstringnonullBase64-encoded token obtained from the previous response. Points to the start of the page.
archiveIDstringyesThe Acronis archiveID.
beforestringnonullBase64-encoded token obtained from the previous response. Points to the end of the page.
countstringnonullShow total count in the response.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"created":"..."}. Acronis accepts created on this endpoint.
granularitystringnonullGranularity interval of grouped backups in seconds.
limitintegerno100Limit the number of elements to return in one page. Capped at 1000.
offsetintegerno0The number of elements to skip before beginning to return elements.
resourceIdstringnonullShow timestamps only for specified resource.
showDeletedstringnonullA flag that specifies what kind of deleted backups should participate in timestamps calculation: * 1 - All deleted backups are participating in calculation. * 2 - Only deleted backups marked as immutable are participating in calculation. * 0 - No deleted backups are participating in calculation.
tzOffsetstringnonullTimezone difference from current timezone to UTC in minutes.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] List the recovery points in one archive in one vault. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts showDeleted, targetAgentId, triggeredBy, order, includeActions, backupType, vulnerabilityAssessmentStatus, changeTag, avScanningDate, malwareAssessmentStatus, created here. Vault Manager also accepts an offset alongside those cursors, which most Acronis families do not. Fetch one of them with acronis_get_vault_archive_backup.

ParamTypeRequiredDefaultDescription
afterstringnonullBase64-encoded token obtained from the previous response. Points to the start of the page.
archiveIDstringyesThe Acronis archiveID.
beforestringnonullBase64-encoded token obtained from the previous response. Points to the end of the page.
countstringnonullShow total count in the response.
embedstringnonullAn 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.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"showDeleted":"..."}. Acronis accepts showDeleted, targetAgentId, triggeredBy, order, includeActions, backupType, vulnerabilityAssessmentStatus, changeTag, avScanningDate, malwareAssessmentStatus, created on this endpoint.
limitintegerno100Limit the number of elements to return in one page. Capped at 1000.
offsetintegerno0The number of elements to skip before beginning to return elements.
protectedByPasswordstringnonullShow only backups in protected by password or unprotected by password archives. If not specified, backups are listed regardless of their password protection status.
resourceIdstringnonullShow only backups for specified resources.
tapeIdstringnonullShow only backups for specified tapes.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] List the archives held in one vault. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts count, agentId, wildcard, forensic, storageType, orphanage.status, includeStats, includePrePatchManagement, showDeleted, targetAgentId, malwareFound, includeStorageStats, order, includeActions, and more here. Vault Manager also accepts an offset alongside those cursors, which most Acronis families do not. If the list looks stale, run acronis_refresh_vault_archives first.

ParamTypeRequiredDefaultDescription
afterstringnonullBase64-encoded token obtained from the previous response. Points to the start of the page.
beforestringnonullBase64-encoded token obtained from the previous response. Points to the end of the page.
centralizedPlanIdstringnonullShow only archives created by centralized plan with specified ID.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"count":"..."}. Acronis accepts count, agentId, wildcard, forensic, storageType, orphanage.status, includeStats, includePrePatchManagement, showDeleted, targetAgentId, malwareFound, includeStorageStats, order, includeActions on this endpoint.
formatstringnonullShow a list of Archives of specified formats.
includeOrphanagestringnonullInclude orphanage status of archive. If false or not specified, the `orphanage` object will not be included in the response data.
limitintegerno100Limit the number of elements to return in one page. Capped at 1000.
namestringnonullShow 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.
offsetintegerno0The number of elements to skip before beginning to return elements.
resourceIdstringnonullShow only archives that contain backups for at least one resource from the specified list.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] List the vaults, that is the backup storage destinations, in the partner scope. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Paginated: pass limit (capped at 1000) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts resourceId, uri, type, storageId, connectionID, accessibleForAgent, tenantId, query, includeStats, includeStorageStats, includeLastBackupTime, includeActions, includeDeleted, count, and more here. Vault Manager also accepts an offset alongside those cursors, which most Acronis families do not. Fetch one vault with acronis_get_vault.

ParamTypeRequiredDefaultDescription
afterstringnonullBase64-encoded token obtained from the previous response. Points to the start of the page.
beforestringnonullBase64-encoded token obtained from the previous response. Points to the end of the page.
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"resourceId":"..."}. Acronis accepts resourceId, uri, type, storageId, connectionID, accessibleForAgent, tenantId, query, includeStats, includeStorageStats, includeLastBackupTime, includeActions, includeDeleted, count on this endpoint.
hostnamestringnonullFilter vaults by hostname. Supports matching any number of characters using asterisk wildcard character.
idstringnonullIDs of vaults to fetch. Multiple values can be specified by repeating the query parameter.
limitintegerno100Limit the number of elements to return in one page. Capped at 1000.
managedstringnonullShow only managed or unmanaged vaults. If not specified, all types of vaults are listed.
namestringnonullFilter vaults by name. Supports matching any number of characters using asterisk wildcard character.
offsetintegerno0The number of elements to skip before beginning to return elements.
storageNodeIdstringnonullID of Storage node to search vaults for.

[Acronis Cyber Protect Cloud] Ask Acronis to re-read one vault from its storage, so the archive list reflects what is really on disk. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Read the refreshed list with acronis_list_vault_archives.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Ask Acronis to re-read every vault from its storage. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Read the refreshed list with acronis_list_vaults.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Overwrite the stored password of an encrypted vault. Unlike acronis_change_vault_password, this replaces the stored password instead of proving the current one first. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: a wrong value leaves the vault encrypted with a key nobody holds, and Acronis cannot recover the data. Confirm the vault with acronis_get_vault before you send this.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Record the result of an automated test failover against one recovery point. It stamps a validation status onto the backup and replaces no backup data, which is why it is not marked destructive. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
archiveIDstringyesThe Acronis archiveID.
backupIDstringyesThe Acronis backupID.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Record whether a check of one recovery point passed. It stamps a status onto the backup and leaves the backup data untouched, which is why it is not marked destructive. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
archiveIDstringyesThe Acronis archiveID.
backupIDstringyesThe Acronis backupID.
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Change the configuration of one vault, sending only the fields you want changed. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Read the current values with acronis_get_vault_config first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
vaultIDstringyesThe Acronis vaultID.

[Acronis Cyber Protect Cloud] Ask Acronis to recompute the statistics of one vault. Served by the Vault Manager API (vaults, archives, backups, storage nodes, storage usage, antimalware scan statistics and backup validation). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Read the result with acronis_get_vault_stats.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
vaultIDstringyesThe Acronis vaultID.

Disaster Recovery

ToolPlanAccessSummary
acronis_get_serverFreeRead-onlyFetch cloud server by UUID.
acronis_get_siteFreeRead-onlyFetch disaster recovery site by UUID.
acronis_list_serversFreeRead-onlyFetch cloud servers.
acronis_list_sitesFreeRead-onlyFetch disaster recovery sites.
acronis_start_server_production_failoverProDestructiveStart production failover on cloud server.
acronis_start_server_test_failoverProDestructiveStart test failover on cloud server.
acronis_stop_server_failoverProDestructiveStop failover on cloud server.

[Acronis Cyber Protect Cloud] Fetch cloud server by UUID. Served by the Disaster Recovery API (cloud recovery servers, recovery sites, and test or production failover).

ParamTypeRequiredDefaultDescription
uuidstringyesA unique identifier of the cloud server.

[Acronis Cyber Protect Cloud] Fetch disaster recovery site by UUID. Served by the Disaster Recovery API (cloud recovery servers, recovery sites, and test or production failover).

ParamTypeRequiredDefaultDescription
allowDeletedstringnonullIncludes resources that are marked as deleted in the request result.
uuidstringyesA unique identifier of the disaster recovery site.

[Acronis Cyber Protect Cloud] Fetch cloud servers. Served by the Disaster Recovery API (cloud recovery servers, recovery sites, and test or production failover). Paginated: pass limit (capped at 50) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after.

ParamTypeRequiredDefaultDescription
afterstringnonullToken from the 'after' field in the previous response. It contains a cursor that points to the next page of the requested collection. Mutually exclusive with the 'limit' and 'before' parameters. If provided, all other query parameters will be ignored.
beforestringnonullToken from the 'before' field in the previous response. It contains a cursor that points to the previous page of the requested collection. Mutually exclusive with the 'limit' and 'after' parameters. If provided, all other query parameters will be ignored.
limitintegerno100Maximum number of items to fetch per page. Mutually exclusive with the 'before' and 'after' parameters. Capped at 50.
recoveryResourceIdstringnonullFilters the recovery servers by the original device resource ID. Multiple entries are accepted.
typestringnonullFilters the cloud servers by type.

[Acronis Cyber Protect Cloud] Fetch disaster recovery sites. Served by the Disaster Recovery API (cloud recovery servers, recovery sites, and test or production failover). Paginated: pass limit (capped at 50) and, to advance, the after cursor echoed back in the previous response's paging.cursors.after.

ParamTypeRequiredDefaultDescription
afterstringnonullToken from the 'after' field in the previous response. It contains a cursor that points to the next page of the requested collection. Mutually exclusive with the 'limit' and 'before' parameters. If provided, all other query parameters will be ignored.
allowDeletedstringnonullIncludes resources that are marked as deleted in the request result.
beforestringnonullToken from the 'before' field in the previous response. It contains a cursor that points to the previous page of the requested collection. Mutually exclusive with the 'limit' and 'after' parameters. If provided, all other query parameters will be ignored.
limitintegerno100Maximum number of items to fetch per page. Mutually exclusive with the 'before' and 'after' parameters. Capped at 50.

[Acronis Cyber Protect Cloud] Start production failover on cloud server. Served by the Disaster Recovery API (cloud recovery servers, recovery sites, and test or production failover). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
uuidstringyesA unique identifier of the cloud server.

[Acronis Cyber Protect Cloud] Start test failover on cloud server. Served by the Disaster Recovery API (cloud recovery servers, recovery sites, and test or production failover). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
uuidstringyesA unique identifier of the cloud server.

[Acronis Cyber Protect Cloud] Stop failover on cloud server. Served by the Disaster Recovery API (cloud recovery servers, recovery sites, and test or production failover). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes or removes live Acronis data and cannot be undone from StackJack. Confirm the target with the matching read tool first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
uuidstringyesA unique identifier of the cloud server.

Event Stream

ToolPlanAccessSummary
acronis_create_event_subscriptionProWriteCreate event subscription.
acronis_get_event_subscription_offsetFreeRead-onlyFetch subscription offset.
acronis_get_event_topic_offsetsFreeRead-onlyFetch topic offsets.
acronis_list_event_topicsFreeRead-onlyFetch topics.
acronis_list_event_typesFreeRead-onlyFetch event types.
acronis_list_eventsFreeRead-onlyFetch events.

[Acronis Cyber Protect Cloud] Create event subscription. Served by the Event Manager API (platform event topics, event types, subscriptions and the event feed). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Fetch subscription offset. Served by the Event Manager API (platform event topics, event types, subscriptions and the event feed). Acronis REQUIRES subscriptionId on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
subscriptionIdstringyesREQUIRED. Required. Identifier of the subscription.

[Acronis Cyber Protect Cloud] Fetch topic offsets. Served by the Event Manager API (platform event topics, event types, subscriptions and the event feed). Acronis REQUIRES topicId, position on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
positionstringyesREQUIRED. Required, the position to fetch the offset for.
timestampstringnonullRequired for timestamp positions. Fetch the offset position to the neares future from a specific time. The timestamp is specified in ISO 8601 format using the RFC 3339 profile.
topicIdstringyesREQUIRED. Required, Topic ID to fetch the offset for.

[Acronis Cyber Protect Cloud] Fetch topics. Served by the Event Manager API (platform event topics, event types, subscriptions and the event feed).

ParamTypeRequiredDefaultDescription
topicIdstringnonullOptional. Specific topic ID to fetch. Wildcard is not supported.

[Acronis Cyber Protect Cloud] Fetch event types. Served by the Event Manager API (platform event topics, event types, subscriptions and the event feed).

ParamTypeRequiredDefaultDescription
includeSchemastringnonullOptional. Include the schema of the event type.
topicIdstringnonullOptional. Topic ID to fetch the event types for.
typeIdstringnonullOptional. Specific event type ID to fetch.

[Acronis Cyber Protect Cloud] Fetch events. Served by the Event Manager API (platform event topics, event types, subscriptions and the event feed). Acronis REQUIRES subscriptionId, consumerId on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. Paginated: pass limit (capped at 1000) with offset.

ParamTypeRequiredDefaultDescription
consumerIdstringyesREQUIRED. Required. Unique identifier for the consumer instance, ensuring event distribution among multiple instances.
limitintegerno100Optional. Limits the number of events returned in one response. Helps manage processing load. Capped at 1000.
offsetintegerno0Required. Specifies the starting point for event fetching, allowing instances to resume from a precise position.
subscriptionIdstringyesREQUIRED. Required. Identifier of the subscription under which events are being consumed. Used in conjunction with instance_id to manage event distribution.
timeoutstringnonullOptional. Time to wait for events to become available in ISO 8601 duration format. Can be decreased by the server to the session timeout of the subscription.

Price Lists

ToolPlanAccessSummary
acronis_list_effective_price_listsFreeRead-onlyFetch tenant's price lists.

[Acronis Cyber Protect Cloud] Fetch tenant's price lists. Served by the Pricelist API (a tenant's effective price lists). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Acronis REQUIRES tenantId, months on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank.

ParamTypeRequiredDefaultDescription
monthsstringyesREQUIRED. Array of months (format YYYY-MM) for which to retrieve price lists.
tenantIdstringyesREQUIRED. Tenant UUID to fetch prices for.

Advanced Automation (PSA)

ToolPlanAccessSummary
acronis_create_psa_ledgerProDestructiveCreate a ledger entry in Advanced Automation, the PSA built into Acronis.
acronis_create_psa_productProDestructiveCreate a product in the Advanced Automation catalog.
acronis_create_psa_sales_itemProDestructiveCreate a sales item in Advanced Automation.
acronis_create_psa_taxProDestructiveCreate one tax rate in Advanced Automation.
acronis_create_psa_taxes_bulkProDestructiveCreate several tax rates in one call.
acronis_create_psa_ticketProWriteCreate a ticket in Advanced Automation.
acronis_delete_psa_contract_partProDestructiveDelete a contract part, which is one line of a customer contract.
acronis_delete_psa_sales_itemsProDestructiveDelete a sales item, which is one billable line on a customer invoice.
acronis_delete_psa_taxesProDestructiveDelete a tax rate.
acronis_export_psa_invoicesProDestructiveExport PSA invoices to XML or CSV.
acronis_get_psa_callFreeRead-onlyFetch a ticket.
acronis_get_psa_contract_partFreeRead-onlyFetch one contract part, which is a single line of a customer contract.
acronis_get_psa_dashboard_dataFreeRead-onlyFetch the Advanced Automation dashboard figures.
acronis_get_psa_ledgerFreeRead-onlyFetch one ledger entry.
acronis_get_psa_productFreeRead-onlyFetch products from the Advanced Automation catalog.
acronis_get_psa_scheduler_ticketsFreeRead-onlyFetch ticket updates from the Advanced Automation scheduler.
acronis_get_psa_taxesFreeRead-onlyFetch the configured tax rates.
acronis_list_psa_contractsFreeRead-onlyList the contracts of one customer, selected by customer ID.
acronis_list_psa_invoice_overviewFreeRead-onlyList the invoice overview.
acronis_list_psa_ledgersFreeRead-onlyList ledger entries.
acronis_list_psa_prioritiesFreeRead-onlyList the ticket priorities configured in Advanced Automation.
acronis_list_psa_sales_itemsFreeRead-onlyList sales items, which are the billable lines Advanced Automation invoices from.
acronis_list_psa_slaFreeRead-onlyList the service level agreements configured in Advanced Automation.
acronis_list_psa_statusesFreeRead-onlyList the ticket statuses configured in Advanced Automation.
acronis_update_psa_invoiceProDestructiveUpdate an invoice.
acronis_update_psa_ticketProWritePost an update onto a ticket.
acronis_upsert_psa_contractProDestructiveCreate a contract, or update it when it already exists.
acronis_upsert_psa_contract_partProDestructiveCreate a contract part, or update it when it already exists.

[Acronis Cyber Protect Cloud] Create a ledger entry in Advanced Automation, the PSA built into Acronis. Watch the verb: Advanced Automation uses PUT to CREATE, so this adds an entry rather than updating one. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: a ledger entry is financial data that feeds invoicing, and there is no tool that deletes one again. Read acronis_list_psa_ledgers or acronis_get_psa_ledger first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Create a product in the Advanced Automation catalog. Advanced Automation uses PUT to CREATE, so this adds a product rather than updating one. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: products feed quoting and invoicing, so a wrong or duplicated product reaches customer billing. Check what already exists with acronis_get_psa_product first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Create a sales item in Advanced Automation. The PUT verb is a create here, not an update. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: sales items are billable lines on a customer invoice. Confirm against acronis_list_psa_sales_items first, and undo a mistake with acronis_delete_psa_sales_items.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Create one tax rate in Advanced Automation. The PUT verb is a create here; acronis_create_psa_taxes_bulk is the POST that creates several at once. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: tax rates change what customers are charged. Read acronis_get_psa_taxes first, and undo a mistake with acronis_delete_psa_taxes.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Create several tax rates in one call. This is the bulk form of acronis_create_psa_tax, and here the create verb is POST rather than PUT. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: every rate in the body reaches customer billing at once. Read acronis_get_psa_taxes first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Create a ticket in Advanced Automation. Two things are easy to get wrong: Advanced Automation calls a ticket a Call in its path, and it creates with PUT. Creating a ticket adds a record and replaces nothing, which is why it is not marked destructive. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Pick a valid priority with acronis_list_psa_priorities, read the ticket back with acronis_get_psa_call and add updates with acronis_update_psa_ticket.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Delete a contract part, which is one line of a customer contract. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). DESTRUCTIVE: removing a contract part changes what the customer is billed for. Read acronis_get_psa_contract_part first.

ParamTypeRequiredDefaultDescription
idstringyesREQUIRED. Contract Part ID

[Acronis Cyber Protect Cloud] Delete a sales item, which is one billable line on a customer invoice. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). DESTRUCTIVE: this deletes the sales item with the given id and Acronis offers no undo. Read acronis_list_psa_sales_items first. UNVERIFIED CONTRACT: Acronis documents no selector on DELETE /SalesItems, so StackJack passes id as a query parameter the way the sibling deletes on this API (acronis_delete_psa_contract_part and acronis_delete_psa_taxes) pass theirs, and that has NOT been verified against a live tenant. A call without an id is refused before any request leaves StackJack.

ParamTypeRequiredDefaultDescription
idstringyesREQUIRED. The id of the sales item to delete. Acronis documents no parameter on this route, so StackJack sends it as the id query parameter, the way the sibling deletes on this API do.

[Acronis Cyber Protect Cloud] Delete a tax rate. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). DESTRUCTIVE: removing a rate changes what customers are charged on every document that uses it. Read acronis_get_psa_taxes first.

ParamTypeRequiredDefaultDescription
idstringyesREQUIRED. The Acronis id query parameter.

[Acronis Cyber Protect Cloud] Export PSA invoices to XML or CSV. DESTRUCTIVE, despite the word export: Acronis sets the Exported flag and sets or updates ExportedDate on every invoice named in ids, which is the billing state your finance process reads to decide what has already gone out, and StackJack cannot undo it. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Acronis REQUIRES ids and exportFormat on this call and there is no unscoped form; the call is refused before it reaches Acronis if you leave one blank. Pass exportFormat 0 for XML or 1 for CSV. Confirm the exact invoice list with acronis_list_psa_invoice_overview first. The response is the export file itself, which Acronis returns as CSV or XML rather than JSON, so StackJack hands it back wrapped in a JSON envelope carrying the content type and the text.

ParamTypeRequiredDefaultDescription
exportFormatstringyesREQUIRED. Export format. 0 for XML; 1 for CSV.
idsstringyesREQUIRED. ID of the invoice.

[Acronis Cyber Protect Cloud] Fetch a ticket. Advanced Automation calls a ticket a Call in its path, which is why the tool name keeps the vendor word. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Create one with acronis_create_psa_ticket and add an update with acronis_update_psa_ticket.

ParamTypeRequiredDefaultDescription
idstringyesREQUIRED. The customer ID.

[Acronis Cyber Protect Cloud] Fetch one contract part, which is a single line of a customer contract. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). The parent contracts come from acronis_list_psa_contracts.

ParamTypeRequiredDefaultDescription
contractstringyesREQUIRED. Contract ID

[Acronis Cyber Protect Cloud] Fetch the Advanced Automation dashboard figures. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers).

ParamTypeRequiredDefaultDescription
currentUserstringnonullThe Acronis CurrentUser query parameter.
endDatestringnonullRFC3339-like date and time without timezone.
isTier4stringnonullThe Acronis isTier4 query parameter.
startDatestringnonullRFC3339-like date and time without timezone.

[Acronis Cyber Protect Cloud] Fetch one ledger entry. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). List them with acronis_list_psa_ledgers; note the vendor path is singular here and plural there.

[Acronis Cyber Protect Cloud] Fetch products from the Advanced Automation catalog. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Add one with acronis_create_psa_product.

[Acronis Cyber Protect Cloud] Fetch ticket updates from the Advanced Automation scheduler. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). The matching write is acronis_update_psa_ticket, which posts an update onto a ticket.

ParamTypeRequiredDefaultDescription
endDatestringnonullRFC3339-like date and time without timezone.
idstringyesREQUIRED. User id
startDatestringnonullRFC3339-like date and time without timezone.

[Acronis Cyber Protect Cloud] Fetch the configured tax rates. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Add one with acronis_create_psa_tax or several with acronis_create_psa_taxes_bulk.

ParamTypeRequiredDefaultDescription
idstringyesREQUIRED. The Acronis id query parameter.

[Acronis Cyber Protect Cloud] List the contracts of one customer, selected by customer ID. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Read a single line of one with acronis_get_psa_contract_part.

ParamTypeRequiredDefaultDescription
idstringyesREQUIRED. The customer ID.

[Acronis Cyber Protect Cloud] List the invoice overview. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Paginated: pass page, starting at 1, with pageSize for the block size; Advanced Automation requires both and StackJack always sends them. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts PaymentSent, PaymentSentNotSent, PaymentSentSent, PaymentStatus, PaymentStatusConfirmed, PaymentStatusNotConfirmed, ShowExported, SortColumn, SortDirection here. That page number is a plain counter, not a cursor. The matching write, acronis_update_psa_invoice, is a POST to this same path.

ParamTypeRequiredDefaultDescription
customerstringnonullCustomer (GUID)
deliveryMethodstringnonullInvoice's delivery method
deliveryMethodByEmailstringnonullInvoice's delivery method "By email"
deliveryMethodByPoststringnonullInvoice's delivery method "By mail"
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"PaymentSent":"..."}. Acronis accepts PaymentSent, PaymentSentNotSent, PaymentSentSent, PaymentStatus, PaymentStatusConfirmed, PaymentStatusNotConfirmed, ShowExported, SortColumn, SortDirection on this endpoint.
invoiceNumberstringnonullInvoice number
pageintegerno1Invoice pagination options: page number.
pageSizeintegerno100Invoice pagination options: page size. Capped at 1000.

[Acronis Cyber Protect Cloud] List ledger entries. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Fetch a single entry with acronis_get_psa_ledger.

[Acronis Cyber Protect Cloud] List the ticket priorities configured in Advanced Automation. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Use it to pick a valid value before acronis_create_psa_ticket.

[Acronis Cyber Protect Cloud] List sales items, which are the billable lines Advanced Automation invoices from. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Add one with acronis_create_psa_sales_item.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] List the service level agreements configured in Advanced Automation. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Paginated: pass page, starting at 1, with pageSize for the block size; Advanced Automation requires both and StackJack always sends them. That page number is a plain counter, not a cursor.

ParamTypeRequiredDefaultDescription
activestringnonullThe Acronis Active query parameter.
namestringnonullThe Acronis Name query parameter.
pageintegerno1The Acronis Page query parameter.
pageSizeintegerno100The Acronis PageSize query parameter. Capped at 1000.
shortNamestringnonullThe Acronis ShortName query parameter.
sortColumnstringnonullThe Acronis SortColumn query parameter.
sortDirectionstringnonullThe Acronis SortDirection query parameter.

[Acronis Cyber Protect Cloud] List the ticket statuses configured in Advanced Automation. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Use it to pick a valid value before acronis_update_psa_ticket.

[Acronis Cyber Protect Cloud] Update an invoice. The verb is unusual: this is a POST to the same path acronis_list_psa_invoice_overview reads, and it updates rather than creates. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this changes a customer invoice, which is money the customer is asked to pay. Read the invoice with acronis_list_psa_invoice_overview first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Post an update onto a ticket. An update is appended to the ticket history rather than replacing the ticket, which is why it is not marked destructive. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. Read the ticket with acronis_get_psa_call, the update stream with acronis_get_psa_scheduler_tickets, and pick a valid status with acronis_list_psa_statuses.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Create a contract, or update it when it already exists. Advanced Automation serves both from one PUT, so the same call can add a contract or overwrite one. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: a contract decides what the customer is billed, and an upsert that matches an existing contract overwrites it. Read acronis_list_psa_contracts first to see whether the target exists.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Create a contract part, or update it when it already exists. One PUT serves both, so the same call can add a billing line or overwrite one. Served by the Advanced Automation API, which is Acronis's own PSA (tickets, contracts, products, sales items, invoices, taxes and ledgers). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: contract parts are billing lines, and an upsert that matches an existing part overwrites it. Read acronis_get_psa_contract_part first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

File Sync and Share

ToolPlanAccessSummary
acronis_create_file_node_copyProWriteCopy a file or folder to another location in File Sync and Share.
acronis_create_file_node_linksProDestructiveMint a share link for a file or folder.
acronis_create_file_node_membersProDestructiveGrant one or more people membership of a shared folder.
acronis_create_file_node_moveProDestructiveMove a file or folder to another location.
acronis_create_file_node_revisionProDestructiveRestore a file to an earlier revision, named by its revision number.
acronis_create_file_node_sync_statusProWriteSet the sync status of a file or folder, which controls whether client devices synchronize it.
acronis_create_file_nodesProWriteCreate a folder in File Sync and Share.
acronis_delete_file_deviceProDestructiveRemove a device from File Sync and Share.
acronis_delete_file_nodeProDestructiveDelete a file or folder.
acronis_delete_file_node_memberProDestructiveRemove one member from a shared folder.
acronis_delete_file_node_membersProDestructiveRemove EVERY member from a shared folder in one call.
acronis_delete_file_node_sync_statusProDestructiveClear the sync status of a file or folder.
acronis_get_file_deviceFreeRead-onlyFetch one File Sync and Share device by UUID.
acronis_get_file_nodeFreeRead-onlyFetch one file or folder by UUID.
acronis_get_file_node_memberFreeRead-onlyFetch one member of a shared folder.
acronis_get_file_settings_audit_logFreeRead-onlyFetch the audit log settings of the File Sync and Share service.
acronis_get_file_settings_purging_policiesFreeRead-onlyFetch the purging policy settings, which govern how long deleted files and old revisions are kept.
acronis_get_file_settings_securityFreeRead-onlyFetch the security settings of the File Sync and Share service, including how share links may be used.
acronis_get_file_settings_serverFreeRead-onlyFetch the server settings of the File Sync and Share service.
acronis_get_file_settings_web_previewFreeRead-onlyFetch the web preview settings, which control in-browser preview of stored files.
acronis_get_file_userFreeRead-onlyFetch one File Sync and Share user by UUID.
acronis_list_file_audit_logFreeRead-onlyList audit log entries for the File Sync and Share service.
acronis_list_file_devicesFreeRead-onlyList the devices registered with File Sync and Share.
acronis_list_file_node_contentsFreeRead-onlyList the files and folders inside one folder.
acronis_list_file_node_membersFreeRead-onlyList the people who share one folder.
acronis_list_file_node_revisionsFreeRead-onlyList the stored revisions of a file.
acronis_update_file_deviceProDestructiveUpdate a device record.
acronis_update_file_nodeProDestructiveUpdate a file or folder record, for example to rename it.
acronis_update_file_node_linkProDestructiveUpdate a share link, for example to change its expiry or its password.
acronis_update_file_node_memberProDestructiveChange what one member may do in a shared folder.
acronis_update_file_settings_audit_logProDestructiveReplace the audit log settings of the File Sync and Share service.
acronis_update_file_settings_purging_policiesProDestructiveReplace the purging policy settings, which decide how long deleted files and old revisions survive.
acronis_update_file_settings_securityProDestructiveReplace the security settings of the File Sync and Share service, including how share links may be used.
acronis_update_file_settings_serverProDestructiveReplace the server settings of the File Sync and Share service.
acronis_update_file_settings_web_previewProDestructiveReplace the web preview settings, which control in-browser preview of stored files.

[Acronis Cyber Protect Cloud] Copy a file or folder to another location in File Sync and Share. The original stays where it is, which is why this is not marked destructive. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. The destructive counterpart is acronis_create_file_node_move.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Grant one or more people membership of a shared folder. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: membership grants access to everything in the folder and reaches real people, who are notified. Read the current membership with acronis_list_file_node_members first; undo a grant with acronis_delete_file_node_member.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Move a file or folder to another location. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: the node leaves its old location, so references and paths that pointed at it stop resolving. Use acronis_create_file_node_copy when the original must stay.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Restore a file to an earlier revision, named by its revision number. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). DESTRUCTIVE: the chosen revision becomes the current content, so the version it replaces is no longer the live one. List the revisions with acronis_list_file_node_revisions first and confirm the number.

ParamTypeRequiredDefaultDescription
nodeUuidstringyesUnique identifier of the node
revisionNumberstringyesNumber of the revision to which the file will be restored

[Acronis Cyber Protect Cloud] Set the sync status of a file or folder, which controls whether client devices synchronize it. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Clear it again with acronis_delete_file_node_sync_status.

ParamTypeRequiredDefaultDescription
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Create a folder in File Sync and Share. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. List what a folder already contains with acronis_list_file_node_contents.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.

[Acronis Cyber Protect Cloud] Remove a device from File Sync and Share. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. DESTRUCTIVE: the device loses its registration and stops synchronizing. Confirm the target with acronis_get_file_device, because device UUIDs are easy to mix up in a list.

ParamTypeRequiredDefaultDescription
deviceUuidstringyesUnique identifier of the device
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] Delete a file or folder. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). DESTRUCTIVE: deleting a folder takes its contents with it and StackJack cannot undo it. Read acronis_get_file_node first, and for a folder acronis_list_file_node_contents.

ParamTypeRequiredDefaultDescription
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Remove one member from a shared folder. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). DESTRUCTIVE: that person loses access to the folder immediately. Confirm who the member ID refers to with acronis_get_file_node_member first.

ParamTypeRequiredDefaultDescription
memberIdstringyesUnique identifier of the member
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Remove EVERY member from a shared folder in one call. This is the bulk form; acronis_delete_file_node_member removes a single person. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). DESTRUCTIVE: everyone sharing the folder loses access at once, and each grant has to be recreated individually with acronis_create_file_node_members. List the members with acronis_list_file_node_members before you send this.

ParamTypeRequiredDefaultDescription
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Clear the sync status of a file or folder. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). DESTRUCTIVE: clearing the status changes what client devices synchronize, so content can disappear from a user device. Set it again with acronis_create_file_node_sync_status.

ParamTypeRequiredDefaultDescription
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Fetch one File Sync and Share device by UUID. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Find the UUID with acronis_list_file_devices.

ParamTypeRequiredDefaultDescription
deviceUuidstringyesUnique identifier of the device
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] Fetch one file or folder by UUID. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). List the contents of a folder with acronis_list_file_node_contents.

ParamTypeRequiredDefaultDescription
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Fetch one member of a shared folder. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). List them all with acronis_list_file_node_members.

ParamTypeRequiredDefaultDescription
memberIdstringyesUnique identifier of the member
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Fetch the audit log settings of the File Sync and Share service. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Read the entries themselves with acronis_list_file_audit_log; change the settings with acronis_update_file_settings_audit_log.

ParamTypeRequiredDefaultDescription
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] Fetch the purging policy settings, which govern how long deleted files and old revisions are kept. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Change them with acronis_update_file_settings_purging_policies.

ParamTypeRequiredDefaultDescription
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] Fetch the security settings of the File Sync and Share service, including how share links may be used. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Change them with acronis_update_file_settings_security.

ParamTypeRequiredDefaultDescription
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] Fetch the server settings of the File Sync and Share service. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Change them with acronis_update_file_settings_server.

ParamTypeRequiredDefaultDescription
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] Fetch the web preview settings, which control in-browser preview of stored files. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Change them with acronis_update_file_settings_web_preview.

ParamTypeRequiredDefaultDescription
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] Fetch one File Sync and Share user by UUID. This is the file-service view of a person; the platform account record comes from the Account Management tools, for example acronis_list_users. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children.

ParamTypeRequiredDefaultDescription
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context
userUuidstringyesUUID of the user

[Acronis Cyber Protect Cloud] List audit log entries for the File Sync and Share service. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Paginated: pass page, starting at 1, with perPage for the block size. Additional filters go in filtersJson as a JSON object of name/value pairs; Acronis accepts filter_from and filter_to here. That page number is a plain counter, not a cursor: ask for page 2 to get the next block.

ParamTypeRequiredDefaultDescription
filterNodeUuidstringnonullFilter by node UUID Set to `"-"` to return log entries not associated with a node
filterSeveritystringnonullFilter by severity level Severity levels are: - `1` - Info - `2` - Warning - `3` - Error - `4` - Fatal
filterSharestringnonullFilter by shared folder UUID Set to `"-"` to return log entries not associated with a shared folder
filterTextstringnonullFilter by text
filterUserstringnonullFilter by user UUID Set to `"-"` to return log entries not associated with a user
filtersJsonstringnonullOptional additional query filters as a JSON object of name/value pairs, e.g. {"filter_from":"..."}. Acronis accepts filter_from, filter_to on this endpoint.
pageintegerno1The page to return Starts from 1
perPageintegerno100The number of items to be retrieved Capped at 1000.
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] List the devices registered with File Sync and Share. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Paginated: pass page, starting at 1. That page number is a plain counter, not a cursor, and perPage sets the block size (capped at 1000). Fetch one device with acronis_get_file_device.

ParamTypeRequiredDefaultDescription
pageintegerno1The page to return Starts from 1
perPageintegerno100The number of items to be retrieved Capped at 1000.
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] List the files and folders inside one folder. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Paginated: pass page, starting at 1. That page number is a plain counter, not a cursor, and perPage sets the block size (capped at 1000). Fetch one entry with acronis_get_file_node.

ParamTypeRequiredDefaultDescription
nodeUuidstringyesUnique identifier of the node
pageintegerno1The page to return Starts from 1
perPageintegerno100The number of items to be retrieved Capped at 1000.

[Acronis Cyber Protect Cloud] List the people who share one folder. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Paginated: pass page, starting at 1. That page number is a plain counter, not a cursor, and perPage sets the block size (capped at 1000). Fetch one member with acronis_get_file_node_member.

ParamTypeRequiredDefaultDescription
nodeUuidstringyesUnique identifier of the node
pageintegerno1The page to return Starts from 1
perPageintegerno100The number of items to be retrieved Capped at 1000.

[Acronis Cyber Protect Cloud] List the stored revisions of a file. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Restore one of them with acronis_create_file_node_revision.

ParamTypeRequiredDefaultDescription
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Update a device record. This is a PUT, so the body replaces the device settings rather than merging into them. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: fields you leave out of the body are not preserved. Read acronis_get_file_device first and send the whole record back with your changes.

ParamTypeRequiredDefaultDescription
deviceUuidstringyesUnique identifier of the device
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] Update a file or folder record, for example to rename it. This is a PUT, so the body replaces the record. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: a PUT replaces the stored record, so anything you omit is lost. Read acronis_get_file_node first and send the whole record back with your changes.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Change what one member may do in a shared folder. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this replaces the access level of a real person, widening or removing what they can do. Read acronis_get_file_node_member first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
memberIdstringyesUnique identifier of the member
nodeUuidstringyesUnique identifier of the node

[Acronis Cyber Protect Cloud] Replace the audit log settings of the File Sync and Share service. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this is a service-wide PUT that replaces the block, so omitted fields are lost and auditing can be switched off for every user. Read acronis_get_file_settings_audit_log first and send the whole block back.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] Replace the purging policy settings, which decide how long deleted files and old revisions survive. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: shortening a retention period makes Acronis purge stored content service-wide, and purged content cannot be recovered from StackJack. Read acronis_get_file_settings_purging_policies first and send the whole block back.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] Replace the security settings of the File Sync and Share service, including how share links may be used. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this is a service-wide PUT that replaces the block, so omitted fields are lost and a wrong value loosens sharing for every user. Read acronis_get_file_settings_security first and send the whole block back.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] Replace the server settings of the File Sync and Share service. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this is a service-wide PUT that replaces the block, so omitted fields are lost and the service can be left misconfigured for every user. Read acronis_get_file_settings_server first and send the whole block back.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context

[Acronis Cyber Protect Cloud] Replace the web preview settings, which control in-browser preview of stored files. Served by the File Sync and Share API (shared folders, file nodes, members, share links, devices and service settings). Scope the call to one customer by passing that customer's Acronis tenant id; discover ids with acronis_list_tenants or acronis_list_tenant_children. Provide the request body as a JSON object in fieldsJson, shaped as the Acronis API documents for this endpoint. DESTRUCTIVE: this is a service-wide PUT that replaces the block, so omitted fields are lost. Read acronis_get_file_settings_web_preview first and send the whole block back.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesThe request body as a JSON object, shaped as the Acronis API documents for this endpoint.
tenantIdstringnonullUUID of a tenant in which context to perform the request in If not specified the request is executed in the current user's tenant context