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://developer.greenlake.hpe.com/_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

approval-policy - v1beta2

Operations

approval-request - v1beta2

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

Retrieve utilization data by entity

Request

Retrieve CPU, memory bus, I/O bus or CPU interconnect utilization data per entity.

Security
Bearer
Query
start-datestring(date)required

Start date for utilization data retrieval.

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

End date for utilization data retrieval.

Example: end-date=2025-04-01
resource-uristringrequired

URI of the resource for which utilization data is to be retrieved. This can be a server URI or a filter URI.

Examples:
resource-uri=/compute-ops-mgmt/v1beta1/filters/e7cef8e6-a3f6-4490-b669-136e3ca40617
resource-uri=/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB
metric-typestringrequired

The metric type for which utilization data is to be retrieved.

Enum"CPU_UTILIZATION""MEMORY_BUS_UTILIZATION""IO_BUS_UTILIZATION"
excluded-serversboolean

When it is set to true, the response will have details of servers which do not have utilization data available.

Default false
Example: excluded-servers=true
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 "collected/average asc"
Examples:
sort=name asc
sort=collected/high asc
sort=metadata/processorDetails/speedGHz desc
sort=metadata/totalMemorySizeGB desc
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://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/utilization-by-entity?start-date=2025-01-01&end-date=2025-04-01&resource-uri=string&metric-type=CPU_UTILIZATION' \
  -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 utilization data is not available.

Example: 0
metricDetailsobject

Details about the metric type for which utilization data is being retrieved.

itemsArray of objects

List of individual entity utilization data.

Response
application/json
{ "count": 2, "offset": 0, "total": 2, "excluded": 0, "metricDetails": { "metricType": "CPU_UTILIZATION", "metricUnit": "Percentage" }, "items": [ {} ] }

webhooks - v1beta1

Operations