Skip to content

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
Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/

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/

accounts - v1beta1

Operations

activation-keys - v1beta1

Operations

activation-tokens - v1beta1

Operations

activities - v1beta2

Operations

List all activities

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.

Security
Bearer
Query
groupsinteger[ 1 .. 10 ]

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.

offsetinteger>= 0

Zero-based resource offset to start the response from

Default 0
Example: offset=10
limitinteger[ 0 .. 1000 ]

The maximum number of records to return.

Default 100
Example: limit=100
filterstring

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.

CLASSEXAMPLES
Typesinteger, decimal, timestamp, string, boolean, null
Operationseq, ne, gt, ge, lt, le, in
Logicand, 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.

Examples:

Return activities where a property equals a value. <property> eq <value>

filter=associatedServerId eq '123'

Return activities where a nested property equals a value. <property>/<nestedProperty> eq <value>

filter=source/type eq 'Group'

Return activities where a property equals a value, using a url. <property>%20eq%20<value>

filter=associatedServerId%20eq%20P06760-B21%2B2M212504P8

Return activities where a property does not equal a value not <property> eq <value>

filter=not key eq 'GROUP_UPDATED'

Return activities with populated property. not <property> eq null

filter=not associatedServerId eq null

Return activities where property contains a value. contains(<property>, <value>)

filter=contains(key,'GROUP_')

Return activities where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)

filter=not source/type eq 'Group' and contains(key, 'GROUP_')

Return activities where property is one of multiple values. <property> in (<value>,<value>)

filter=key in ('GROUP_UPDATED', 'GROUP_CREATED')

Return activities that are between a date range. <property> gt <timestamp> and createdAt lt <timestamp>

filter=createdAt gt 2025-03-15T00:00:00.0Z and createdAt lt 2025-04-01T00:00:00.0Z
sortstring

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.

Examples:

Order resources ascending by name

sort=name asc

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc
Headers
Accept-Languagestring

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

Examples:
en
ja
de,en
fr,ja;q=0.9,en;q=0.7
Tenant-Acidstring(uuid)

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.

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>'

Responses

OK

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0required

Zero-based resource offset

itemsArray of objectsrequired
items[].​idstring(uuid)required

Primary identifier for the activity given by the system

items[].​typestringrequired

Type of the resource

Value "compute-ops-mgmt/activity"
items[].​generationinteger>= 1required

Monotonically increasing update counter

items[].​createdAtstring(date-time)required

Time of activity creation

items[].​updatedAtstring(date-time)required

Time of the last activity update

items[].​titlestring
items[].​keystring
items[].​messagestring
items[].​recommendedActionstring or null
items[].​sourceobject

Reference to the resource that caused this activity

items[].​associatedServerUristring or null
totalinteger>= 0required

Total number of items in the collection that match the filter query, if one was provided in the request

Example: 12
Response
application/json
{ "offset": 0, "count": 1, "total": 12, "items": [ {} ] }

ahs-files - v1beta1

Operations

appliance-firmware-bundles - v1

Operations

appliance-firmware-bundles - v1beta1

Operations

async-operations - v1

Operations

async-operations - v1beta1

Operations

energy-over-time - v1beta1

Operations

energy-by-entity - v1beta1

Operations

external-services - v1beta1

Operations

filters - v1beta1

Operations

firmware-bundles - v1

Operations

firmware-bundles - v1beta2

Operations

groups - v1

Operations

groups - v1beta3

Operations

groups - v1beta2

Operations

job-templates - v1beta2

Operations

jobs - v1

Operations

jobs - v1beta3

Operations

jobs - v1beta2

Operations

metrics-configurations - v1

Operations

oneview-appliances - v1beta1

Operations

oneview-settings - v1beta1

Operations

oneview-server-templates - v1beta1

Operations

reports - v1beta2

Operations

schedules - v1beta2

Operations

server-locations - v1beta1

Operations

server-settings - v1beta1

Operations

settings - v1

Operations

settings - v1beta1

Operations

servers - v1

Operations

servers - v1beta2

Operations

server-warranty - v1beta2

Operations

user-preferences - v1

Operations

user-preferences - v1beta1

Operations

utilization-over-time - v1beta1

Operations

utilization-by-entity - v1beta1

Operations

webhooks - v1beta1

Operations