Skip to content
Internal API Catalog
/
HPE Compute Ops Management API
/
reports - v1beta2

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

List all reports

Request

Retrieve a paginated collection of report metadata resources. Currently, only the latest report of each type is retained.

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
Query
offsetinteger>= 0

Zero-based resource offset to start the response from

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

The maximum number of records to return.

Default 5
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

Reports can be filtered by:

  • createdAt
  • generation
  • id
  • reportDataEndAt
  • reportDataStartAt
  • reportType
  • resourceUri
  • type
  • updatedAt
  • status

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

Examples:

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

filter=name eq 'Carbon Footprint Report (All Servers)'

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

filter=id%20eq%20%27843023bd-9412-46c2-8ac2-a3691f657fdb

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

filter=not reportType eq 'CARBON_FOOTPRINT'

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

filter=not name eq null

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

filter=contains(createdAt,'2022')

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

filter=not id eq null and contains(createdAt,'2022')
sortstring

The order in which to return the resources in the collection.

The value of the sort query parameter is a comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direciton indicator is omitted the default direction is ascending.

Default "createdAt desc"
Examples:

Order resources ascending by name

sort=name asc

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc
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/reports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
countinteger>= 0required

Number of items returned

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
itemsArray of objectsrequired

Array of resources in the page of the collection.

items[].​idstring(uuid)

Primary identifier for the report metadata resource given by the system.

Example: "843023bd-9412-46c2-8ac2-a3691f657fdb"
items[].​namestring

The display name of the report.

Example: "Carbon Footprint Report (All Servers)"
items[].​typestring

The type of the resource.

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

Monotonically increasing update counter.

Example: 1
items[].​createdAtstring(date-time)

Time of report resource creation.

Example: "2022-02-11T01:04:20.799937+00:00"
items[].​updatedAtstring(date-time)

Time of the last update to the report resource.

Example: "2022-02-11T01:04:20.799937+00:00"
items[].​resourceUristring(uri-reference)

URI to the report metadata resource itself (i.e. a self link).

Example: "/compute-ops-mgmt/v1beta2/reports/843023bd-9412-46c2-8ac2-a3691f657fdb"
items[].​reportDataUristring(uri-reference)

URI to the data for the report.

Example: "/compute-ops-mgmt/v1beta2/reports/843023bd-9412-46c2-8ac2-a3691f657fdb/data"
items[].​reportTypestring(reportType)

The type of report. New report types may be added as a backward compatible change to the API.

Enum"CARBON_FOOTPRINT""SERVER_HARDWARE_INVENTORY"
items[].​reportTypeDisplayNamestring

The display name for the type of the report.

Example: "Carbon Footprint Report"
items[].​deviceIdsArray of strings or null
Example: "875765-S01+1M512501AB"
One of:

List of IDs of devices included in the report.

items[].​reportDataStartAtstring or null
Example: "2022-02-04T01:04:20+00:00"
One of:

Beginning of time range covered by the report. This field is applicable only for time series based reports such as CARBON_FOOTPRINT.

string(date-time)

Beginning of time range covered by the report. This field is applicable only for time series based reports such as CARBON_FOOTPRINT.

items[].​reportDataEndAtstring or null
Example: "2022-02-11T01:04:20+00:00"
One of:

End of time range covered by the report. This field is applicable only for time series based reports such as CARBON_FOOTPRINT.

string(date-time)

End of time range covered by the report. This field is applicable only for time series based reports such as CARBON_FOOTPRINT.

items[].​statusstring(reportStatus)

The current status of report generation, indicating whether a report is in progress, completed, or failed

Enum"IN_PROGRESS""COMPLETED""FAILED"
Response
application/json
{
  "offset": 0,
  "count": 1,
  "total": 12,
  "items": [
    { … }
  ]
}

Create report

Request

Create a report for specified time interval.

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
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/json
reportTypestring(reportType)required

The type of report. New report types may be added as a backward compatible change to the API.

Enum"CARBON_FOOTPRINT""SERVER_HARDWARE_INVENTORY"
reportStartTimestring(date-time)

Start of time range covered by the report. Applicable for reports generated based on metrics data collection setting (ex. Sustainability report).

Example: "2022-02-04T01:04:20+00:00"
reportEndTimestring(date-time)

End of time range covered by the report. Applicable for reports generated based on metrics data collection setting (ex. Sustainability report).

Example: "2022-02-11T01:04:20+00:00"
notifyViaEmailboolean

Field to opt for email notification when report creation is complete.

Default false
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/v1beta2/reports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "reportType": "CARBON_FOOTPRINT"
  }'

Responses

Successful Response

Headers
Locationstring(uri-reference)

The URI of the newly-created resource

Example: "/compute-ops-mgmt/v1beta2/reports/843023bd-9412-46c2-8ac2-a3691f657fdb"
Bodyapplication/json
idstring(uuid)

Primary identifier for the report metadata resource given by the system.

Example: "843023bd-9412-46c2-8ac2-a3691f657fdb"
namestring

The display name of the report.

Example: "Carbon Footprint Report (All Servers)"
typestring

The type of the resource.

Value "compute-ops-mgmt/report"
generationinteger>= 1

Monotonically increasing update counter.

Example: 1
createdAtstring(date-time)

Time of report resource creation.

Example: "2022-02-11T01:04:20.799937+00:00"
updatedAtstring(date-time)

Time of the last update to the report resource.

Example: "2022-02-11T01:04:20.799937+00:00"
resourceUristring(uri-reference)

URI to the report metadata resource itself (i.e. a self link).

Example: "/compute-ops-mgmt/v1beta2/reports/843023bd-9412-46c2-8ac2-a3691f657fdb"
reportDataUristring(uri-reference)

URI to the data for the report.

Example: "/compute-ops-mgmt/v1beta2/reports/843023bd-9412-46c2-8ac2-a3691f657fdb/data"
reportTypestring(reportType)

The type of report. New report types may be added as a backward compatible change to the API.

Enum"CARBON_FOOTPRINT""SERVER_HARDWARE_INVENTORY"
reportTypeDisplayNamestring

The display name for the type of the report.

Example: "Carbon Footprint Report"
deviceIdsArray of strings or null
Example: "875765-S01+1M512501AB"
One of:

List of IDs of devices included in the report.

reportDataStartAtstring or null
Example: "2022-02-04T01:04:20+00:00"
One of:

Beginning of time range covered by the report. This field is applicable only for time series based reports such as CARBON_FOOTPRINT.

string(date-time)

Beginning of time range covered by the report. This field is applicable only for time series based reports such as CARBON_FOOTPRINT.

reportDataEndAtstring or null
Example: "2022-02-11T01:04:20+00:00"
One of:

End of time range covered by the report. This field is applicable only for time series based reports such as CARBON_FOOTPRINT.

string(date-time)

End of time range covered by the report. This field is applicable only for time series based reports such as CARBON_FOOTPRINT.

statusstring(reportStatus)

The current status of report generation, indicating whether a report is in progress, completed, or failed

Enum"IN_PROGRESS""COMPLETED""FAILED"
Response
application/json
{
  "id": "843023bd-9412-46c2-8ac2-a3691f657fdb",
  "name": "Carbon Footprint Report (All Servers)",
  "type": "compute-ops-mgmt/report",
  "generation": 1,
  "createdAt": "2022-02-11T01:04:20.799937+00:00",
  "updatedAt": "2022-02-11T01:04:20.799937+00:00",
  "resourceUri": "/compute-ops-mgmt/v1beta2/reports/843023bd-9412-46c2-8ac2-a3691f657fdb",
  "reportDataUri": "/compute-ops-mgmt/v1beta2/reports/843023bd-9412-46c2-8ac2-a3691f657fdb/data",
  "reportType": "CARBON_FOOTPRINT",
  "reportTypeDisplayName": "Carbon Footprint Report",
  "deviceIds": "875765-S01+1M512501AB",
  "reportDataStartAt": "2022-02-04T01:04:20+00:00",
  "reportDataEndAt": "2022-02-11T01:04:20+00:00",
  "status": "IN_PROGRESS"
}

Get report metadata

Request

Retrieve a single report metadata resource by 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
idstring(uuid)required

Report ID

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

Responses

OK

Bodyapplication/json
idstring(uuid)

Primary identifier for the report metadata resource given by the system.

Example: "843023bd-9412-46c2-8ac2-a3691f657fdb"
namestring

The display name of the report.

Example: "Carbon Footprint Report (All Servers)"
typestring

The type of the resource.

Value "compute-ops-mgmt/report"
generationinteger>= 1

Monotonically increasing update counter.

Example: 1
createdAtstring(date-time)

Time of report resource creation.

Example: "2022-02-11T01:04:20.799937+00:00"
updatedAtstring(date-time)

Time of the last update to the report resource.

Example: "2022-02-11T01:04:20.799937+00:00"
resourceUristring(uri-reference)

URI to the report metadata resource itself (i.e. a self link).

Example: "/compute-ops-mgmt/v1beta2/reports/843023bd-9412-46c2-8ac2-a3691f657fdb"
reportDataUristring(uri-reference)

URI to the data for the report.

Example: "/compute-ops-mgmt/v1beta2/reports/843023bd-9412-46c2-8ac2-a3691f657fdb/data"
reportTypestring(reportType)

The type of report. New report types may be added as a backward compatible change to the API.

Enum"CARBON_FOOTPRINT""SERVER_HARDWARE_INVENTORY"
reportTypeDisplayNamestring

The display name for the type of the report.

Example: "Carbon Footprint Report"
deviceIdsArray of strings or null
Example: "875765-S01+1M512501AB"
One of:

List of IDs of devices included in the report.

reportDataStartAtstring or null
Example: "2022-02-04T01:04:20+00:00"
One of:

Beginning of time range covered by the report. This field is applicable only for time series based reports such as CARBON_FOOTPRINT.

string(date-time)

Beginning of time range covered by the report. This field is applicable only for time series based reports such as CARBON_FOOTPRINT.

reportDataEndAtstring or null
Example: "2022-02-11T01:04:20+00:00"
One of:

End of time range covered by the report. This field is applicable only for time series based reports such as CARBON_FOOTPRINT.

string(date-time)

End of time range covered by the report. This field is applicable only for time series based reports such as CARBON_FOOTPRINT.

statusstring(reportStatus)

The current status of report generation, indicating whether a report is in progress, completed, or failed

Enum"IN_PROGRESS""COMPLETED""FAILED"
Response
application/json
{
  "id": "843023bd-9412-46c2-8ac2-a3691f657fdb",
  "name": "Carbon Footprint Report (All Servers)",
  "type": "compute-ops-mgmt/report",
  "generation": 1,
  "createdAt": "2022-02-11T01:04:20.799937+00:00",
  "updatedAt": "2022-02-11T01:04:20.799937+00:00",
  "resourceUri": "/compute-ops-mgmt/v1beta2/reports/843023bd-9412-46c2-8ac2-a3691f657fdb",
  "reportDataUri": "/compute-ops-mgmt/v1beta2/reports/843023bd-9412-46c2-8ac2-a3691f657fdb/data",
  "reportType": "CARBON_FOOTPRINT",
  "reportTypeDisplayName": "Carbon Footprint Report",
  "deviceIds": "875765-S01+1M512501AB",
  "reportDataStartAt": "2022-02-04T01:04:20+00:00",
  "reportDataEndAt": "2022-02-11T01:04:20+00:00",
  "status": "IN_PROGRESS"
}

Get report data

Request

Retrieve the data for a report

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(uuid)required

Report ID

Query
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 charecters ! # $ & ' ( ) * + , / : ; = ? @ [ ] 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
Examples:

Return resources where id == c650e411-3454-475d-a1af-7a31b21a1ce4

filter=eq(id,'c650e411-3454-475d-a1af-7a31b21a1ce4')

Return server where id == c650e411-3454-475d-a1af-7a31b21a1ce4

filter=eq(id,%27c650e411-3454-475d-a1af-7a31b21a1ce4%27)

Return resources where applianceType is VM and state is connected

filter=and(eq(applianceType,'VM'),eq(state,'connected'))

Return resources where applianceType is VM or UNKNOWN

filter=in(applianceType,'VM','UNKNOWN')
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/reports/{id}/data' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)

Primary identifier for the report metadata resource given by the system.

Example: "843023bd-9412-46c2-8ac2-a3691f657fdb"
typestring

The type of the resource.

Value "compute-ops-mgmt/report-data"
namestring

The display name of the report.

Example: "Carbon Footprint Report (All Servers)"
requestobject

Information about the requested report data.

groupingNamestring

Specifies the groupby attribute. This field is applicable only for SERVER_HARDWARE_INVENTORY report

dataCarbon Footprint Report Data (object) or Server Hardware Inventory Report Data (object)
One of:

Content of the report, varies depending on reportType.

Response
application/json
{
  "id": "843023bd-9412-46c2-8ac2-a3691f657fdb",
  "type": "compute-ops-mgmt/report-data",
  "name": "Carbon Footprint Report (All Servers)",
  "request": {
    "reportDataStartAt": "2022-02-04T01:04:20+00:00",
    "reportDataEndAt": "2022-02-11T01:04:20+00:00",
    "reportType": "CARBON_FOOTPRINT",
    "groupBy": "string"
  },
  "groupingName": "string",
  "data": {
    "series": [ … ]
  }
}

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