Skip to content
Internal API Catalog
/
HPE Compute Ops Management API
/
oneview-appliances - v1beta1

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

List all OneView appliances

Request

Retrieve data for all OneView appliances.

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
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 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')
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.

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/v1beta1/oneview-appliances \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0required

Zero-based resource offset

itemsArray of objectsrequired
items[].​idstring(uuid)required

Primary identifier for the appliance

Example: "87654321-f71a-43d2-8b93-4c7391b31234"
items[].​typestringrequired

Type of resource

Example: "compute-ops-mgmt/oneview-appliance"
items[].​ipaddressstring(ipv4)

IP address of the appliance

items[].​device-idstring

Primary unique identifier for the appliance

Example: "oneview+87654321-f71a-43d2-8b93-4c7391b31234"
items[].​activationKeystring

Key to be used by customers to activate the appliance

Example: "ABCDEFGHOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwY2lkIjoiNjg0YTVhMWEyOTU3MTFlZGE1MDF"
items[].​applicationCustomerIdstring(uuid)

Primary identifier for application customer

items[].​complianceIdstring(uuid)

Primary identifier for compliance state entry

items[].​namestring

Name of the appliance

Example: "ci-005056abcdef.com"
items[].​complianceLastCheckedstring(date-time)

Time of last compliance check being performed

items[].​complianceStatestring

Compliance state of the appliance

Enum"Compliant""Not_compliant""Unknown"
items[].​createdAtstring

Time of appliance entry creation

Example: "2023-03-01T10:50:33.736935+00:00"
items[].​generationinteger

Monotonically increasing update counter

Example: 1
items[].​hostnamestring

Host name of the appliance

Example: "ci-005056abcdef.com"
items[].​lastModifiedstring(date-time)

Time of the last appliance update

items[].​modelNumberstring

Model of the appliance

Example: "HPE OneView VM - VMware vSphere"
items[].​platformCustomerIdstring(uuid)

Primary identifier for platform customer

items[].​productIdstring

Product identifier for the appliance

Example: "oneview"
items[].​statestring

Connectivity state of the appliance

Enum"connected""not activated""disconnected"
items[].​templateIdstring(uuid)

Primary identifier of settings template created using this appliance

items[].​templateNamestring

Name of the settings template

Example: "Snmp_template"
items[].​updatedAtstring

Time of last appliance updated

Example: "2023-03-01T11:05:00.554140+00:00"
items[].​versionstring

Version of the OneView appliance

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

Add a OneView appliance

Request

Add a OneView appliance for management.

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

Unique identifier of the OneView appliance to be added

Example: "497f6eca-6276-4993-bfeb-53cbbbbaabcd"
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/oneview-appliances \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)required

Primary identifier for the appliance

Example: "87654321-f71a-43d2-8b93-4c7391b31234"
typestringrequired

Type of resource

Example: "compute-ops-mgmt/oneview-appliance"
ipaddressstring(ipv4)

IP address of the appliance

device-idstring

Primary unique identifier for the appliance

Example: "oneview+87654321-f71a-43d2-8b93-4c7391b31234"
activationKeystring

Key to be used by customers to activate the appliance

Example: "ABCDEFGHOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwY2lkIjoiNjg0YTVhMWEyOTU3MTFlZGE1MDF"
applicationCustomerIdstring(uuid)

Primary identifier for application customer

complianceIdstring(uuid)

Primary identifier for compliance state entry

namestring

Name of the appliance

Example: "ci-005056abcdef.com"
complianceLastCheckedstring(date-time)

Time of last compliance check being performed

complianceStatestring

Compliance state of the appliance

Enum"Compliant""Not_compliant""Unknown"
createdAtstring

Time of appliance entry creation

Example: "2023-03-01T10:50:33.736935+00:00"
generationinteger

Monotonically increasing update counter

Example: 1
hostnamestring

Host name of the appliance

Example: "ci-005056abcdef.com"
lastModifiedstring(date-time)

Time of the last appliance update

modelNumberstring

Model of the appliance

Example: "HPE OneView VM - VMware vSphere"
platformCustomerIdstring(uuid)

Primary identifier for platform customer

productIdstring

Product identifier for the appliance

Example: "oneview"
statestring

Connectivity state of the appliance

Enum"connected""not activated""disconnected"
templateIdstring(uuid)

Primary identifier of settings template created using this appliance

templateNamestring

Name of the settings template

Example: "Snmp_template"
updatedAtstring

Time of last appliance updated

Example: "2023-03-01T11:05:00.554140+00:00"
versionstring

Version of the OneView appliance

Example: "8.00.00"
Response
application/json
{
  "id": "87654321-f71a-43d2-8b93-4c7391b31234",
  "type": "compute-ops-mgmt/oneview-appliance",
  "ipaddress": "192.168.0.1",
  "device-id": "oneview+87654321-f71a-43d2-8b93-4c7391b31234",
  "activationKey": "ABCDEFGHOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwY2lkIjoiNjg0YTVhMWEyOTU3MTFlZGE1MDF",
  "applicationCustomerId": "a14b2d8b-36e7-469a-bfe7-d76cdfe9c9e0",
  "complianceId": "8b8f9dca-99cf-4557-a604-978243dee321",
  "name": "ci-005056abcdef.com",
  "complianceLastChecked": "2019-08-24T14:15:22Z",
  "complianceState": "Compliant",
  "createdAt": "2023-03-01T10:50:33.736935+00:00",
  "generation": 1,
  "hostname": "ci-005056abcdef.com",
  "lastModified": "2019-08-24T14:15:22Z",
  "modelNumber": "HPE OneView VM - VMware vSphere",
  "platformCustomerId": "ed05a375-a042-4c8b-bb6b-1c36abd2238b",
  "productId": "oneview",
  "state": "connected",
  "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
  "templateName": "Snmp_template",
  "updatedAt": "2023-03-01T11:05:00.554140+00:00",
  "version": "8.00.00"
}

Get a OneView appliance by id

Request

Get a specific OneView appliance 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
device-idstringrequired

Unique identifier of the OneView appliance for which information is retrieved

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/v1beta1/oneview-appliances/{device-id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)required

Primary identifier for the appliance

Example: "87654321-f71a-43d2-8b93-4c7391b31234"
typestringrequired

Type of resource

Example: "compute-ops-mgmt/oneview-appliance"
ipaddressstring(ipv4)

IP address of the appliance

device-idstring

Primary unique identifier for the appliance

Example: "oneview+87654321-f71a-43d2-8b93-4c7391b31234"
activationKeystring

Key to be used by customers to activate the appliance

Example: "ABCDEFGHOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwY2lkIjoiNjg0YTVhMWEyOTU3MTFlZGE1MDF"
applicationCustomerIdstring(uuid)

Primary identifier for application customer

complianceIdstring(uuid)

Primary identifier for compliance state entry

namestring

Name of the appliance

Example: "ci-005056abcdef.com"
complianceLastCheckedstring(date-time)

Time of last compliance check being performed

complianceStatestring

Compliance state of the appliance

Enum"Compliant""Not_compliant""Unknown"
createdAtstring

Time of appliance entry creation

Example: "2023-03-01T10:50:33.736935+00:00"
generationinteger

Monotonically increasing update counter

Example: 1
hostnamestring

Host name of the appliance

Example: "ci-005056abcdef.com"
lastModifiedstring(date-time)

Time of the last appliance update

modelNumberstring

Model of the appliance

Example: "HPE OneView VM - VMware vSphere"
platformCustomerIdstring(uuid)

Primary identifier for platform customer

productIdstring

Product identifier for the appliance

Example: "oneview"
statestring

Connectivity state of the appliance

Enum"connected""not activated""disconnected"
templateIdstring(uuid)

Primary identifier of settings template created using this appliance

templateNamestring

Name of the settings template

Example: "Snmp_template"
updatedAtstring

Time of last appliance updated

Example: "2023-03-01T11:05:00.554140+00:00"
versionstring

Version of the OneView appliance

Example: "8.00.00"
Response
application/json
{
  "id": "87654321-f71a-43d2-8b93-4c7391b31234",
  "type": "compute-ops-mgmt/oneview-appliance",
  "ipaddress": "192.168.0.1",
  "device-id": "oneview+87654321-f71a-43d2-8b93-4c7391b31234",
  "activationKey": "ABCDEFGHOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwY2lkIjoiNjg0YTVhMWEyOTU3MTFlZGE1MDF",
  "applicationCustomerId": "a14b2d8b-36e7-469a-bfe7-d76cdfe9c9e0",
  "complianceId": "8b8f9dca-99cf-4557-a604-978243dee321",
  "name": "ci-005056abcdef.com",
  "complianceLastChecked": "2019-08-24T14:15:22Z",
  "complianceState": "Compliant",
  "createdAt": "2023-03-01T10:50:33.736935+00:00",
  "generation": 1,
  "hostname": "ci-005056abcdef.com",
  "lastModified": "2019-08-24T14:15:22Z",
  "modelNumber": "HPE OneView VM - VMware vSphere",
  "platformCustomerId": "ed05a375-a042-4c8b-bb6b-1c36abd2238b",
  "productId": "oneview",
  "state": "connected",
  "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
  "templateName": "Snmp_template",
  "updatedAt": "2023-03-01T11:05:00.554140+00:00",
  "version": "8.00.00"
}

Delete a OneView appliance by id

Request

Delete a specific OneView appliance 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
device-idstringrequired

Unique identifier of the OneView appliance to be deleted

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://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/oneview-appliances/{device-id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response
No content

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