Skip to content
/
Analyze server configurat...

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

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-latest/

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

servers - v1beta2

Operations

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

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
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/v1beta2/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
}

Get external storage details

Request

Retrieves external storage hosts and volume details for a server specified by the server 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 server 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://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/external-storage-details' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success (Server's external storage details)

Bodyapplication/json
serverIdstring(uuid)

The server id for the volume details

createdAtstring(date-time)

Time the volume details were gathered

updatedAtstring(date-time)

The last time the volume details were updated

generationinteger>= 1

Monotonically increasing update counter

volumeDetailsArray of objects

Details of the volumes attached to the server

hostNamestring

Name of the host

hostOsstring(externalStorageHostOS)
Enum"UNKNOWN""AIX""APPLE"
hostGroupsArray of objects

Host groups to which the host belongs

Response
application/json
{
  "serverId": "10d2345a-e43d-463d-830e-4f5b19b60d41",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "generation": 1,
  "volumeDetails": [
    { … }
  ],
  "hostName": "string",
  "hostOs": "UNKNOWN",
  "hostGroups": [
    { … }
  ]
}

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