Zero-based resource offset to start the response from
HPE Compute Ops Management API (latest)
HPE Compute Operations Management provides a Restful API to customers who want to manage their devices programmatically or through a command line. The API enables customers to invoke operations or tasks such as list devices, see device details, device health, and manage their device's firmware.
UPDATED API ENDPOINTS
Compute Ops Management now supports the HPE GreenLake API endpoints (<region>.api.greenlake.hpe.com). The Guide contains more information about this change.
Download OpenAPI description
Overview
License
Languages
Servers
API endpoint for US West
https://us-west.api.greenlake.hpe.com/
API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/
API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/
Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/
Request
Retrieve alert data for all Servers.
Only active alerts and cleared alerts within the last 180 days are returned. Cleared alerts older than 180 days are excluded and cannot be retrieved via filter.
Filterable and sortable fields:
| Field | Type | Notes |
|---|---|---|
id | string (UUID) | Alert UUID |
device/id | string | Server / appliance ID |
severity | string | Critical, Warning, OK, Unknown — case-insensitive |
category | string | e.g. fans, security, power — case-insensitive |
alertType | string | hardware, software — case-insensitive |
messageKey | string | e.g. FanFailed, MinPasswordLengthAtRisk |
messageId | string | Full versioned message ID (bundle.major.minor.key) |
clearedAt | datetime (ISO 8601) | null for active alerts |
createdAt | datetime (ISO 8601) | Alert creation timestamp |
updatedAt | datetime (ISO 8601) | Last modification timestamp |
serviceEvent | boolean | true / false |
originOfCondition | string | URI identifying the originating component |
Supported OData filter operators: eq, ne, gt, ge, lt, le, and, or, not, in, contains
Security
Bearer
Query
Examples:
Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.
NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved charecters ! # $ & ' ( ) * + , / : ; = ? @ [ ] must be encoded with percent encoded equivalents. Server IDs contain a +, which must be encoded as %2B.
For example: the value P06760-B21+2M212504P8 must be encoded as P06760-B21%2B2M212504P8 when it is used in a query parameter.
| CLASS | EXAMPLES |
|---|---|
| Types | integer, decimal, timestamp, string, boolean, null |
| Operations | eq, ne, gt, ge, lt, le, in |
| Logic | and, or, not |
Return resources where id == c650e411-3454-475d-a1af-7a31b21a1ce4
Return server where id == c650e411-3454-475d-a1af-7a31b21a1ce4
Return resources where applianceType is VM and state is connected
Return resources where applianceType is VM or UNKNOWN
The order in which to return the resources in the collection.
The value of the sort query parameter is a comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).
The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direciton indicator is omitted the default direction is ascending.
Order resources ascending by name
Order resources ascending by name and then by descending by createdAt
Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.
The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.
For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.
Select only the id and name properties of the resource
Headers
Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.
In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/alerts
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1/alerts
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1/alerts
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/alerts
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X GET \
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/alerts \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'OK
Timestamp when the alert was cleared, null if active
ServiceNow incident details. This data will only be available when a ServiceNow incident is created for a service event.
ID of the automatically created HPE Support Case. This will be available only when a HPE Support Case is created for a service event.
Example: 9815373940
Response
application/json
{ "offset": 0, "count": 1, "total": 12, "items": [ { … } ] }