PowerProtect Data Manager

Software-defined data protection and deduplication in enterprise environments.

DOCUMENTATION API

Get all activities

Retrieves a list of all activities. Passing query parameters that are not documented on this page will result in a 400 error when strict REST API validation is enabled. Additional information can be found in the Getting started - Strict REST API validation documentation.

This endpoint supports execution by the following roles: Administrator, User, Backup Administrator, Restore Administrator

This endpoint supports pagination with types: random,serial

Security
Key, Type & Details
BearerAuth
http
For accessing the API, a valid JWT token must be passed in all the queries in the 'Authorization' header with the 'Bearer' HTTP authorization schema: 'Authorization: Bearer <JWT_token>'
Requests
Query Parameters
page
integer
default: 1
range: ≥ 1 ≤ 10000

The page number to be returned. Must not be less than 1. Under Tasks, see Page the result.

pageSize
integer
default: 100
range: ≥ 1 ≤ 10000

The number of resources to be returned. Must not be less than 1. Under Tasks, see Page the result.

filter
string

The filter string that is expressed using PowerProtect Data Manager filter syntax. Under Tasks, see Filter the result.

orderby
string

The attributes and fields to sort by. This parameter can combine with sort direction “ASC” or “DESC”. Default direction is ASC. Under Tasks, see Sort the result.

queryState
string

Token string to retrieve the next page of a result. The initial search request with queryState must be queryState=BEGIN and a pageSize. After a search begins, subsequent responses include a token string to pass as a parameter for the next page retrieval. When the query state in the response that is returned from the previous search is END, no further results can be retrieved from this query. For more details, under Tasks, see Page the result.

q
string

A general search text.
For example: q=VM_1
where the following fields will be searched for VM_1.

The following fields are searched:

name
result.summaries
result.error.reason
result.error.remediation
logInfo.logText
asset.name
asset.type
copy.name
copy.type
dataTarget.name
host.name
protectionPolicy.name
sourceDataTarget.name
serviceLevelAgreement.name
owner.name
lastUpdateTime
createdTime or createTime
groupBy
string

Entity type to group asset-level activities by.

groupByValue
string

Value of entity of type specified in groupBy parameter.

Successfully returned available activity resources.

Response Body

Get Activities.

content
array[object]
actions
object

The options for the activity actions.

cancelable
boolean

This parameter is true if the activity can be canceled.

retryable
boolean

This parameter is true if the activity can be retried.

activityInitiatedType
string

The activity initiation type.

allowed values: MANUAL SCHEDULED RETRIED SELF_SERVICE
asset
object

The reference to a resource that is associated with this activity.

id
string

The reference ID.

name
string

The reference name.

type
string

The reference type.

averageBytesTransferred
number<double>
range: ≥ -1.7976931348623157e+308 ≤ 1.7976931348623157e+308

This parameter is for running job group only. Average over the bytes transferred by completed jobs inside the job group. For activities that support detailed stats, the average for successfully completed activities over the number of protected assets.

averageDuration
number<double>
range: ≥ -1.7976931348623157e+308 ≤ 1.7976931348623157e+308

This parameter is for running job group only. Average over the completed jobs inside the job group. For activities that support detailed stats, the average for successfully completed activities over the number of protected assets.

category
string Required

The category of the activity.

allowed values: CLOUD_COPY_RECOVER CLOUD_DR CLOUD_PROTECT CLOUD_TIER CONFIG DATA_MOVEMENT DELETE DISASTER_RECOVERY DISCOVER EXPORT_REUSE GARBAGE_COLLECTION HOST_CONFIGURATION INDEX INSTANT_ACCESS_ATTACH INSTANT_ACCESS_DETACH INSTANT_ACCESS_DELETE_SESSION MANAGE NOTIFY PROTECT PUSH_UPDATE REPLICATE RESTORE SYSTEM VALIDATE
classType
string Required

The type of activity. JOB_GROUP is a group of jobs. JOB is an activity that can be monitored and managed. TASK is a step within a job that can be monitored.

allowed values: JOB_GROUP JOB TASK
createTime
string<date-time> Required

The create time of the activity. Follows ISO8601 date format.

destinationSystem
object

The reference to a resource that is associated with this activity.

id
string

The reference ID.

name
string

The reference name.

type
string

The reference type.

displayId
string

The displayId of the activity. This is only assigned to JOB_GROUP and JOB activity type that do not have a parentId.

duration
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

The total time taken for a running or completed activity.

endTime
string<date-time>

The end time of the activity. Follows ISO8601 date format.

extendedData
object

Extended data with an array of key/value pairs for generic use.

keyValues
array[object]
key
string
values
array[string]
externalId
string

If this activity belongs to an external system, the external ID points to the activity ID on that system.

failedToRetrieveStats
array[object]
assetId
string

For future use.

assetName
string

For future use.

hostname
string
version
string
groupByOptions
array[string]

This property represents a list of options by which asset-level protection activities can be grouped.

hasChildren
boolean

This parameter is true if the activity has a child.

hasLogs
boolean

This parameter is true if the activity or its child has a log file.

host
object

The reference to a resource that is associated with this activity.

id
string

The reference ID.

name
string

The reference name.

type
string

The reference type.

id
string Required

The ID of the activity.

infrastructureSource
string

Information about the source of a virtual machine restore operation.

initiatedType
string

The activity initiation type. (Deprecated, use activityInitiatedType instead)

interventionGroupId
string

References the intervention group that this activity belongs to, or null if it does not belong to any group.

inventorySource
object

The reference to a resource that is associated with this activity.

id
string

The reference ID.

name
string

The reference name.

type
string

The reference type.

logExport
object

The reference to a resource that is associated with this activity.

id
string

The reference ID.

name
string

The reference name.

type
string

The reference type.

logInfo
object

The error log information about the failure or warning that occurred for the activity. This can be a long description with some exceptions trace and other debug information.

fileName
string

The path to extended error information.

logText
array[string]

The extended error information.

name
string Required

The name of the activity.

nextScheduledTime
string<date-time>

The next scheduled time of the activity. Follows ISO8601 date format.

owner
object

The owner of the activity.

name
string

Name of the owner.

ownerResource
object

Information about owner.

id
string

Id of the owner resource.

resourceType
string

Type of the owner resource.

parentId
string

The parent ID of activity.

progress
integer<int32> Required
range: ≥ -2147483648 ≤ 2147483647

Value between 0 and 100 representing % completion for activity.

progressIssues
string

Issues that arise during the progress of the activity.

allowed values: NO_REPORTED_ISSUES TIMEOUT_ISSUES CONNECTION_ISSUES STATS_STALL_ISSUES
protectionPolicy
object

The reference to a resource that is associated with this activity.

id
string

The reference ID.

name
string

The reference name.

type
string

The reference type.

restoreGroup
object

The reference to a resource that is associated with this activity.

id
string

The reference ID.

name
string

The reference name.

type
string

The reference type.

restorePlan
object

The reference to a resource that is associated with this activity.

id
string

The reference ID.

name
string

The reference name.

type
string

The reference type.

result
object

The result of the activity.

bytesTransferred
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

The total data transferred to a storage during an activity in bytes. If the value is 0, nothing was transferred. Deprecated. Use stats.bytesTransferred.

error
object

The error code, reason, remediation, extendedReason, detailedDescription and arguments.

arguments
array[object]
name
string

Name of the value.

value
string

Value of the name. Type of string.

code
string

The error code or message id for message catalog.

detailedDescription
string

The detailed description from message catalog.

extendedReason
string

The extended reason not from the message catalog.

messageID
string

The unique message ID.

reason
string

The error reason or message from message catalog.

remediation
string

The remediation or remediation from message catalog.

status
string

The status of a completed activity.

allowed values: OK CANCELED FAILED OK_WITH_ERRORS UNKNOWN SKIPPED
summaries
array[string]

The summary of the activity.

scheduleInfo
object

Protection schedule details

description
string
nextScheduledTime
string<date-time>

The next scheduled time for the activity. Follows the ISO 8601 date format.

type
string
allowed values: MINUTELY HOURLY DAILY WEEKLY MONTHLY YEARLY
source
object

The PowerProtect Data Manager where the activity is initiated from.

description
string

Origin resource description

id
string

Origin resource id

type
string Required

Originating source type

allowed values: DATA_MANAGER OPERATING_ENVIRONMENT PROTECTION_STORAGE
sourceCopy
object

The reference to a resource that is associated with this activity.

id
string

The reference ID.

name
string

The reference name.

type
string

The reference type.

sourceStorageSystem
object

The reference to a resource that is associated with this activity.

id
string

The reference ID.

name
string

The reference name.

type
string

The reference type.

sourceSystem
object

The reference to a resource that is associated with this activity.

id
string

The reference ID.

name
string

The reference name.

type
string

The reference type.

startTime
string<date-time>

The start time of the activity. Follows ISO8601 date format.

state
string Required

The state of the activity.

allowed values: QUEUED RUNNING PENDING_CANCELLATION COMPLETED
stateDetails
object

Data Model to provide additional state information

message
string

Detailed state information

stateSummaries
object

The summary of the children activities. Includes state, completion status, and total counts for classType of JOB_GROUP.

canceled
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The count of child activities in canceled state.

completed
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The count of child activities in completed state.

criticalEvent
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The count of child activities in the worst (critical/warning/canceled) state.

failed
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The count of child activities in failed state.

ok
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The count of child activities in OK state.

okWithErrors
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The count of child activities in OK with errors (okWithErrors) state.

pendingCancellation
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The count of child activities in pending cancellation state.

queued
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The count of child activities in queued state.

running
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The count of child activities in running state.

skipped
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The count of child activities in skipped state.

total
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The total count of the child activities.

unknown
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The count of child activities in unknown state.

stats
object

The activity statistics.

assetSizeInBytes
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

The asset size in bytes.

bytesTransferred
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

The total data transferred to storage.

bytesTransferredThroughput
number<double>
range: ≥ -1.7976931348623157e+308 ≤ 1.7976931348623157e+308

The average bytes transferred for successfully completed activities over the number of protected assets.

bytesTransferredThroughputUnitOfTime
string

Time used to calculate the throughput.

dedupeRatio
number<double>
range: ≥ -1.7976931348623157e+308 ≤ 1.7976931348623157e+308

Pre-compression bytes divided by post-compression bytes.

numberOfAgents
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

Number of agents involved at the job group level.

numberOfAssets
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

Total number of assets being processed.

numberOfProtectedAssets
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

Total number of assets protected.

postCompBytes
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

Size in bytes after client side compression. Data written to storage.

preCompBytes
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

Data sent to Boost SDK to write while backup is running or when it is done. Data read from Boost SDK to restore. Size in bytes prior to client side compression.

reductionPercentage
number<double>
range: ≥ -1.7976931348623157e+308 ≤ 1.7976931348623157e+308

Calculated as (1-postCompBytes/preCompBytes)*100.

storageCompStats
object

The statistic from storage

cumulativeSizeInBytes
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

Cumulative file size

dedupedPreCompSizeInBytes
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

Size after removing duplication and before local compression

redundantSegmentsCount
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

Redundant segments (already existing on protection storage) in file

segmentsCount
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

Total segments in file

statsNotSupportedByApp
array[object]
assetId
string

For future use.

assetName
string

For future use.

hostname
string
version
string
statsRequireAgentUpgrade
array[object]
assetId
string

For future use.

assetName
string

For future use.

hostname
string
version
string
steps
array[object]
description
string

Additional Description

durationInMillis
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

Time taken to complete the step in milliseconds.

endTime
string<date-time>

End Time of the Step

name
string Required

Name of the step. Unique within the list of steps.

startTime
string<date-time>

Start time of the step.

status
string Required

Status of the step

allowed values: QUEUED RUNNING SUCCESS WARNING FAILED CANCELED UNKNOWN SKIPPED
storageSystem
object

The reference to a resource that is associated with this activity.

id
string

The reference ID.

name
string

The reference name.

type
string

The reference type.

subcategory
string

The subcategory within a category.

throttlingInfo
object

Provides details of the throttling that is performed during activity execution.

triggered
boolean

Indicates if throttling was performed for an activity in either the PowerProtect agent service or application.

updateTime
string<date-time> Required

The update time of the activity. Follows ISO8601 date format.

username
string
page
object

The page information that is usually used to describe the content of an API response, including page number, page size, total elements count, and total page count.

maxPageableElements
integer

The max number of pageable elements.

number
integer

The page number.

queryState
string

The query token. Only used for serial query. Under Tasks, see Page the result.

size
integer

The number of elements on each page.

totalElements
integer

The total number of elements across all pages.

totalPages
integer

The total number of pages.

The request is not valid. Check request parameters.

Response Body

The error response that describes the failure reason and remediation.

code
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The error code number.

extendedInfo
string

Additional information about the error.

message
string

The error message.

messageArgs
array[string]

The message arguments are the values for any substitution variables that are defined as part of the message.

messageId
string

The unique message ID.

messageTemplate
string

The message template defines the display sequence of the message arguments array.

path
string

The path that produced the error.

reason
string

The reason that the error occurred.

remediation
string

A recommended solution to resolve the error.

timestamp
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

When the error occurred.

The requestor is not authenticated.

Response Body

The error response that describes the failure reason and remediation.

code
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The error code number.

extendedInfo
string

Additional information about the error.

message
string

The error message.

messageArgs
array[string]

The message arguments are the values for any substitution variables that are defined as part of the message.

messageId
string

The unique message ID.

messageTemplate
string

The message template defines the display sequence of the message arguments array.

path
string

The path that produced the error.

reason
string

The reason that the error occurred.

remediation
string

A recommended solution to resolve the error.

timestamp
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

When the error occurred.

The requestor does not have required permissions.

Response Body

The error response that describes the failure reason and remediation.

code
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The error code number.

extendedInfo
string

Additional information about the error.

message
string

The error message.

messageArgs
array[string]

The message arguments are the values for any substitution variables that are defined as part of the message.

messageId
string

The unique message ID.

messageTemplate
string

The message template defines the display sequence of the message arguments array.

path
string

The path that produced the error.

reason
string

The reason that the error occurred.

remediation
string

A recommended solution to resolve the error.

timestamp
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

When the error occurred.

A server error prevented the completion of the request.

Response Body

The error response that describes the failure reason and remediation.

code
integer<int32>
range: ≥ -2147483648 ≤ 2147483647

The error code number.

extendedInfo
string

Additional information about the error.

message
string

The error message.

messageArgs
array[string]

The message arguments are the values for any substitution variables that are defined as part of the message.

messageId
string

The unique message ID.

messageTemplate
string

The message template defines the display sequence of the message arguments array.

path
string

The path that produced the error.

reason
string

The reason that the error occurred.

remediation
string

A recommended solution to resolve the error.

timestamp
integer<int64>
range: ≥ -9223372036854776000 ≤ 9223372036854776000

When the error occurred.

GETTry it
/api/v2/activities
Copy
/api/v2/activities
Copy
https://localhost:8443/api/v2/activities
Response Samples
{
  "content": [
    {
      "actions": {
        "cancelable": false,
        "retryable": false
      },
      "activityInitiatedType": "string",
      "asset": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "averageBytesTransferred": 0,
      "averageDuration": 0,
      "category": "string",
      "classType": "string",
      "createTime": "2026-10-15T22:49:01.905Z",
      "destinationSystem": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "displayId": "string",
      "duration": 0,
      "endTime": "2026-10-15T22:49:01.905Z",
      "extendedData": {
        "keyValues": [
          {
            "key": "string",
            "values": [
              "string"
            ]
          }
        ]
      },
      "externalId": "string",
      "failedToRetrieveStats": [
        {
          "assetId": "string",
          "assetName": "string",
          "hostname": "string",
          "version": "string"
        }
      ],
      "groupByOptions": [
        "string"
      ],
      "hasChildren": false,
      "hasLogs": false,
      "host": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "id": "string",
      "infrastructureSource": "string",
      "initiatedType": "string",
      "interventionGroupId": "string",
      "inventorySource": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "logExport": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "logInfo": {
        "fileName": "string",
        "logText": [
          "string"
        ]
      },
      "name": "string",
      "nextScheduledTime": "2026-10-15T22:49:01.905Z",
      "owner": {
        "name": "string",
        "ownerResource": {
          "id": "string",
          "resourceType": "string"
        }
      },
      "parentId": "string",
      "progress": 0,
      "progressIssues": "string",
      "protectionPolicy": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "restoreGroup": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "restorePlan": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "result": {
        "bytesTransferred": 0,
        "error": {
          "arguments": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "code": "string",
          "detailedDescription": "string",
          "extendedReason": "string",
          "messageID": "string",
          "reason": "string",
          "remediation": "string"
        },
        "status": "string",
        "summaries": [
          "string"
        ]
      },
      "scheduleInfo": null,
      "source": {
        "description": "string",
        "id": "string",
        "type": "string"
      },
      "sourceCopy": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "sourceStorageSystem": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "sourceSystem": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "startTime": "2026-10-15T22:49:01.905Z",
      "state": "string",
      "stateDetails": null,
      "stateSummaries": {
        "canceled": 0,
        "completed": 0,
        "criticalEvent": 0,
        "failed": 0,
        "ok": 0,
        "okWithErrors": 0,
        "pendingCancellation": 0,
        "queued": 0,
        "running": 0,
        "skipped": 0,
        "total": 0,
        "unknown": 0
      },
      "stats": {
        "assetSizeInBytes": 0,
        "bytesTransferred": 0,
        "bytesTransferredThroughput": 0,
        "bytesTransferredThroughputUnitOfTime": "string",
        "dedupeRatio": 0,
        "numberOfAgents": 0,
        "numberOfAssets": 0,
        "numberOfProtectedAssets": 0,
        "postCompBytes": 0,
        "preCompBytes": 0,
        "reductionPercentage": 0,
        "storageCompStats": {
          "cumulativeSizeInBytes": 0,
          "dedupedPreCompSizeInBytes": 0,
          "redundantSegmentsCount": 0,
          "segmentsCount": 0
        }
      },
      "statsNotSupportedByApp": [
        {
          "assetId": "string",
          "assetName": "string",
          "hostname": "string",
          "version": "string"
        }
      ],
      "statsRequireAgentUpgrade": [
        {
          "assetId": "string",
          "assetName": "string",
          "hostname": "string",
          "version": "string"
        }
      ],
      "steps": [
        {
          "description": "string",
          "durationInMillis": 0,
          "endTime": "2026-10-15T22:49:01.905Z",
          "name": "string",
          "startTime": "2026-10-15T22:49:01.905Z",
          "status": "string"
        }
      ],
      "storageSystem": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "subcategory": "string",
      "throttlingInfo": {
        "triggered": false
      },
      "updateTime": "2026-10-15T22:49:01.905Z",
      "username": "string"
    }
  ],
  "page": {
    "maxPageableElements": 0,
    "number": 0,
    "queryState": "string",
    "size": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}
{
  "code": 0,
  "extendedInfo": "string",
  "message": "string",
  "messageArgs": [
    "string"
  ],
  "messageId": "string",
  "messageTemplate": "string",
  "path": "string",
  "reason": "string",
  "remediation": "string",
  "timestamp": 0
}
{
  "code": 0,
  "extendedInfo": "string",
  "message": "string",
  "messageArgs": [
    "string"
  ],
  "messageId": "string",
  "messageTemplate": "string",
  "path": "string",
  "reason": "string",
  "remediation": "string",
  "timestamp": 0
}
{
  "code": 0,
  "extendedInfo": "string",
  "message": "string",
  "messageArgs": [
    "string"
  ],
  "messageId": "string",
  "messageTemplate": "string",
  "path": "string",
  "reason": "string",
  "remediation": "string",
  "timestamp": 0
}
{
  "code": 0,
  "extendedInfo": "string",
  "message": "string",
  "messageArgs": [
    "string"
  ],
  "messageId": "string",
  "messageTemplate": "string",
  "path": "string",
  "reason": "string",
  "remediation": "string",
  "timestamp": 0
}