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

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

Retrieve all webhooks

Request

Purpose
Retrieve all available webhooks as a list.

More Information
For more information about this feature and how to use this API, go to the Event Webhook page to view a getting started guide.

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

Responses

List of webhooks

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0

Zero-based resource offset

totalinteger>= 0

Total number of items in the collection that match the filter query, if one was provided in the request

Example: 12
itemsArray of objects
Response
application/json
{
  "offset": 0,
  "count": 1,
  "total": 12,
  "items": [
    { … }
  ]
}

Create a webhook

Request

Creates a webhook.

Security
Bearer
Bodyapplication/jsonrequired
namestringrequired

The name associated with the webhook.

Example: "Server Webhook"
destinationstring(uri)required

User configurable https endpoint that is able to receive HTTP GET and POST requests.

Example: "https://example.com/webhookDestination"
statestring(webhookState)required

The state is managed by both Compute Ops Management and the user. If the handshake fails or deliveries are consistently failing this will be set to DISABLED by the system.

  • DISABLED - Set by the user to disable the endpoint without losing configuration. Additionally can be set by the System when the handshake fails or multiple 4xx/5xx responses are received. Events are not sent while in this state.
  • ENABLED - Shows that the user has enabled the endpoint. Can only be set to ENABLED by the user which will cause the webhook to re-initiate the verification handshake, even if it has succeeded in the past.
Enum"DISABLED""ENABLED"
Example: "ENABLED"
eventFilterstringrequired

The OData configuration of events to receive. For more information, expand the Event Webhook section and refer to the Filtering page.

Example: "type eq 'compute-ops/server'"
headersobjectrequired

The set of HTTP request headers that will be included in the GET and POST requests sent to the destination.

Compute Ops Management reserves any headers that begin with x-compute-ops-mgmt and will deny requests that attempt to use that value.

Example: {"exampleHeader":"hlCiqcLeZVPOtJNzdGqF"}
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/v1beta1/webhooks \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Server Webhook",
    "destination": "https://example.com/webhookDestination",
    "state": "DISABLED",
    "eventFilter": "type eq '\''compute-ops/server'\''",
    "headers": {
      "exampleHeader": "hlCiqcLeZVPOtJNzdGqF"
    }
  }'

Responses

Successful Response

Headers
Locationstring(uri-reference)

Location for the webhook that was created

Example: "/compute-ops-mgmt/v1beta1/webhooks/0e7f516c-0829-4135-83d6-09ce844ddd9d"
Bodyapplication/json
namestring

The name associated with the webhook.

Example: "Server Webhook"
idstring

Unique webhook identifier.

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

The type of the resource.

Value "compute-ops-mgmt/webhooks"
generationinteger

Monotonically increasing update counter.

Example: 1
createdAtstring(date-time)

Time of the webhook's creation in UTC.

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

Time of the webhook's last update in UTC.

Example: "2022-03-11T01:06:30.799489+00:00"
destinationstring(uri)

User configurable https endpoint that is able to receive HTTP GET and POST requests.

Example: "https://example.com/webhookDestination"
eventFilterstring

The OData configuration of events to receive. For more information, expand the Event Webhook section and refer to Filtering.

Example: "type eq 'compute-ops/server'"
statestring(webhookState)

The state is managed by both Compute Ops Management and the user. If the handshake fails or deliveries are consistently failing this will be set to DISABLED by the system.

  • DISABLED - Set by the user to disable the endpoint without losing configuration. Additionally can be set by the System when the handshake fails or multiple 4xx/5xx responses are received. Events are not sent while in this state.
  • ENABLED - Shows that the user has enabled the endpoint. Can only be set to ENABLED by the user which will cause the webhook to re-initiate the verification handshake, even if it has succeeded in the past.
Enum"DISABLED""ENABLED"
Example: "ENABLED"
statusstring(webhookStatus)

The current status of the webhook. This status is controlled by Compute Ops Management and is read-only for the user.

  • DISABLED - This is a result of the webhook's state being set to DISABLED by the user.
  • ACTIVE - Acknowledgment of the endpoint has succeeded, will send any events matching the webhook's eventFilter to the destination.
  • PENDING - Handshake process has begun but acknowledgement has not yet completed for the endpoint.
  • WARNING - Indicates an issue with webhook communications. Either there have been multiple recent failed deliveries or the endpoint has failed the handshake. Look at the webhook's statusReason for more information.
  • ERROR - Multiple 4xx or 5xx responses have been received from the endpoint. Reaching this status will disable the webhook.
Enum"DISABLED""ACTIVE""PENDING"
Example: "ACTIVE"
statusReasonstring

A description of the last status change.

Example: "Created"
resourceUristring(uri-reference)

The URI of this resource.

Example: "/compute-ops-mgmt/v1beta1/webhooks/b870f080-6448-48c5-b23a-d04f2d489174"
deliveriesUristring(uri-reference)

The URI for the deliveries associated with this resource.

Example: "/compute-ops-mgmt/v1beta1/webhooks/b870f080-6448-48c5-b23a-d04f2d489174/deliveries"
Response
application/json
{
  "name": "Server Webhook",
  "id": "36e00ac2-16fb-4dd5-8495-7e6df82fc15e",
  "type": "compute-ops-mgmt/webhooks",
  "generation": 1,
  "createdAt": "2022-02-11T01:04:20.799937+00:00",
  "updatedAt": "2022-03-11T01:06:30.799489+00:00",
  "destination": "https://example.com/webhookDestination",
  "eventFilter": "type eq 'compute-ops/server'",
  "state": "DISABLED",
  "status": "DISABLED",
  "statusReason": "Created",
  "resourceUri": "/compute-ops-mgmt/v1beta1/webhooks/b870f080-6448-48c5-b23a-d04f2d489174",
  "deliveriesUri": "/compute-ops-mgmt/v1beta1/webhooks/b870f080-6448-48c5-b23a-d04f2d489174/deliveries"
}

Get a webhook

Request

Retrieve a single webhook by webhook ID.

Security
Bearer
Path
webhook_idstring(uuid)required

Webhook ID

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/v1beta1/webhooks/{webhook_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
namestring

The name associated with the webhook.

Example: "Server Webhook"
idstring

Unique webhook identifier.

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

The type of the resource.

Value "compute-ops-mgmt/webhooks"
generationinteger

Monotonically increasing update counter.

Example: 1
createdAtstring(date-time)

Time of the webhook's creation in UTC.

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

Time of the webhook's last update in UTC.

Example: "2022-03-11T01:06:30.799489+00:00"
destinationstring(uri)

User configurable https endpoint that is able to receive HTTP GET and POST requests.

Example: "https://example.com/webhookDestination"
eventFilterstring

The OData configuration of events to receive. For more information, expand the Event Webhook section and refer to Filtering.

Example: "type eq 'compute-ops/server'"
statestring(webhookState)

The state is managed by both Compute Ops Management and the user. If the handshake fails or deliveries are consistently failing this will be set to DISABLED by the system.

  • DISABLED - Set by the user to disable the endpoint without losing configuration. Additionally can be set by the System when the handshake fails or multiple 4xx/5xx responses are received. Events are not sent while in this state.
  • ENABLED - Shows that the user has enabled the endpoint. Can only be set to ENABLED by the user which will cause the webhook to re-initiate the verification handshake, even if it has succeeded in the past.
Enum"DISABLED""ENABLED"
Example: "ENABLED"
statusstring(webhookStatus)

The current status of the webhook. This status is controlled by Compute Ops Management and is read-only for the user.

  • DISABLED - This is a result of the webhook's state being set to DISABLED by the user.
  • ACTIVE - Acknowledgment of the endpoint has succeeded, will send any events matching the webhook's eventFilter to the destination.
  • PENDING - Handshake process has begun but acknowledgement has not yet completed for the endpoint.
  • WARNING - Indicates an issue with webhook communications. Either there have been multiple recent failed deliveries or the endpoint has failed the handshake. Look at the webhook's statusReason for more information.
  • ERROR - Multiple 4xx or 5xx responses have been received from the endpoint. Reaching this status will disable the webhook.
Enum"DISABLED""ACTIVE""PENDING"
Example: "ACTIVE"
statusReasonstring

A description of the last status change.

Example: "Created"
resourceUristring(uri-reference)

The URI of this resource.

Example: "/compute-ops-mgmt/v1beta1/webhooks/b870f080-6448-48c5-b23a-d04f2d489174"
deliveriesUristring(uri-reference)

The URI for the deliveries associated with this resource.

Example: "/compute-ops-mgmt/v1beta1/webhooks/b870f080-6448-48c5-b23a-d04f2d489174/deliveries"
Response
application/json
{
  "name": "Server Webhook",
  "id": "36e00ac2-16fb-4dd5-8495-7e6df82fc15e",
  "type": "compute-ops-mgmt/webhooks",
  "generation": 1,
  "createdAt": "2022-02-11T01:04:20.799937+00:00",
  "updatedAt": "2022-03-11T01:06:30.799489+00:00",
  "destination": "https://example.com/webhookDestination",
  "eventFilter": "type eq 'compute-ops/server'",
  "state": "DISABLED",
  "status": "DISABLED",
  "statusReason": "Created",
  "resourceUri": "/compute-ops-mgmt/v1beta1/webhooks/b870f080-6448-48c5-b23a-d04f2d489174",
  "deliveriesUri": "/compute-ops-mgmt/v1beta1/webhooks/b870f080-6448-48c5-b23a-d04f2d489174/deliveries"
}

Patch a webhook

Request

Update a saved webhook.

Security
Bearer
Path
webhook_idstring(uuid)required

Webhook ID

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"
Bodyapplication/merge-patch+jsonrequired
namestring

The name associated with the webhook.

Example: "Server Webhook"
destinationstring(uri)

User configurable https endpoint that is able to receive HTTP GET and POST requests.

Example: "https://example.com/webhookDestination"
statestring(webhookState)

The state is managed by both Compute Ops Management and the user. If the handshake fails or deliveries are consistently failing this will be set to DISABLED by the system.

  • DISABLED - Set by the user to disable the endpoint without losing configuration. Additionally can be set by the System when the handshake fails or multiple 4xx/5xx responses are received. Events are not sent while in this state.
  • ENABLED - Shows that the user has enabled the endpoint. Can only be set to ENABLED by the user which will cause the webhook to re-initiate the verification handshake, even if it has succeeded in the past.
Enum"DISABLED""ENABLED"
Example: "ENABLED"
eventFilterstring

The OData configuration of events to receive. For more information, expand the Event Webhook section and refer to Filtering

Example: "type eq 'compute-ops/server'"
headersobject

The set of HTTP request headers that will be included in the GET and POST requests sent to the destination.

Compute Ops Management reserves any headers that begin with x-compute-ops-mgmt and will deny requests that attempt to use that value.

Example: {"exampleHeader":"hlCiqcLeZVPOtJNzdGqF"}
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/v1beta1/webhooks/{webhook_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Successful Response

Bodyapplication/json
namestring

The name associated with the webhook.

Example: "Server Webhook"
idstring

Unique webhook identifier.

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

The type of the resource.

Value "compute-ops-mgmt/webhooks"
generationinteger

Monotonically increasing update counter.

Example: 1
createdAtstring(date-time)

Time of the webhook's creation in UTC.

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

Time of the webhook's last update in UTC.

Example: "2022-03-11T01:06:30.799489+00:00"
destinationstring(uri)

User configurable https endpoint that is able to receive HTTP GET and POST requests.

Example: "https://example.com/webhookDestination"
eventFilterstring

The OData configuration of events to receive. For more information, expand the Event Webhook section and refer to Filtering.

Example: "type eq 'compute-ops/server'"
statestring(webhookState)

The state is managed by both Compute Ops Management and the user. If the handshake fails or deliveries are consistently failing this will be set to DISABLED by the system.

  • DISABLED - Set by the user to disable the endpoint without losing configuration. Additionally can be set by the System when the handshake fails or multiple 4xx/5xx responses are received. Events are not sent while in this state.
  • ENABLED - Shows that the user has enabled the endpoint. Can only be set to ENABLED by the user which will cause the webhook to re-initiate the verification handshake, even if it has succeeded in the past.
Enum"DISABLED""ENABLED"
Example: "ENABLED"
statusstring(webhookStatus)

The current status of the webhook. This status is controlled by Compute Ops Management and is read-only for the user.

  • DISABLED - This is a result of the webhook's state being set to DISABLED by the user.
  • ACTIVE - Acknowledgment of the endpoint has succeeded, will send any events matching the webhook's eventFilter to the destination.
  • PENDING - Handshake process has begun but acknowledgement has not yet completed for the endpoint.
  • WARNING - Indicates an issue with webhook communications. Either there have been multiple recent failed deliveries or the endpoint has failed the handshake. Look at the webhook's statusReason for more information.
  • ERROR - Multiple 4xx or 5xx responses have been received from the endpoint. Reaching this status will disable the webhook.
Enum"DISABLED""ACTIVE""PENDING"
Example: "ACTIVE"
statusReasonstring

A description of the last status change.

Example: "Created"
resourceUristring(uri-reference)

The URI of this resource.

Example: "/compute-ops-mgmt/v1beta1/webhooks/b870f080-6448-48c5-b23a-d04f2d489174"
deliveriesUristring(uri-reference)

The URI for the deliveries associated with this resource.

Example: "/compute-ops-mgmt/v1beta1/webhooks/b870f080-6448-48c5-b23a-d04f2d489174/deliveries"
Response
application/json
{
  "name": "Server Webhook",
  "id": "36e00ac2-16fb-4dd5-8495-7e6df82fc15e",
  "type": "compute-ops-mgmt/webhooks",
  "generation": 1,
  "createdAt": "2022-02-11T01:04:20.799937+00:00",
  "updatedAt": "2022-03-11T01:06:30.799489+00:00",
  "destination": "https://example.com/webhookDestination",
  "eventFilter": "type eq 'compute-ops/server'",
  "state": "DISABLED",
  "status": "DISABLED",
  "statusReason": "Created",
  "resourceUri": "/compute-ops-mgmt/v1beta1/webhooks/b870f080-6448-48c5-b23a-d04f2d489174",
  "deliveriesUri": "/compute-ops-mgmt/v1beta1/webhooks/b870f080-6448-48c5-b23a-d04f2d489174/deliveries"
}

Delete a saved webhook

Request

Deletes a saved webhook resource. This will also delete any deliveries associated with the deleted webhook.

Security
Bearer
Path
webhook_idstring(uuid)required

Webhook ID

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/v1beta1/webhooks/{webhook_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

No Content

Response
No content

Get details on all webhook deliveries.

Request

Retrieve details of the most recent deliveries that were attempted. Compute Ops Management stores the most recent ten deliveries and the five most recent failures, so this endpoint will return between 10 and 15 deliveries once deliveries have been attempted.

Security
Bearer
Path
webhook_idstring(uuid)required

Webhook ID

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/v1beta1/webhooks/{webhook_id}/deliveries' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0

Zero-based resource offset

totalinteger>= 0

Total number of items in the collection that match the filter query, if one was provided in the request

Example: 12
itemsArray of objects
Response
application/json
{
  "offset": 0,
  "count": 1,
  "total": 12,
  "items": [
    { … }
  ]
}

Get details for a specific delivery

Request

Retrieve details for a specific delivery using the ID.

Security
Bearer
Path
webhook_idstring(uuid)required

Webhook ID

delivery_idstring(uuid)required

Delivery ID

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/v1beta1/webhooks/{webhook_id}/deliveries/{delivery_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
webhookIdstring

The ID of the webhook that this delivery request belongs to.

Example: "75aa2a04-7349-11ee-b962-0242ac120002"
idstring

Unique identifier for the delivery.

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

URI of the delivery itself. Used to retrieve this specific delivery resource.

Example: "/compute-ops-mgmt/v1beta1/webhooks/96239cb5-6a1d-444c-8dfe-1e2ff05b4f05/deliveries/96239cb5-6a1d-444c-8dfe-1e2ff05b4f06"
typestringread-only

The type of the delivery resource.

Value "compute-ops-mgmt/webhook/delivery"
generationinteger

Monotonically increasing update counter.

Example: 1
createdAtstring(date-time)

Time of delivery resource creation in UTC.

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

Time of the last delivery resource update in UTC.

Example: "2022-03-11T01:06:30.799489+00:00"
eventTypestring

The Compute Ops Management resource type that changed which triggered an event being sent to the webhook's endpoint. Also contains the operation taken on that resource.

Example: "compute-ops/jobs:CREATE"
eventTimeinteger

Timestamp from the event message that was sent to the webhook's endpoint in UTC.

Example: "2023-11-30T15:06:01Z"
requestTimestampstring(date-time)

Timestamp of when the request to the webhook's endpoint was made in UTC.

Example: "2023-10-25T15:05:02Z"
responseTimestampstring(date-time)

Timestamp of when the response from webhook's endpoint was received in UTC.

Example: "2023-11-30T15:06:01Z"
destinationstring

The webhook's destination endpoint URL where the request was sent.

Example: "https://example.com/webhookDestination"
statusCodestring

HTTP status code from the webhook's registered endpoint.

Example: 200
dataobject

The data sent to the webhook within the POST request.

attemptinteger

The zero indexed count of POST attempts to the webhook's endpoint.

Example: 1
Response
application/json
{
  "webhookId": "75aa2a04-7349-11ee-b962-0242ac120002",
  "id": "36e00ac2-16fb-4dd5-8495-7e6df82fc15e",
  "resourceUri": "/compute-ops-mgmt/v1beta1/webhooks/96239cb5-6a1d-444c-8dfe-1e2ff05b4f05/deliveries/96239cb5-6a1d-444c-8dfe-1e2ff05b4f06",
  "type": "compute-ops-mgmt/webhook/delivery",
  "generation": 1,
  "createdAt": "2022-02-11T01:04:20.799937+00:00",
  "updatedAt": "2022-03-11T01:06:30.799489+00:00",
  "eventType": "compute-ops/jobs:CREATE",
  "eventTime": "2023-11-30T15:06:01Z",
  "requestTimestamp": "2023-10-25T15:05:02Z",
  "responseTimestamp": "2023-11-30T15:06:01Z",
  "destination": "https://example.com/webhookDestination",
  "statusCode": 200,
  "data": {},
  "attempt": 1
}