Skip to content
/
Update event and health n...

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

Update event and health notifications for yourself

Request

Purpose

Configure your notification settings for the provided server.

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
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 or null
warningNotificationboolean or null
healthNotificationboolean or null
powerResetNotificationboolean or null
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/servers/{id}/notifications' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "criticalNotification": true
  }'

Responses

Successful Response

Bodyapplication/json
serverIdstring
criticalNotificationboolean
criticalNonServiceNotificationboolean or null
warningNotificationboolean or null
healthNotificationboolean or null
powerResetNotificationboolean or null
disconnectNotificationinteger or null
One of:
[ 1 .. 3 ]
integer[ 1 .. 3 ]
Response
application/json
{
  "serverId": "string",
  "criticalNotification": true,
  "criticalNonServiceNotification": true,
  "warningNotification": true,
  "healthNotification": true,
  "powerResetNotification": true,
  "disconnectNotification": 1
}

Update event and health notifications for others

Request

Purpose

Configure the notification settings for the provided server on behalf of other users in your workspace. The recipients field expects a list of emails; the users provided in this list will be configured based on the settings passed in the data field.

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
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
dataobject(notificationsRequest-v1)required
data.​criticalNotificationbooleanrequired
data.​criticalNonServiceNotificationboolean or null
data.​warningNotificationboolean or null
data.​healthNotificationboolean or null
data.​powerResetNotificationboolean or null
data.​disconnectNotificationinteger or null
One of:
[ 1 .. 3 ]
integer[ 1 .. 3 ]
recipientsArray of stringsrequired
curl -i -X POST \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/servers/{id}/notifications' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "criticalNotification": true
    },
    "recipients": [
      "string"
    ]
  }'

Responses

Successful Response

Bodyapplication/json
serverIdstring
criticalNotificationboolean
criticalNonServiceNotificationboolean or null
warningNotificationboolean or null
healthNotificationboolean or null
powerResetNotificationboolean or null
disconnectNotificationinteger or null
One of:
[ 1 .. 3 ]
integer[ 1 .. 3 ]
Response
application/json
{
  "serverId": "string",
  "criticalNotification": true,
  "criticalNonServiceNotification": true,
  "warningNotification": true,
  "healthNotification": true,
  "powerResetNotification": true,
  "disconnectNotification": 1
}

Get security parameters for a server

Request

Retrieve a list of security parameters for a server specified by the id of the server

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/v1/servers/{id}/security-parameters' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Server's security parameters Data

Bodyapplication/json
idstring
overallSecurityStatusstring

a enum describing the overall security status of the server

Enum"OK""RISK""IGNORE"
iloSecurityParamsArray of securityParameter-v1 (objects) or null
One of:
typestring

Type of the resource

Value "compute-ops-mgmt/server/security-parameter"
resourceUristring

URI to the security parameter resource itself (i.e. a self link).

Response
application/json
{
  "id": "string",
  "overallSecurityStatus": "OK",
  "iloSecurityParams": [
    { … }
  ],
  "type": "compute-ops-mgmt/server/security-parameter",
  "resourceUri": "string"
}

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