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

external-services - v1beta1

Operations

filters - v1beta1

Operations

firmware-bundles - v1

Operations

firmware-bundles - v1beta2

Operations

List all firmware bundles

Request

Retrieve the list of firmware bundles

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

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/v1beta2/firmware-bundles \
  -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[].​idstringrequired

Primary identifier for the firmware bundle given by the system

items[].​typestringrequired

Type of the resource

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

Monotonically increasing update counter

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

Time of firmware bundle creation

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

Time of the last firmware bundle update

items[].​resourceUristring(uri-reference)

URI to the firmware bundle itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta2/firmware-bundles/9a16ec6d-8c71-4338-a58a-6564df331ba2"
items[].​namestring

Name given to the bundle usually based on the bundle type

items[].​releaseDatestring(full-date-rfc3339)

The date on which bundle is published to the web

items[].​releaseVersionstring

Latest version which got released

items[].​releaseNotesstring

A HPE SW Center Page link which describes how the bundle can be downloaded and installed in the customer environment

items[].​supportUrlstring

An URL which points to HPE SW Center Page for this bundle

items[].​enhancementsstring

A HPE SW Center Page link which describes the enhancements included in this bundle

items[].​advisoriesstring

The link to all the customer advisories released for this bundle

items[].​supportedOsListArray of strings

The list of operating systems that this bundle supports

items[].​isActiveboolean

Indicates the status of bundle is active or not

items[].​summarystring

Gives the info about the issue that will be addressed by the bundle

items[].​bundleTypestring

Bundle Type assigned based on the servers for which it is built for

Enum"BASE""HOTFIX""SUPPLEMENT"
items[].​hotfixBaseUristring or null

URI to the hotfixbase itself (i.e. a self link)

items[].​vmwareAddonInfoArray of objects or null(JSON)(vmwareAddonInfoItem-v1beta2)

Details about addon and the location of the addon in RDA

items[].​bundleNameFormatstring

Indicates the format of the bundle name

Example: "BUNDLE_3OCTET"
items[].​bundleGenerationstring

Server generations that the bundle has support for

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": [ {} ] }

Get a firmware bundle by ID

Request

Retrieve the firmware bundle details by its id

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
Path
idstringrequired

Unique Firmware bundle identifier

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/v1beta2/firmware-bundles/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstringrequired

Primary identifier for the firmware bundle given by the system

typestringrequired

Type of the resource

Value "compute-ops-mgmt/firmware-bundle"
generationinteger>= 1required

Monotonically increasing update counter

createdAtstring(date-time)required

Time of firmware bundle creation

updatedAtstring(date-time)required

Time of the last firmware bundle update

resourceUristring(uri-reference)

URI to the firmware bundle itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta2/firmware-bundles/9a16ec6d-8c71-4338-a58a-6564df331ba2"
namestring

Name given to the bundle usually based on the bundle type

releaseDatestring(full-date-rfc3339)

The date on which bundle is published to the web

releaseVersionstring

Latest version which got released

releaseNotesstring

A HPE SW Center Page link which describes how the bundle can be downloaded and installed in the customer environment

supportUrlstring

An URL which points to HPE SW Center Page for this bundle

enhancementsstring

A HPE SW Center Page link which describes the enhancements included in this bundle

advisoriesstring

The link to all the customer advisories released for this bundle

supportedOsListArray of strings

The list of operating systems that this bundle supports

isActiveboolean

Indicates the status of bundle is active or not

summarystring

Gives the info about the issue that will be addressed by the bundle

bundleTypestring

Bundle Type assigned based on the servers for which it is built for

Enum"BASE""HOTFIX""SUPPLEMENT"
hotfixBaseUristring or null

URI to the hotfixbase itself (i.e. a self link)

vmwareAddonInfoArray of objects or null(JSON)(vmwareAddonInfoItem-v1beta2)

Details about addon and the location of the addon in RDA

bundleNameFormatstring

Indicates the format of the bundle name

Example: "BUNDLE_3OCTET"
bundleGenerationstring

Server generations that the bundle has support for

Response
application/json
{ "id": "string", "type": "compute-ops-mgmt/firmware-bundle", "resourceUri": "/compute-ops-mgmt/v1beta2/firmware-bundles/9a16ec6d-8c71-4338-a58a-6564df331ba2", "generation": 1, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "releaseDate": "string", "releaseVersion": "string", "releaseNotes": "string", "supportUrl": "string", "enhancements": "string", "advisories": "string", "supportedOsList": [ "string" ], "isActive": true, "summary": "string", "bundleType": "BASE", "hotfixBaseUri": "string", "vmwareAddonInfo": [ {} ], "bundleNameFormat": "BUNDLE_3OCTET", "bundleGeneration": "string" }

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