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

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

Retrieve energy usage by entity

Request

Retrieve energy consumption, CO2 emissions and cost details per entity.

Security
Bearer
Query
start-datestring(date)required

Start date for historical energy data retrieval.

Example: start-date=2025-01-01
end-datestring(date)

End date for historical data retrieval. Required if fetching historical data.

Example: end-date=2025-04-01
projection-daysinteger[ 1 .. 30 ]

Number of days for projected data from today. Used when fetching projection data. The maximum supported projection days is 30.

Example: projection-days=30
aggregate-bystring

Aggregation level for energy consumption data.

Default "SERVER"
Enum"SERVER""SERVER_MODEL""SERVER_GENERATION"
excluded-serversboolean

When it is set to true, the response will have details of servers which don't not have energy data available.

Default false
Example: excluded-servers=true
filterstring

Limit the resources operated on by an endpoint or return only the subset of resources that match the filter.

NOTE: The filter query parameter must use URL encoding.

Examples:
filter=entityDetails/model eq 'Proliant DL 360'
filter=entityDetails/generation eq 'GEN_10'
filter=entityDetails/processor eq 'AMD 8 core Gen 10'
filter=entityDetails/location eq 'Bangalore, KA, India'
sortstring

The order in which to return the resources in the collection. Sort expression is a property name, followed by asc (ascending) or desc (descending).

Default sort order: co2eKg/collected asc

Examples:
sort=name asc
sort=kwh/collected asc
sort=kwh/projected asc
offsetinteger>= 0

Zero-based resource offset to start the response from

Default 0
Example: offset=10
limitinteger[ 1 .. 100 ]

The maximum number of records to return.

Default 10
Example: limit=10
Headers
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/v1beta1/energy-by-entity?start-date=2025-01-01' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
countinteger

Number of items in the response.

Example: 2
offsetinteger

Offset of the returned items.

Example: 0
totalinteger

Total number of items available.

Example: 2
excludedinteger

Number of excluded servers for which energy data is not available.

Example: 0
kwhSumsobject

Total energy consumption data.

co2eKgSumsobject

Total carbon emissions data.

costSumsobject

Total energy cost data.

itemsArray of objects

List of individual entity energy data.

Response
application/json
{ "count": 2, "offset": 0, "total": 2, "excluded": 0, "kwhSums": { "collected": 444, "projected": 432, "total": 876 }, "co2eKgSums": { "collected": 1110, "projected": 1986, "total": 3096 }, "costSums": { "collected": 1776, "projected": 1320, "total": 3096 }, "items": [ {} ] }

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