Skip to content
/
Subscribe users

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

server-warranty - v1beta2

Operations

user-preferences - v1

Operations

Get user preferences for the current user

Request

Retrieves the user preferences for the current user. The returned list will contain only one element if preferences have been set, zero otherwise.

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://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/user-preferences \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of user preferences

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: 1
itemsArray of objects(userPreferencesResponse-v1)required
items[].​idstring

Unique user preference identifier

Example: "36e00ac2-16fb-4dd5-8495-7e6df82fc15e"
items[].​typestringread-only

The type of the resource.

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

Monotonically increasing update counter

items[].​createdAtstring(date-time)

Time of preferences creation

items[].​updatedAtstring(date-time)

Time of the last preferences update

items[].​criticalNotificationboolean

Default notification choice for server critical notifications that are service-level events via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

items[].​criticalNonServiceNotificationboolean

Default notification choice for server critical notifications that are non-service-level events via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

items[].​warningNotificationboolean

Default notification choice for server warning-level events via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

items[].​healthNotificationboolean

Default notification choice for daily server health notification via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

items[].​powerResetNotificationboolean

Default notification choice for out-of-band power operations via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

items[].​disconnectNotificationinteger or null
One of:
One of:

Default notification choice for server disconnect or not monitored state via email. An integer value represents the number of hours a server has to remain in the disconnected or not monitored state to notify. A null value disables disconnect or not monitored notifications.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

[ 1 .. 3 ]
integer[ 1 .. 3 ]
Response
application/json
{
  "offset": 0,
  "count": 1,
  "total": 1,
  "items": [
    { … }
  ]
}

Create user preferences for the current user

Request

Purpose

When a server is added to Compute Ops Management, these attributes will be used to set the initial email notification subscription choices for event and daily health email notifications.

For criticalNotification, criticalNonServiceNotification, and warningNotification, each selection increases the scope of the set of events that will be included. The order of event selections from minimum to maximum scope are:

  • criticalNotification - Events that are marked as service events. These events may have severity levels of 'warning' or 'critical'
  • criticalNonServiceNotification - Events that are not service events but have a severity level of 'critical'
  • warningNotification - Events that are not service events but have a severity level of 'warning'

Since each selection builds on the previous one, there exists a hierarchy between selections that must be maintained. The table below shows which notification combinations are valid. All other combinations will result in an HTTP 400 error

criticalNotificationcriticalNonServiceNotificationwarningNotification
FalseFalseFalse
TrueFalseFalse
TrueTrueFalse
TrueTrueTrue

healthNotification, powerResetNotification, and disconnectNotification do not build on each other and may be configured independently.

  • healthNotification enables the daily summary health report for the server.
  • powerResetNotification enables notifications for out-of-band power operations.
  • disconnectNotification enables notifications to be sent when the server remains in the disconnected or not monitored state after the configured number of hours. A null value in this field disables disconnect and not monitored notifications.

Initial values

All values are initially 'off' (false or null) with the result being that no notifications will be sent.

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.

Bodyapplication/jsonrequired
criticalNotificationbooleanrequired
criticalNonServiceNotificationboolean
warningNotificationboolean
healthNotificationboolean
powerResetNotificationboolean
disconnectNotificationinteger or null
One of:
[ 1 .. 3 ]
integer[ 1 .. 3 ]
curl -i -X POST \
  https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/user-preferences \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "criticalNotification": true
  }'

Responses

Successful Response

Bodyapplication/json
idstring

Unique user preference identifier

Example: "36e00ac2-16fb-4dd5-8495-7e6df82fc15e"
typestringread-only

The type of the resource.

Value "compute-ops-mgmt/user-preference"
generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of preferences creation

updatedAtstring(date-time)

Time of the last preferences update

criticalNotificationboolean

Default notification choice for server critical notifications that are service-level events via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

criticalNonServiceNotificationboolean

Default notification choice for server critical notifications that are non-service-level events via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

warningNotificationboolean

Default notification choice for server warning-level events via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

healthNotificationboolean

Default notification choice for daily server health notification via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

powerResetNotificationboolean

Default notification choice for out-of-band power operations via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

disconnectNotificationinteger or null
One of:

Default notification choice for server disconnect or not monitored state via email. An integer value represents the number of hours a server has to remain in the disconnected or not monitored state to notify. A null value disables disconnect or not monitored notifications.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

[ 1 .. 3 ]
integer[ 1 .. 3 ]
Response
application/json
{
  "id": "36e00ac2-16fb-4dd5-8495-7e6df82fc15e",
  "type": "compute-ops-mgmt/user-preference",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "criticalNotification": true,
  "criticalNonServiceNotification": true,
  "warningNotification": true,
  "healthNotification": true,
  "powerResetNotification": true,
  "disconnectNotification": 1
}

Get a specific user preference object

Request

Retrieve a user preference object specified by its id

Security
Bearer
Path
idstringrequired

Unique user preferences object 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/v1/user-preferences/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

User preference object

Bodyapplication/json
idstring

Unique user preference identifier

Example: "36e00ac2-16fb-4dd5-8495-7e6df82fc15e"
typestringread-only

The type of the resource.

Value "compute-ops-mgmt/user-preference"
generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of preferences creation

updatedAtstring(date-time)

Time of the last preferences update

criticalNotificationboolean

Default notification choice for server critical notifications that are service-level events via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

criticalNonServiceNotificationboolean

Default notification choice for server critical notifications that are non-service-level events via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

warningNotificationboolean

Default notification choice for server warning-level events via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

healthNotificationboolean

Default notification choice for daily server health notification via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

powerResetNotificationboolean

Default notification choice for out-of-band power operations via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

disconnectNotificationinteger or null
One of:

Default notification choice for server disconnect or not monitored state via email. An integer value represents the number of hours a server has to remain in the disconnected or not monitored state to notify. A null value disables disconnect or not monitored notifications.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

[ 1 .. 3 ]
integer[ 1 .. 3 ]
Response
application/json
{
  "id": "36e00ac2-16fb-4dd5-8495-7e6df82fc15e",
  "type": "compute-ops-mgmt/user-preference",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "criticalNotification": true,
  "criticalNonServiceNotification": true,
  "warningNotification": true,
  "healthNotification": true,
  "powerResetNotification": true,
  "disconnectNotification": 1
}

Update user preferences

Request

Purpose

When a server is added to Compute Ops Management, these attributes will be used to set the initial email notification subscription choices for event and daily health email notifications.

For criticalNotification, criticalNonServiceNotification, and warningNotification, each selection increases the scope of the set of events that will be included. The order of event selections from minimum to maximum scope are:

  • criticalNotification - Events that are marked as service events. These events may have severity levels of 'warning' or 'critical'
  • criticalNonServiceNotification - Events that are not service events but have a severity level of 'critical'
  • warningNotification - Events that are not service events but have a severity level of 'warning'

Since each selection builds on the previous one, there exists a hierarchy between selections that must be maintained. The table below shows which notification combinations are valid. All other combinations will result in an HTTP 400 error

criticalNotificationcriticalNonServiceNotificationwarningNotification
FalseFalseFalse
TrueFalseFalse
TrueTrueFalse
TrueTrueTrue

healthNotification, powerResetNotification, and disconnectNotification do not build on each other and may be configured independently.

  • healthNotification enables the daily summary health report for the server.
  • powerResetNotification enables notifications for out-of-band power operations.
  • disconnectNotification enables notifications to be sent when the server remains in the disconnected or not monitored state after the configured number of hours. A null value in this field disables disconnect and not monitored notifications.

Initial values

All values are initially 'off' (false or null) with the result being that no notifications will be sent.

Security
Bearer
Path
idstringrequired

Unique user preferences object 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.

Bodyapplication/jsonrequired
criticalNotificationbooleanrequired
criticalNonServiceNotificationboolean
warningNotificationboolean
healthNotificationboolean
powerResetNotificationboolean
disconnectNotificationinteger or null
One of:
[ 1 .. 3 ]
integer[ 1 .. 3 ]
curl -i -X PUT \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/user-preferences/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "criticalNotification": true
  }'

Responses

Successful Response

Bodyapplication/json
idstring

Unique user preference identifier

Example: "36e00ac2-16fb-4dd5-8495-7e6df82fc15e"
typestringread-only

The type of the resource.

Value "compute-ops-mgmt/user-preference"
generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of preferences creation

updatedAtstring(date-time)

Time of the last preferences update

criticalNotificationboolean

Default notification choice for server critical notifications that are service-level events via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

criticalNonServiceNotificationboolean

Default notification choice for server critical notifications that are non-service-level events via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

warningNotificationboolean

Default notification choice for server warning-level events via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

healthNotificationboolean

Default notification choice for daily server health notification via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

powerResetNotificationboolean

Default notification choice for out-of-band power operations via email.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

disconnectNotificationinteger or null
One of:

Default notification choice for server disconnect or not monitored state via email. An integer value represents the number of hours a server has to remain in the disconnected or not monitored state to notify. A null value disables disconnect or not monitored notifications.
Override the default notification choice by updating the notification settings for a server (see /compute-ops-mgmt/v1/servers/{id}/notifications).

[ 1 .. 3 ]
integer[ 1 .. 3 ]
Response
application/json
{
  "id": "36e00ac2-16fb-4dd5-8495-7e6df82fc15e",
  "type": "compute-ops-mgmt/user-preference",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "criticalNotification": true,
  "criticalNonServiceNotification": true,
  "warningNotification": true,
  "healthNotification": true,
  "powerResetNotification": true,
  "disconnectNotification": 1
}

Subscribe users

Request

Purpose

This endpoint allows you to set the user preferences for other users in your workspace. This endpoint only allows subscribing, meaning configuration will only be applied for properties set to true or a valid integer in the case of disconnectNotification.

The user preference attributes to configure should be included in requestData. The lists in the recipients object will be used to subscribe each individual user. For example, if healthNotification is set to true and example@email.com is included in either the all list or the health list, the user example@email.com will end up with healthNotification set to true. If healthNotification is set to false, or example@email.com is not included in all or health, then healthNotification will be unaffected for example@email.com.

Request Data

For criticalNotification, criticalNonServiceNotification, and warningNotification, each selection increases the scope of the set of events that will be included. The order of event selections from minimum to maximum scope are:

  • criticalNotification - Events that are marked as service events. These events may have severity levels of 'warning' or 'critical'
  • criticalNonServiceNotification - Events that are not service events but have a severity level of 'critical'
  • warningNotification - Events that are not service events but have a severity level of 'warning'

Since each selection builds on the previous one, there exists a hierarchy between selections that must be maintained. The table below shows which notification combinations are valid. All other combinations will result in an HTTP 400 error

criticalNotificationcriticalNonServiceNotificationwarningNotification
FalseFalseFalse
TrueFalseFalse
TrueTrueFalse
TrueTrueTrue

healthNotification, powerResetNotification, and disconnectNotification do not build on each other and may be configured independently.

  • healthNotification enables the daily summary health report for the server.
  • powerResetNotification enables notifications for out-of-band power operations.
  • disconnectNotification enables notifications to be sent when the server remains in the disconnected or not monitored state after the configured number of hours.
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.

Bodyapplication/jsonrequired
recipientsobject(subscribeRecipients-v1)required
recipients.​allArray of strings or null
Default []
Example: ["example@email.com"]
Any of:

List of user emails. Each user included in this list will have notifications enabled for any value included in requestData that is true (or a valid integer in the case of disconnectNotification)

recipients.​criticalArray of strings or null
Default []
Example: ["example@email.com"]
Any of:

List of user emails. If a user is included in this list, the selections of criticalNotification, criticalNonServiceNotification, and warningNotification will be configured.

recipients.​healthArray of strings or null
Default []
Example: ["example@email.com"]
Any of:

List of user emails. If a user is included in this list, the selection of healthNotification will be configured.

recipients.​powerResetArray of strings or null
Default []
Example: ["example@email.com"]
Any of:

List of user emails. If a user is included in this list, the selection of powerResetNotification will be configured.

recipients.​disconnectArray of strings or null
Default []
Example: ["example@email.com"]
Any of:

List of user emails. If a user is included in this list, the selection of disconnectNotification will be configured.

requestDataobject(subscribeRequestData-v1)required
requestData.​criticalNotificationboolean
requestData.​criticalNonServiceNotificationboolean
requestData.​warningNotificationboolean
requestData.​healthNotificationboolean
requestData.​powerResetNotificationboolean
requestData.​disconnectNotificationinteger or null
One of:
[ 1 .. 3 ]
integer[ 1 .. 3 ]
curl -i -X POST \
  https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/user-preferences/subscribe \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "recipients": {},
    "requestData": {}
  }'

Responses

Successful Response

Bodyapplication/json
successCountinteger
Example: 0
errorCountinteger
Example: 0
successesArray of objects(userPreferencesResponse-v1)
errorsArray of objects(errorResponse)
Response
application/json
{
  "successCount": 0,
  "errorCount": 0,
  "successes": [
    { … }
  ],
  "errors": [
    { … }
  ]
}

Unsubscribe users

Request

Purpose

This endpoint allows you to unset the user preferences for other users in your workspace. Users will be unsubscribed based on the lists in the request body.

For example, a user included in the critical list will have their preferences for criticalNotification, criticalNonServiceNotification, and warningNotification set to false.

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.

Bodyapplication/jsonrequired
allArray of strings or null
Default []
Example: ["example@email.com"]
Any of:

List of user emails. Each user included in this list will have all default notification preferences disabled.

criticalArray of strings or null
Default []
Example: ["example@email.com"]
Any of:

List of user emails. Each user included in this list will have their criticalNotification, criticalNonServiceNotification, and warningNotification preferences set to false.

healthArray of strings or null
Default []
Example: ["example@email.com"]
Any of:

List of user emails. Each user included in this list will have their healthNotification preference set to false.

powerResetArray of strings or null
Default []
Example: ["example@email.com"]
Any of:

List of user emails. Each user included in this list will have their powerResetNotification preference set to false.

disconnectArray of strings or null
Default []
Example: ["example@email.com"]
Any of:

List of user emails. Each user included in this list will have their disconnectNotification preference set to null.

curl -i -X POST \
  https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/user-preferences/unsubscribe \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Successful Response

Bodyapplication/json
successCountinteger
Example: 0
errorCountinteger
Example: 0
successesArray of objects(userPreferencesResponse-v1)
errorsArray of objects(errorResponse)
Response
application/json
{
  "successCount": 0,
  "errorCount": 0,
  "successes": [
    { … }
  ],
  "errors": [
    { … }
  ]
}

user-preferences - v1beta1

Operations

utilization-over-time - v1beta1

Operations

utilization-by-entity - v1beta1

Operations

webhooks - v1beta1

Operations