Events

Wellness events provide health insights about your HPE products and services and show information about automatically created support cases. Wellness events allow you to:

Identify potential vulnerabilities before they affect your environment.
Proactively monitor the health of your HPE products and services.
View AI-powered recommendations about events.

Operations

Get a list of wellness events

Request

Retrieves a list of wellness events, in descending order of creation time so that the most recent events are listed first.

Pagination— This endpoint exclusively supports cursor-based pagination, using the next query parameter.

Filtering— The following are the supported filter parameters:

condition/severity
status/currentState
supportCase/caseNumber
asset/serialNumber
productName
serviceName
region
serviceManager/id
flag
archive
read
createdAt
updatedAt

Security

Bearer

Query

filterstring

The filter query parameter is used to filter a set of resources. The returned set of resources matches the criteria in the filter query parameter. The value of the filter query parameter is a subset of OData V4 filter expressions consisting of simple comparison operations joined by logical operators.

Examples:

Filter with serial number

Retrieve events that belong to the specified serial number.

filter=asset/serialNumber eq 'CZJ4490026'

Filter with the severity of the condition

Retrieve events with severity 'warning'.

filter=condition/severity eq 'warning'

Filter with product

Retrieve events that belong to productName 'HPE Alletra 9000'.

filter=productName eq 'HPE Alletra 9000'

Filter with multiple services

Retrieve events that belong to specified services.

filter=serviceName in ('Storage', 'Compute')

Filter with device region

Retrieve events that belong to devices in the given region.

filter=region eq 'us-east'

Filter with Service Manager ID

Retrieve events that belong to specified Service Manager.

filter=serviceManager/id eq '0001b67f-9518-4d0f-9b17-70cec7763632'

Filter with Service Manager and Region

Retrieve events that belong to specified Service Manager and a Region.

filter=region eq 'us-east' and serviceManager/id eq '0001b67f-9518-4d0f-9b17-70cec7763632'

Filter with flag

Retrieve events that are flagged.

filter=flag eq true

Filter with archive

Retrieve events that are not archived.

filter=archive ne true

Filter with case number of the support case

Retrieve events that contains the given number in the support case number.

filter=contains(supportCase/caseNumber, '523')

Filter with timestamp (less than)

Retrieve events created before the given timestamp.

filter=createdAt lt 2021-05-12T07:20:00.00Z

Filter with timestamp (between)

Retrieve events created between the given timestamps.

filter=createdAt gt 2021-05-12T07:20:00.00Z and createdAt lt 2022-05-12T07:20:00.00Z

Filter with the severity of the condition and product

Retrieve events with severity 'warning' and that belong to productName 'HPE Alletra 9000'.

filter=condition/severity eq 'warning' and productName eq 'HPE Alletra 9000'

text-searchstring[ 2 .. 100 ] characters

Searches for wellness events that contain the given search string. A search string can include alphanumeric characters, a space character (Unicode U+0020) or a hyphen (-). Apart from space characters and hyphens, no other special characters are supported. Including an unsupported character might cause inaccurate results. The minimum length of a search string is 2 characters and maximum is 100 characters. When performing a search, it's important to use specific terms. A generic search term may cause the search to timeout.

title
condition.category
condition.name
condition.severity
asset.name
asset.product
asset.serialNumber
status.currentStatus
supportCase.casenumber
supportCase.casestatus
serviceName
productName

Note: You can use both the filter and text-search parameters in the same query. If both are provided, the filter is applied first, and then text-search is performed on the filtered results.

Examples:

Search for wellness events that contain the string `temperature` text-search=temperature

selectstring

The select query parameter is used to limit the properties returned for support cases. The value of the select query parameter is a comma separated list of properties. All properties are returned if the select parameter is omitted.

Note: Only the total property is supported.

Examples:

Get total count

Retrieve the total count of events for the current filter.

select=total

limitinteger(int32)[ 1 .. 200 ]

Specifies the number of resources (wellness events) to fetch.

Default 100

nextstring

The next parameter represents the ID of an event used as a pagination cursor to retrieve the next set of wellness events. The parameter must be a valid UUID and be a part of the response of the previous request.

Examples:

event-id

Event ID as pagination cursor

next=0908777a-788f-45da-afb8-295c626e4d14

curl -i -X GET \
  https://global.api.greenlake.hpe.com/wellness/v2/events \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

itemsArray of objects(WellnessEvent)<= 200 itemsrequired

items[].idstring(uuid)required

Primary identifier for the wellness event given by the system.

items[].typestringrequired

The type of the resource.

Value "wellness/event"

items[].generationinteger(int32)>= 0required

Monotonically increasing update counter.

items[].createdAtstring(date-time)required

Time of wellness event creation.

items[].updatedAtstring(date-time)required

The last date and time the wellness event was updated.

items[].resourceUristring(uri-reference)

URI to the wellness event itself (a self link).

items[].titlestring

Short description of the wellness event.

items[].descriptionobject(description)

items[].assetobject(asset)

items[].conditionobject(condition)

items[].statusobject(status)

items[].causesArray of objects(cause)

A list of possible root causes for the event condition.

items[].supportCaseobject(supportCase)

items[].correlatedboolean

Specifies if this wellness event is related to another wellness event or not.

Default false

items[].serviceNamestring

The name of the service to which this event belongs.

items[].productNamestring

The name of the product to which this event belongs.

items[].flagboolean

Specifies if the wellness event has been flagged or not.

Default false

items[].readboolean

Specifies if the wellness event has been read or not.

Default false

items[].archiveboolean

Specifies if the wellness event has been archived or not.

Default false

items[].supportCaseCreationOpUristring(uri-reference)

URI to get details of the support case creation operation.

items[].serviceManagerobject(ServiceManagerRef)

items[].regionstring

The region of the device to which the wellness event belongs.

countinteger(int32)[ 1 .. 200 ]required

Number of items (wellness events) returned.

Default 100

nextstring(uuid)required

The event ID acts as the pagination cursor for the next page of resources.

totalinteger(int32)>= 0required

Total number of items (wellness events) for the current filter criteria.

Response

application/json

{
  "items": [
    { … },
    { … }
  ],
  "count": 2,
  "next": "0001b67f-9518-4d0f-9b17-70cec7763632",
  "total": 300
}

Update multiple wellness events

Request

Update multiple wellness events in a single request. Only the attributes flag, read, and archive can be updated. This is a non-atomic operation - if an error occurs while updating a resource, the operation continues for the remaining resources. Maximum of 20 events can be updated in a single request.

Security

Bearer

Bodyapplication/merge-patch+jsonrequired

Request body containing list of event IDs and common updates to apply

itemsArray of objects[ 1 .. 20 ] itemsrequired

A list of wellness event IDs to update.

items[].idstring(uuid)required

The wellness event ID to update.

dataobjectrequired

Common updates to apply to all specified events. Must follow JSON Merge Patch format (RFC 7396).

data.readboolean

Boolean indicating the read status of the wellness event.

data.flagboolean

Boolean indicating whether the wellness event is flagged or not.

data.archiveboolean

Boolean indicating whether the wellness event is archived or not.

curl -i -X PATCH \
  https://global.api.greenlake.hpe.com/wellness/v2/events/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "items": [
      {
        "id": "0908777a-788f-45da-afb8-295c626e4d14"
      },
      {
        "id": "0908777a-788f-45da-afb8-295c626e4d15"
      },
      {
        "id": "0908777a-788f-45da-afb8-295c626e4d16"
      }
    ],
    "data": {
      "flag": true
    }
  }'

Responses

Bulk update operation completed. Individual events may have succeeded or failed.

Bodyapplication/json

successCountinteger(int32)[ 0 .. 20 ]required

Number of wellness events successfully updated.

errorCountinteger(int32)[ 0 .. 20 ]required

Number of wellness events not updated.

successesArray of objects[ 0 .. 20 ] itemsrequired

List of wellness events successfully updated.

successes[].idstring(uuid)required

Unique identifier of the wellness event successfully updated.

errorsArray of objects(BulkPatchEventError)[ 0 .. 20 ] itemsrequired

List of errors for wellness events not updated.

errors[].idstring(uuid)required

Identifier of the wellness event that failed to update.

errors[].httpStatusCodeinteger(int32)[ 400 .. 599 ]required

HTTP equivalent status code for the error.

errors[].errorCodestringrequired

A unique machine-friendly, but human-readable identifier for the error.

errors[].messagestringrequired

A user-friendly error message.

errors[].debugIdstring(uuid)required

A unique identifier for the instance of this error.

errors[].errorDetailsArray of objects

Any general metadata error details about the error.

Response

application/json

{
  "successCount": 2,
  "errorCount": 1,
  "successes": [
    { … },
    { … }
  ],
  "errors": [
    { … }
  ]
}

Get wellness event with specific ID

Request

Retrieves a wellness event identified by the given ID.

Security

Bearer

Path

idstring(uuid)required

The wellness event ID.

Examples:

Example with a specific event ID

Returns event that match the given wellness event ID.

0908777a-788f-45da-afb8-295c626e4d14

curl -i -X GET \
  'https://global.api.greenlake.hpe.com/wellness/v2/events/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

idstring(uuid)required

Primary identifier for the wellness event given by the system.

typestringrequired

The type of the resource.

Value "wellness/event"

generationinteger(int32)>= 0required

Monotonically increasing update counter.

createdAtstring(date-time)required

Time of wellness event creation.

updatedAtstring(date-time)required

The last date and time the wellness event was updated.

resourceUristring(uri-reference)

URI to the wellness event itself (a self link).

titlestring

Short description of the wellness event.

descriptionobject(description)

assetobject(asset)

conditionobject(condition)

statusobject(status)

causesArray of objects(cause)

A list of possible root causes for the event condition.

supportCaseobject(supportCase)

correlatedboolean

Specifies if this wellness event is related to another wellness event or not.

Default false

serviceNamestring

The name of the service to which this event belongs.

productNamestring

The name of the product to which this event belongs.

flagboolean

Specifies if the wellness event has been flagged or not.

Default false

readboolean

Specifies if the wellness event has been read or not.

Default false

archiveboolean

Specifies if the wellness event has been archived or not.

Default false

supportCaseCreationOpUristring(uri-reference)

URI to get details of the support case creation operation.

serviceManagerobject(ServiceManagerRef)

regionstring

The region of the device to which the wellness event belongs.

Response

application/json

{
  "id": "0001b67f-9518-4d0f-9b17-70cec7763632",
  "type": "wellness/event",
  "resourceUri": "/wellness/v2/events/0001b67f-9518-4d0f-9b17-70cec7763632",
  "title": "Potential increase in the frequency of reboots on Gen 9 Servers",
  "description": {
    "mediaType": "text/plain",
    "content": "Potential increase in the frequency of reboots on Gen 9 Servers"
  },
  "asset": {
    "name": "simba-lion-king",
    "serialNumber": "CZJ4490026"
  },
  "condition": {
    "urn": "urn:proliant:Potential increase in the frequency of reboots on Gen 9 Servers",
    "severity": "notice",
    "name": "Potential increase in the frequency of reboots on Gen 9 Servers",
    "category": "Firmware/Drivers"
  },
  "status": {
    "currentState": "open"
  },
  "causes": [
    { … }
  ],
  "supportCase": {
    "id": "73695013",
    "caseNumber": "29160",
    "type": "wellness/support-case",
    "resourceUri": "/wellness/v2/support-cases/73695013",
    "createdAt": "2023-01-27T18:17:37.607Z",
    "updatedAt": "2024-01-09T23:37:37.607Z",
    "generation": 1
  },
  "createdAt": "2023-01-27T18:17:37.607Z",
  "updatedAt": "2024-01-09T23:37:37.607Z",
  "generation": 0,
  "flag": true,
  "read": true,
  "region": "us-east",
  "serviceManager": {
    "id": "0001b67f-9518-4d0f-9b17-70cec7763632",
    "resourceUri": "/wellness/v2/service-managers/0001b67f-9518-4d0f-9b17-70cec7763632"
  }
}

Update wellness event with specific ID

Request

Update a wellness event identified by the given ID. Only the attributes flag, read, and archive can be updated.

Security

Bearer

Path

idstring(uuid)required

Event ID

Default "0908777a-788f-45da-afb8-295c626e4d14"

Examples:

Example with specific event ID

Update specific event

0908777a-788f-45da-afb8-295c626e4d14

Bodyapplication/merge-patch+jsonrequired

Request body can have the following attributes

readboolean

Boolean indicating the read status of the wellness event.

Default false

flagboolean

Boolean indicating whether the wellness event is flagged or not.

Default false

archiveboolean

Boolean indicating whether the wellness event is archived or not.

Default false

curl -i -X PATCH \
  'https://global.api.greenlake.hpe.com/wellness/v2/events/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "read": true
  }'

Responses

Successfully updated the given wellness event

Bodyapplication/json

eventobject(EventResourceRef)

successboolean

Indicates whether the event identified by the ID was updated or not.

Default false

Response

application/json

{
  "event": {
    "resourceUri": "/wellness/v2/events/0001b67f-9518-4d0f-9b17-70cec7763632",
    "id": "0001b67f-9518-4d0f-9b17-70cec7763632"
  },
  "success": true
}

Support Cases

Create and retrieve support cases associated with wellness events.

Operations

Async Operations

Asynchronous APIs are APIs that do not return data immediately. This means you can make multiple requests at once. A high-level overview of the asynchronous API process:

You make a request to an asynchronous API endpoint.
HPE GreenLake returns an acknowledgment, typically a 202 Accepted, and provides a URI to the async-operation resource in the Location header.
HPE GreenLake continues to process the request.
When completed, HPE GreenLake returns the requested information.

Operations

HPE GreenLake for Wellness (v2)

Events

Get a list of wellness events

Request

Responses

Was this helpful?

Update multiple wellness events

Request

Responses

Was this helpful?

Get wellness event with specific ID

Request

Responses

Was this helpful?

Update wellness event with specific ID

Request

Responses

Was this helpful?

Support Cases

Async Operations

HPE GreenLake for Wellness (v2)

Events

Get a list of wellness events

Request

Responses

Was this helpful?

Update multiple wellness events

RequestExpand all

Responses

Was this helpful?

Get wellness event with specific ID

Request

Responses

Was this helpful?

Update wellness event with specific ID

Request

Responses

Was this helpful?

Support Cases

Async Operations

Request