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

HPE End User License Agreement

Languages
Servers
Mock server

https://developer.greenlake.hpe.com/_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

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

List metrics data collection configuration

Request

List metrics data collection configuration

Security
Bearer
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://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/metrics-configurations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0required

Zero-based resource offset

itemsArray of objectsrequired
items[].​idstring(uuid)read-only

Primary identifier for the metrics configuration resource given by the system.

Example: "b870f080-6448-48c5-b23a-d04f2d489174"
items[].​typestring

Type of the resource

Value "compute-ops-mgmt/metrics-configuration"
items[].​resourceUristring(uri-reference)

URI to the metrics-configuration itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1/metrics-configurations/b870f080-6448-48c5-b23a-d04f2d489174"
items[].​metricsCollectionstring

Metrics collection method to indicate if the metrics collection is scheduled or generated on demand.

Enum"SYSTEM_SCHEDULED""ON_DEMAND"
items[].​generationinteger>= 1

Monotonically increasing update counter

items[].​createdAtstring(date-time)

Time of metrics configuration creation

Example: "2023-07-07T05:51:02.624513+00:00"
items[].​updatedAtstring(date-time)

Time of the metrics configuration update

Example: "2023-07-07T05:51:02.624513+00:00"
items[].​powerThresholdAlertsboolean

Boolean to indicate whether power utilization alerts have to be enabled or not.

Default true
items[].​powerUtilizationThresholdPercentageinteger

Threshold value in percentage beyond which power utilization alerts will be generated.

Default 10
items[].​alertResourcesArray of objects(metricsConfigurationAlertResources-v1)

Alerts resources for power utilization alerts

totalinteger>= 0

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

Create metrics data collection configuration

Request

Create metrics data collection configuration

Security
Bearer
Headers
Content-Typestringrequired

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

Value "application/json"
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
metricsCollectionstring

Metrics collection method to indicate if the metrics collection is scheduled or generated on demand.

Enum"SYSTEM_SCHEDULED""ON_DEMAND"
powerThresholdAlertsboolean

Boolean to indicate whether power utilization alerts have to be enabled or not.

Default true
powerUtilizationThresholdPercentageinteger

Threshold value in percentage beyond which power utilization alerts will be generated.

Default 10
alertResourcesArray of objects(metricsConfigurationAlertResources-v1)

Alerts resources for power utilization alerts

curl -i -X POST \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/metrics-configurations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Successful Response

Headers
Locationstring(uri-reference)

The URI of the newly-created resource

Example: "/compute-ops-mgmt/v1/metrics-configurations/b870f080-6448-48c5-b23a-d04f2d489174"
Bodyapplication/json
idstring(uuid)read-only

Primary identifier for the metrics configuration resource given by the system.

Example: "b870f080-6448-48c5-b23a-d04f2d489174"
typestring

Type of the resource

Value "compute-ops-mgmt/metrics-configuration"
resourceUristring(uri-reference)

URI to the metrics-configuration itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1/metrics-configurations/b870f080-6448-48c5-b23a-d04f2d489174"
metricsCollectionstring

Metrics collection method to indicate if the metrics collection is scheduled or generated on demand.

Enum"SYSTEM_SCHEDULED""ON_DEMAND"
generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of metrics configuration creation

Example: "2023-07-07T05:51:02.624513+00:00"
updatedAtstring(date-time)

Time of the metrics configuration update

Example: "2023-07-07T05:51:02.624513+00:00"
powerThresholdAlertsboolean

Boolean to indicate whether power utilization alerts have to be enabled or not.

Default true
powerUtilizationThresholdPercentageinteger

Threshold value in percentage beyond which power utilization alerts will be generated.

Default 10
alertResourcesArray of objects(metricsConfigurationAlertResources-v1)

Alerts resources for power utilization alerts

Response
application/json
{
  "id": "b870f080-6448-48c5-b23a-d04f2d489174",
  "type": "compute-ops-mgmt/metrics-configuration",
  "resourceUri": "/compute-ops-mgmt/v1/metrics-configurations/b870f080-6448-48c5-b23a-d04f2d489174",
  "metricsCollection": "SYSTEM_SCHEDULED",
  "generation": 1,
  "createdAt": "2023-07-07T05:51:02.624513+00:00",
  "updatedAt": "2023-07-07T05:51:02.624513+00:00",
  "powerThresholdAlerts": true,
  "powerUtilizationThresholdPercentage": 10,
  "alertResources": [
    { … }
  ]
}

Get metrics-configuration item by ID

Request

Get specific metrics-configuration item by metrics-configuration id.

Security
Bearer
Path
idstring(uuid)required
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://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/metrics-configurations/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)read-only

Primary identifier for the metrics configuration resource given by the system.

Example: "b870f080-6448-48c5-b23a-d04f2d489174"
typestring

Type of the resource

Value "compute-ops-mgmt/metrics-configuration"
resourceUristring(uri-reference)

URI to the metrics-configuration itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1/metrics-configurations/b870f080-6448-48c5-b23a-d04f2d489174"
metricsCollectionstring

Metrics collection method to indicate if the metrics collection is scheduled or generated on demand.

Enum"SYSTEM_SCHEDULED""ON_DEMAND"
generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of metrics configuration creation

Example: "2023-07-07T05:51:02.624513+00:00"
updatedAtstring(date-time)

Time of the metrics configuration update

Example: "2023-07-07T05:51:02.624513+00:00"
powerThresholdAlertsboolean

Boolean to indicate whether power utilization alerts have to be enabled or not.

Default true
powerUtilizationThresholdPercentageinteger

Threshold value in percentage beyond which power utilization alerts will be generated.

Default 10
alertResourcesArray of objects(metricsConfigurationAlertResources-v1)

Alerts resources for power utilization alerts

Response
application/json
{
  "id": "b870f080-6448-48c5-b23a-d04f2d489174",
  "type": "compute-ops-mgmt/metrics-configuration",
  "resourceUri": "/compute-ops-mgmt/v1/metrics-configurations/b870f080-6448-48c5-b23a-d04f2d489174",
  "metricsCollection": "SYSTEM_SCHEDULED",
  "generation": 1,
  "createdAt": "2023-07-07T05:51:02.624513+00:00",
  "updatedAt": "2023-07-07T05:51:02.624513+00:00",
  "powerThresholdAlerts": true,
  "powerUtilizationThresholdPercentage": 10,
  "alertResources": [
    { … }
  ]
}

Delete a metrics-configuration item

Request

Delete a metrics-configuration item.

Security
Bearer
Path
idstring(uuid)required
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 DELETE \
  'https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/metrics-configurations/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response
No content

Patch a metrics-configuration item

Request

Partially update a metrics-configuration item

Security
Bearer
Path
idstring(uuid)required
Headers
Content-Typestringrequired

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

Value "application/merge-patch+json"
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/merge-patch+jsonrequired
metricsCollectionstring

Metrics collection method to indicate if the metrics collection is scheduled or generated on demand.

Enum"SYSTEM_SCHEDULED""ON_DEMAND"
powerThresholdAlertsboolean

Boolean to indicate whether power utilization alerts have to be enabled or not.

Default true
powerUtilizationThresholdPercentageinteger

Threshold value in percentage beyond which power utilization alerts will be generated.

Default 10
alertResourcesArray of objects(metricsConfigurationAlertResources-v1)

Alerts resources for power utilization alerts

curl -i -X PATCH \
  'https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/metrics-configurations/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)read-only

Primary identifier for the metrics configuration resource given by the system.

Example: "b870f080-6448-48c5-b23a-d04f2d489174"
typestring

Type of the resource

Value "compute-ops-mgmt/metrics-configuration"
resourceUristring(uri-reference)

URI to the metrics-configuration itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1/metrics-configurations/b870f080-6448-48c5-b23a-d04f2d489174"
metricsCollectionstring

Metrics collection method to indicate if the metrics collection is scheduled or generated on demand.

Enum"SYSTEM_SCHEDULED""ON_DEMAND"
generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of metrics configuration creation

Example: "2023-07-07T05:51:02.624513+00:00"
updatedAtstring(date-time)

Time of the metrics configuration update

Example: "2023-07-07T05:51:02.624513+00:00"
powerThresholdAlertsboolean

Boolean to indicate whether power utilization alerts have to be enabled or not.

Default true
powerUtilizationThresholdPercentageinteger

Threshold value in percentage beyond which power utilization alerts will be generated.

Default 10
alertResourcesArray of objects(metricsConfigurationAlertResources-v1)

Alerts resources for power utilization alerts

Response
application/json
{
  "id": "b870f080-6448-48c5-b23a-d04f2d489174",
  "type": "compute-ops-mgmt/metrics-configuration",
  "resourceUri": "/compute-ops-mgmt/v1/metrics-configurations/b870f080-6448-48c5-b23a-d04f2d489174",
  "metricsCollection": "SYSTEM_SCHEDULED",
  "generation": 1,
  "createdAt": "2023-07-07T05:51:02.624513+00:00",
  "updatedAt": "2023-07-07T05:51:02.624513+00:00",
  "powerThresholdAlerts": true,
  "powerUtilizationThresholdPercentage": 10,
  "alertResources": [
    { … }
  ]
}

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