Skip to content
API reference
/
/
Clear power utilization a...

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
openapi.json
openapi.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
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/

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-remote/openapi/

accounts - v1beta1

Operations

activation-keys - v1beta1

Operations

activation-tokens - v1beta1

Operations

activities - v1beta2

Operations

ahs-files - v1beta1

Operations

secure-gateway-appliances - v1beta2

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

List all alerts for a server

Request

Retrieve alert data for a Server specified by the id of the server

Security
Bearer
Path
idstringrequired

Unique Server identifier

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.

CLASSEXAMPLES
Typesinteger, decimal, timestamp, string, boolean, null
Operationseq, ne, gt, ge, lt, le, in
Logicand, or, not

Servers can be filtered by:

  • biosFamily
  • createdAt
  • firmwareBundleUri
  • hardware and all nested properties
  • host and all nested properties
  • id
  • name †
  • oneview and all nested properties
  • platformFamily
  • processorVendor
  • resourceUri
  • state and all nested properties

† When searching for a server using the name filter, you must supply the serial number of the server, not the hostname. To filter by hostname use host/hostname instead of name

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

Examples:

Return servers where a property equals a value. <property> eq <value>

filter=host/hostname eq 'myServer'

Return servers where a nested property equals a value. <property>/<nestedProperty> eq <value>

filter=state/managed eq 'true'

Return servers where a property equals a value, using a url. <property>%20eq%20%27<value>

filter=id%20eq%20%27497f6eca-6276-4993-bfeb-53cbbbba6f08

Return servers where a property does not equal a value not <property> eq <value>

filter=not name eq 'MXQ89990RR'

Return servers with populated property. not <property> eq null

filter=not name eq null

Return servers where property contains a value. contains(<property>, <value>)

filter=contains(createdAt,'2019')

Return servers where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)

filter=not name eq null and contains(createdAt,'2019')

Return servers where property is one of multiple values. <property>/<nestedProperty> in (<value>,<value>)

filter=state/managed in ('true','false')
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://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/servers/{id}/alerts' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Server's Alert Data

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0required

Zero-based resource offset

itemsArray of objects(alert-v1)required
items[].​idstring(uuid)required

Primary identifier for the alert given by the system

items[].​typestringrequired

Type of the resource

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

Monotonically increasing update counter

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

Time of alert creation

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

Time of the last alert update

items[].​serverIdstring

ID of the server to which this alert is associated

items[].​severitystring
Enum"OK""WARNING""CRITICAL"
items[].​descriptionstring
items[].​resolutionstring
items[].​messagestring
items[].​timestampstring(date-time)
items[].​categorystring
items[].​serviceEventboolean
items[].​serviceNowIncidentobject

ServiceNow incident details. This data will only be available when a ServiceNow incident is created for a service event.

items[].​caseIdinteger

ID of the automatically created HPE Support Case. This will be available only when a HPE Support Case is created for a service event.

Example: 9815373940
items[].​caseUrlstring

URL of the automatically created HPE Support Case. This will be available only when a HPE Support Case is created for a service event.

Example: "https://example.hpe.com/portal/site/hpsc/scm/caseDetails?caseID=9815373940"
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": [
    { … }
  ]
}

Clear power utilization alerts for a server

Request

Clear power utilization alerts for a server

Security
Bearer
Path
idstring(productId+serialNumber)required

Unique Server identifier

Example: P43990-121+SYN1002J11
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.

Bodyapplication/jsonrequired
alertsArray of objects(clearAlertData-v1)required

Alerts resources for power utilization alerts

alerts[].​serverIdstring(productId+serialNumber)

Primary identifier for the server given by the system.

Example: "P43990-121+SYN1002J11"
alerts[].​messageIdstring

Unique identifier assigned to alert messages.

Example: "Utilization.1.0.ProjectedCriticalPowerUtilExceeded"
alerts[].​originOfConditionstring

Property within the alert event data that indicates the source or origin of the condition that triggered the alert

Example: "/api/powerutilization/P39886-B21+MXQ1480B03"
curl -i -X POST \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/servers/P43990-121+SYN1002J11/clear-alert' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "alerts": [
      {}
    ]
  }'

Responses

Successful Response

Response
No content

Analyze server configuration for operating system installation

Request

Validate the presence of storage volume for the server specified by the id for operating system installation. The request body is empty.

Security
Bearer
Path
idstring(productId+serialNumber)required

Unique Server identifier

Example: P43990-121+SYN1002J11
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 POST \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/servers/P43990-121+SYN1002J11/analyze-os-install' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
serverHasStorageVolumeboolean

Returns true, if the storage volume is present in the server

Response
application/json
{
  "serverHasStorageVolume": true
}

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