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.
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/
https://us-west.api.greenlake.hpe.com/
https://eu-central.api.greenlake.hpe.com/
https://ap-northeast.api.greenlake.hpe.com/
Request
Retrieve the list of activities
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
Specify the number of groups of activities that should be returned. A group of activities is a single activity item that corresponds to one or more activities with the same activity key
that occurred back-to-back. A group of activities might be "5 servers assigned to Compute Ops Management" or "12 servers firmware update successful". This parameter has no relation to the groups resource.
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 characters !
#
$
&
'
(
)
*
+
,
/
:
;
=
?
@
[
]
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 |
Activities can be filtered by:
- associatedServerId
- associatedServerUri
- createdAt
- groupId
- groupDisplayName
- healthState
- hidden
- id
- key
- resourceUri
- serverSettingsCategory
- serverSettingsId
- serverSettingsName
- source/type
Additional filters which should be considered deprecated and may be removed in a future version:
- source/resourceUri
- source/displayName
- source/originId
The following examples are not an exhaustive list of all possible filtering options.
Return activities where a property equals a value. <property> eq <value>
Return activities where a nested property equals a value. <property>/<nestedProperty> eq <value>
Return activities where a property equals a value, using a url. <property>%20eq%20<value>
Return activities where a property does not equal a value not <property> eq <value>
Return activities with populated property. not <property> eq null
Return activities where property contains a value. contains(<property>, <value>)
Return activities where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)
Return activities where property is one of multiple values. <property> in (<value>,<value>)
Return activities that are between a date range. <property> gt <timestamp> and createdAt lt <timestamp>
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
Current supported languages are en
(English) and ja
(Japanese)
A blank header or one containing only non-supported languages will return activities in English. Otherwise, activities will be returned in the highest weighted supported language.
NOTE: This header should follow the format shown here using IETF language tags
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/activities
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/activities
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/activities
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/activities
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X GET \
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/activities \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "offset": 0, "count": 1, "total": 12, "items": [ { … } ] }