Dell Technologies Developer

Get system health issues

Get all system health issues. 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

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.

Responses

200 : OK

Successfully returned health issues.

Response Body

System health issues collection.

content

array[object]

componentId

string Required

range: ≥ 1 char(s)

System component identifier.

componentName

string Required

range: ≥ 1 char(s)

System component name.

componentType

string Required

The health component

allowed values: OVERALL_SYSTEM DATA_MANAGER OPERATING_ENVIRONMENT PROTECTION_STORAGE

detailedDescription

string

The detailed description of the alert message.

healthCategory

string Required

The health category

allowed values: CONFIGURATION COMPONENTS DATA_PROTECTION CAPACITY PERFORMANCE

string Required

range: ≥ 1 char(s)

Health issue identifier.

message

string Required

range: ≥ 1 char(s)

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 Required

range: ≥ 1 char(s)

The unique message ID.

metricGroupId

string Required

The associated health metric group identifier.

postedTime

string<date-time> Required

The created time of the alert message.

responseAction

string Required

The response action for this alert message.

scoreDeduction

integer<int32> Required

range: ≥ -2147483648 ≤ 2147483647

Score deduction.

severity

string

Represents health issue severity in the system

allowed values: LOW MEDIUM HIGH

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.

400 : Bad Request

The request is not valid.

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.

401 : Unauthorized

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.

403 : Forbidden

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.

500 : Server Error

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/system-health-issues
Copy
/api/v2/system-health-issues
Copy
https://localhost:8443/api/v2/system-health-issues

Response Samples

200

400

401

403

500

application/json

Successfully returned health issues.

Select response example Example

Copy

{
  "content": [
    {
      "componentId": "string",
      "componentName": "string",
      "componentType": "string",
      "detailedDescription": "string",
      "healthCategory": "string",
      "id": "string",
      "message": "string",
      "messageArgs": [
        "string"
      ],
      "messageID": "string",
      "metricGroupId": "string",
      "postedTime": "2026-10-15T23:21:12.551Z",
      "responseAction": "string",
      "scoreDeduction": 0,
      "severity": "string"
    }
  ],
  "page": {
    "maxPageableElements": 0,
    "number": 0,
    "queryState": "string",
    "size": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}

application/json

The request is not valid.

Select response example Example

Copy

{
  "code": 0,
  "extendedInfo": "string",
  "message": "string",
  "messageArgs": [
    "string"
  ],
  "messageId": "string",
  "messageTemplate": "string",
  "path": "string",
  "reason": "string",
  "remediation": "string",
  "timestamp": 0
}

application/json

The requestor is not authenticated to perform this operation.

Select response example Example

Copy

{
  "code": 0,
  "extendedInfo": "string",
  "message": "string",
  "messageArgs": [
    "string"
  ],
  "messageId": "string",
  "messageTemplate": "string",
  "path": "string",
  "reason": "string",
  "remediation": "string",
  "timestamp": 0
}

application/json

The requestor is not authorized to perform this operation.

Select response example Example

Copy

{
  "code": 0,
  "extendedInfo": "string",
  "message": "string",
  "messageArgs": [
    "string"
  ],
  "messageId": "string",
  "messageTemplate": "string",
  "path": "string",
  "reason": "string",
  "remediation": "string",
  "timestamp": 0
}

application/json

Any server error that prevented the completion of the request.

Select response example Example

Copy

{
  "code": 0,
  "extendedInfo": "string",
  "message": "string",
  "messageArgs": [
    "string"
  ],
  "messageId": "string",
  "messageTemplate": "string",
  "path": "string",
  "reason": "string",
  "remediation": "string",
  "timestamp": 0
}