PowerProtect Data Manager

Software-defined data protection and deduplication in enterprise environments.

DOCUMENTATION API

Get all alerts

Retrieves a list of alerts. 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

The general search text. For example q=VM_1

Successfully returned available alert resources.

Response Body

Get Alerts.

content
array[object]
acknowledgement
object

The acknowledgement details of an alert.

acknowledgeBy
string

The name of the user who acknowledged the alert message.

acknowledgeState
string Required

The acknowledgement state.

allowed values: ACKNOWLEDGED UNACKNOWLEDGED
acknowledgeTime
string<date-time>

The time the message was acknowledged. Follows ISO 8601.

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

Number of related jobs.

blockedActions
array[string]
category
string

The category of the alert message.

allowed values: AGENT APPLIANCE_INFRASTRUCTURE_HARDWARE APPLIANCE_INFRASTRUCTURE_SERVICES APP_HOST_CONFIGURATION CAPACITY CLOUD_TIER COMPLIANCE DISCOVER EXPORT_LOG FILESYSTEM FIRMWARE LICENSE NAS_SERVER_DR NETWORK PROTECTION PROTECTION_COPY PROTECTION_INFRASTRUCTURE PROTECTION_POLICY PROTECTION_RULE PROTECTION_SOURCE PUSH_UPDATE REPLICATION REPORTING RESTORE RESTORE_PLAN SECURITY SELF_SERVICE SERVER_DR STORAGE SYSTEM
detailSummaries
array[object]

The details from individual task. This field is deprecated. Use activitiesCount to get the number of associated activities, or query the activities API to get more information.

summary
string

The description of the failed activity.

taskId
string

The activity ID that failed.

detailedDescription
string

The detailed description of the alert message.

email
boolean

This parameter is true if the alert message can generate an email.

esrs
boolean

This parameter is true if the alert message is sent by ESRS to the support team.

excluded
boolean

If the alert message is displayed in the Alert UI by default, the value of this property is false.

externalId
string

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

hardwareInfo
object

External hardware information. Includes part name, type (Disk, IOModule, RAM, and so on), model, and revision (firmware version). Also includes the chassis ID that contains the part and its position within the chassis.

chassisId
string
chassisPosition
string
partIdentifiers
array[object]
partIdType
string
partValue
string
partModel
string
partName
string
partRev
string
partType
string
id
string Required

ID of the alert.

jobId
string

The job ID associated to the alert message.

lastOccurrenceTime
string<date-time>

The date and time when the most recent alert message is received.

message
string

The message that the variable values are substituted with message arguments.

messageArgs
array[string]

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

messageID
string

The unique message ID.

postedTime
string<date-time>

The created time of the alert message.

responseAction
string

The response action for this alert message.

severity
string

The severity of the alert message.

allowed values: CRITICAL WARNING INFORMATIONAL
source
object

The PowerProtect Data Manager from which the alert message is initiated.

description
string

Origin resource description

id
string

Origin resource id

type
string Required

Originating source type

allowed values: DATA_MANAGER OPERATING_ENVIRONMENT PROTECTION_STORAGE
supportDetails
string

Additional low level details for support.

taskId
string

The task ID that is associated with the alert message.

userNote
object

The user notes on a message.

note
string

The custom text note on the message.

updatedTime
string<date-time>

The time that note is updated. Follows ISO 8601.

username
string

The name of the user who added or updated the notes.

visibility
boolean

This is true if the alert message is visible for the users.

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 the 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 to perform this operation.

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 authorized to perform this operation.

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.

Any server error that 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/alerts
Copy
/api/v2/alerts
Copy
https://localhost:8443/api/v2/alerts
Response Samples
{
  "content": [
    {
      "acknowledgement": {
        "acknowledgeBy": "string",
        "acknowledgeState": "string",
        "acknowledgeTime": "2026-10-15T23:28:37.215Z"
      },
      "activitiesCount": 0,
      "blockedActions": [
        "string"
      ],
      "category": "string",
      "detailSummaries": [
        {
          "summary": "string",
          "taskId": "string"
        }
      ],
      "detailedDescription": "string",
      "email": false,
      "esrs": false,
      "excluded": false,
      "externalId": "string",
      "hardwareInfo": null,
      "id": "string",
      "jobId": "string",
      "lastOccurrenceTime": "2026-10-15T23:28:37.215Z",
      "message": "string",
      "messageArgs": [
        "string"
      ],
      "messageID": "string",
      "postedTime": "2026-10-15T23:28:37.215Z",
      "responseAction": "string",
      "severity": "string",
      "source": {
        "description": "string",
        "id": "string",
        "type": "string"
      },
      "supportDetails": "string",
      "taskId": "string",
      "userNote": {
        "note": "string",
        "updatedTime": "2026-10-15T23:28:37.215Z",
        "username": "string"
      },
      "visibility": false
    }
  ],
  "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
}