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

index.json

index.yaml

Overview

License

HPE End User License Agreement

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

Generate an activation key to onboard a device or appliance

Request

Note: This API only works with iLO 6 1.62 and later or with iLO 5 3.09 and later Generates a new activation key for onboarding iLO for direct management or secure gateway management, or secure gateway appliances

Security

Bearer

Headers

Content-Typestringrequired

Content-Type header must designate 'application/json' in order for the request to be performed.

Value "application/json"

Bodyapplication/jsonrequired

targetDevicestringrequired

Target device to be onboarded using the activation key. The following target device types are supported: iLO and secure gateway appliances.

Enum"ILO""SECURE_GATEWAY"

expirationInHoursnumber[ 0.5 .. 168 ]

Expiration duration of the generated activation key. Default is set as 72 hours.

Default 72

applianceUristring

The secure gateway appliance URI is required for onboarding a server for management through a secure gateway.

subscriptionKeystring

The device subscription to associate with the generated activation key. The subscription key will be added to the HPE GreenLake workspace automatically. It will be associated with the servers that are onboarded with the generated activation key. If auto-subscribe is enabled and a device subscription key is associated with an activation key, the assigned subscription key might not be the same key that was included in the activation key.

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/activation-keys \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "targetDevice": "ILO"
  }'

Responses

Successful Response

Bodyapplication/json

idstring(uuid)

Primary identifier of the activation key resource given by the system.

Example: "5fae6c47-13f4-42f3-97b5-540f3d085791"

typestring

Type of the resource

Value "compute-ops-mgmt/activation-key"

targetDevicestring

Target device to be onboarded

Enum"ILO""SECURE_GATEWAY"

expiresAtstring(date-time)

Time of activation key expiration.

Example: "2024-07-25T12:21:05.448576Z"

activationKeystring

Activation key generated to onboard the target device.

subscriptionKeystring

Device subscription that is associated with this activation key.

applianceUristring

Appliance URI of the onboarded appliance.

applianceNamestring

Name of the appliance.

createdAtstring(date-time)

Time of activation key creation.

Example: "2024-07-25T10:21:05.475123Z"

updatedAtstring(date-time)

Time of activation key updation.

Example: "2024-07-25T10:21:05.475123Z"

generationnumber

Monotonically increasing update counter.

Example: 1

Response

application/json

{
  "id": "5fae6c47-13f4-42f3-97b5-540f3d085791",
  "type": "compute-ops-mgmt/activation-key",
  "targetDevice": "ILO",
  "expiresAt": "2024-07-25T12:21:05.448576Z",
  "activationKey": "string",
  "subscriptionKey": "string",
  "applianceUri": "string",
  "applianceName": "string",
  "createdAt": "2024-07-25T10:21:05.475123Z",
  "updatedAt": "2024-07-25T10:21:05.475123Z",
  "generation": 1
}

Retrieve all activation keys to onboard a device or appliance

Request

Retrieve a paginated collection of activation keys for onboarding iLO for direct management or secure gateway management, or secure gateway appliances.

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

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.

CLASS	EXAMPLES
Types	integer, decimal, timestamp, string, boolean, null
Operations	eq, ne, gt, ge, lt, le, in
Logic	and, or, not

Activation-Keys can be filtered by:

targetDevice
activationKey
applianceUri
subscriptionKey

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

Examples:

Filter with equality check

Returns appliance firmware where a property equals a value. <property> eq <value>

filter=targetDevice eq 'ILO'

Filter with equality check

Returns appliance firmware where a property equals a value. <property> eq <value>

filter=targetDevice eq 'SECURE_GATEWAY'

Filter with url encoding applied to all reserved characters (example is fully URL encoded)

Returns all the activation keys that are generated for the given target device. <property>%20eq%20<value>

filter=targetDevice%20eq%20%27ILO%27

Filter on an inverted query

Returns appliance firmware where a property does not equal a value. <property> ne <value>

filter=activationKey ne '12345678'

Filter with multiple conditions

Returns appliance firmware where multiple conditions are met. <property> eq <value> and <property> eq <value>

filter=targetDevice eq 'ILO' and applianceUri eq '/compute-ops-mgmt/v1beta1/appliances/gateway+0b9dc54a-523f-421e-9e0f-6b586abb6b55'

Filter with multiple conditions and url encoding

Returns all the activation keys that are generated for the given target device and meet multiple conditions. <property>%20eq%20<value>%20and%20<property>%20eq%20<value>

filter=targetDevice%20eq%20%27ILO%27%20and%20subscriptionKey%20eq%20%2787654321%27

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/activation-keys \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json

countinteger>= 0required

Number of items returned

Example: 1

itemsArray of objectsrequired

Array of resources in the page of the collection.

items[].idstring(uuid)

Primary identifier of the activation key resource given by the system.

Example: "5fae6c47-13f4-42f3-97b5-540f3d085791"

items[].typestring

Type of the resource

Value "compute-ops-mgmt/activation-key"

items[].targetDevicestring

Target device to be onboarded

Enum"ILO""SECURE_GATEWAY"

items[].expiresAtstring(date-time)

Time of activation key expiration.

Example: "2024-07-25T12:21:05.448576Z"

items[].activationKeystring

Activation key generated to onboard the target device.

items[].subscriptionKeystring

Device subscription that is associated with this activation key.

items[].applianceUristring

Appliance URI of the onboarded appliance.

items[].applianceNamestring

Name of the appliance.

items[].createdAtstring(date-time)

Time of activation key creation.

Example: "2024-07-25T10:21:05.475123Z"

items[].updatedAtstring(date-time)

Time of activation key updation.

Example: "2024-07-25T10:21:05.475123Z"

items[].generationnumber

Monotonically increasing update counter.

Example: 1

offsetinteger>= 0required

Zero-based resource offset

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

Delete an activation key by activation key

Request

This API deletes an activation key generated to onboard iLO for direct management or secure gateway management.

Security

Bearer

Path

activation_keystringrequired

Unique activation key identifier

curl -i -X DELETE \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/activation-keys/{activation_key}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response

No content

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

user-preferences - v1

Operations

user-preferences - v1beta1

Operations

utilization-over-time - v1beta1

Operations

utilization-by-entity - v1beta1

Operations

webhooks - v1beta1

Operations

HPE Compute Ops Management API (latest)

UPDATED API ENDPOINTS

accounts - v1beta1

activation-keys - v1beta1

Generate an activation key to onboard a device or appliance

Request

Responses

Was this helpful?

Retrieve all activation keys to onboard a device or appliance

Request

Responses

Was this helpful?

Delete an activation key by activation key

Request

Responses

Was this helpful?

activation-tokens - v1beta1

activities - v1beta2

ahs-files - v1beta1

appliance-firmware-bundles - v1

appliance-firmware-bundles - v1beta1

async-operations - v1

async-operations - v1beta1

energy-over-time - v1beta1

energy-by-entity - v1beta1

external-services - v1beta1

filters - v1beta1

firmware-bundles - v1

firmware-bundles - v1beta2

groups - v1

groups - v1beta3

groups - v1beta2

job-templates - v1beta2

jobs - v1

jobs - v1beta3

jobs - v1beta2

metrics-configurations - v1

oneview-appliances - v1beta1

oneview-settings - v1beta1

oneview-server-templates - v1beta1

reports - v1beta2

schedules - v1beta2

server-locations - v1beta1

server-settings - v1beta1

settings - v1

settings - v1beta1

servers - v1

servers - v1beta2

server-warranty - v1beta2

user-preferences - v1

user-preferences - v1beta1

utilization-over-time - v1beta1

utilization-by-entity - v1beta1

webhooks - v1beta1