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

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

Lists the warranty information for all servers.

Request

Retrieve warranty data for all servers.

Security
Bearer
Query
offsetinteger>= 0

Zero-based resource offset to start the response from

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

The maximum number of records to return.

Example: limit=10
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, gt, ge, lt, le
Logicand

Warranty information can be filtered by:

  • supportState
  • supportStartDate
  • supportEndDate

The following examples are not an exhaustive list of all possible filtering options.

Examples:

Return server warranty information for the servers where a property equals a value. <property> eq <value>

filter=supportState eq 'ACTIVE'

Return server warranty information for the servers where a property is less than or equal to a value. <property> lt <value>

filter=supportStartDate le 2024-07-01

Return server warranty information for the servers where a property is greater than or equal to a value. <property> gt <value>

filter=supportEndDate ge 2024-01-01

Return server warranty information for the servers where a property is less than or equal to a value. <property> lte <value>

filter=supportStartDate le 2024-07-01

Return server warranty information for the servers where a property is greater than or equal to a value. <property> gte <value>

filter=supportEndDate ge 2024-01-01

Return server warranty information for the servers where property mathces multiple conditions. <property> eq <value> and <property> le <value>

filter=supportState eq 'ACTIVE' and supportStartDate le 2024-07-01
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/server-warranty \
  -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)

UUID given to the resource by the system

items[].​typestring

Type of the resource

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

Monotonically increasing update counter

items[].​deviceIdstring(productId+serialNumber)

Primary identifier for the server given by the system

items[].​createdAtstring(date-time)

Time of server creation

items[].​updatedAtstring(date-time)

Time of the last server update

items[].​supportStatestring

Current support status of the server

Enum"ACTIVE""EXPIRED""UNKNOWN"
items[].​supportLevelstring

Support level of the server

Example: "Warranty"
items[].​contractLevelstring

Contract level of the server

Example: "HPE Warranty"
items[].​supportStartDatestring(date-time)

Support start date of the server

items[].​supportEndDatestring(date-time)

Support end date of the server

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

List server warranty information for a given UUID

Request

Retrieve server warranty data for the specified UUID.

Security
Bearer
Path
idstring(uuid)required

Unique identifier for the server warranty resource generated by the system.

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/server-warranty/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)

UUID given to the resource by the system

typestring

Type of the resource

Value "compute-ops-mgmt/server/warranty"
generationinteger>= 1

Monotonically increasing update counter

deviceIdstring(productId+serialNumber)

Primary identifier for the server given by the system

createdAtstring(date-time)

Time of server creation

updatedAtstring(date-time)

Time of the last server update

supportStatestring

Current support status of the server

Enum"ACTIVE""EXPIRED""UNKNOWN"
supportLevelstring

Support level of the server

Example: "Warranty"
contractLevelstring

Contract level of the server

Example: "HPE Warranty"
supportStartDatestring(date-time)

Support start date of the server

supportEndDatestring(date-time)

Support end date of the server

Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "compute-ops-mgmt/server/warranty", "generation": 1, "deviceId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "supportState": "ACTIVE", "supportLevel": "Warranty", "contractLevel": "HPE Warranty", "supportStartDate": "2019-08-24T14:15:22Z", "supportEndDate": "2019-08-24T14:15:22Z" }

user-preferences - v1

Operations

user-preferences - v1beta1

Operations

utilization-over-time - v1beta1

Operations

utilization-by-entity - v1beta1

Operations

webhooks - v1beta1

Operations