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

List all approval requests

Request

Retrieves all active approval requests

Security
Bearer
Query
offsetinteger>= 0

Zero-based resource offset to start the response from

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

The maximum number of records to return.

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

Approval requests can be filtered by:

  • approvableName
  • approvableResource/id
  • approvableResource/type
  • approvalState
  • createdAt
  • operation/id
  • operation/type
  • policy/id
  • updatedAt

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

Examples:

Return approval requests where a property equals a value. <property> eq <value>

filter=approvalState eq 'PENDING'

Return approval requests where a property is less than or equal to a value. <property> le <value>

filter=createdAt le 2025-03-01T17:44:30Z

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

filter=contains(approvableName,'Power on')

Return approval requests where a property is greater than a value, using url encoding. <property>%20gt%20%27<value>

filter=createdAt%20gt%202025-09-01T17%3A44%3A30Z

Return approval requests where a property does not equal a value not <property> eq <value>

filter=not operation/type eq 'compute-ops-mgmt/job'

Return approval requests where multiple properties can be matched with values <property> eq <value1> and <property> eq <value2>

filter=operation/id eq 'compute-ops-mgmt/job' and approvalableResource/type eq 'compute-ops-mgmt/server'
curl -i -X GET \
  https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/approval-requests \
  -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 objects(approvalRequestResponse-v1beta2)required
items[].​idstring(uuid)required

Primary identifier for request given by the system.

Example: "30fa7c27-64a0-4331-9462-73b0e004d4b9"
items[].​typestringrequired

Type of resource

Value "compute-ops-mgmt/approval-request"
items[].​createdAtstringrequired

Time of request entry creation

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

Time of last request update

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

Monotonically increasing update counter

Example: 8450
items[].​resourceUristring

URI to the request ifself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta2/approval-requests/30fa7c27-64a0-4331-9462-73b0e004d4b9"
items[].​policyobject

Information about the policy that request is associated with.

items[].​approvableNamestring

approvableName is used to identify the type of operation that requires approval. A case-sensitive field that must contain a value from the "Approvable Name" column below. The actions that are supported for approval follow:

Approvable NameDescription
Update firmwareUpdating the firmware of server or servers in a group.
Apply internal storage configurationApplying internal storage configuration to the server or servers in a group.
Install operating system imageInstalling the operating system image on the server or servers in a group.
Apply external storage configurationApplying external storage configuration to the server or servers in a group.
Power onPowering on the server.
Power offPowering off the server.
ResetResetting the server.
Cold bootCold booting the server.
Update iLO firmwareUpdating the iLO firmware on the server or servers in a group
Apply server settings (BIOS and iLO)Applying server settings (BIOS and iLO) to the server or servers in a group
Example: "Reset"
items[].​approvableResourceobject

The approvableResource is the identifier of the resource for which the request is created. This can refer to a server or group.

items[].​operationobject

This field indicates the action that is being performed on the resource. The action can be a job or a scheduled job. When a request is created, the operation field will be populated with the job or schedule details.

items[].​requesterobject

Indicates details on the requester of the approval request.

items[].​approvalStatestring

The state of the request.

Enum"APPROVED""CANCELLED""DECLINED"
Example: "APPROVED"
items[].​requestRemarksstring

Comments on the request

items[].​cancelledBystring

Reason for cancellation of the request

items[].​minApproversinteger

Minimum number of approvers required for the request to be approved

Example: 2
items[].​requestDataobject

Data for the approval request containing information about approvers ( they have the authority to approve or deny the requested action ) and the state of the request.

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

Get approval request by id

Request

Retrieves an approval request by id

Security
Bearer
Path
request_idstring(uuid)required

Unique Request Identifier

curl -i -X GET \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/approval-requests/{request_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)required

Primary identifier for request given by the system.

Example: "30fa7c27-64a0-4331-9462-73b0e004d4b9"
typestringrequired

Type of resource

Value "compute-ops-mgmt/approval-request"
createdAtstringrequired

Time of request entry creation

Example: "2025-03-01T10:50:33.736935+00:00"
updatedAtstringrequired

Time of last request update

Example: "2025-03-01T11:05:00.554140+00:00"
generationintegerrequired

Monotonically increasing update counter

Example: 8450
resourceUristring

URI to the request ifself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta2/approval-requests/30fa7c27-64a0-4331-9462-73b0e004d4b9"
policyobject

Information about the policy that request is associated with.

approvableNamestring

approvableName is used to identify the type of operation that requires approval. A case-sensitive field that must contain a value from the "Approvable Name" column below. The actions that are supported for approval follow:

Approvable NameDescription
Update firmwareUpdating the firmware of server or servers in a group.
Apply internal storage configurationApplying internal storage configuration to the server or servers in a group.
Install operating system imageInstalling the operating system image on the server or servers in a group.
Apply external storage configurationApplying external storage configuration to the server or servers in a group.
Power onPowering on the server.
Power offPowering off the server.
ResetResetting the server.
Cold bootCold booting the server.
Update iLO firmwareUpdating the iLO firmware on the server or servers in a group
Apply server settings (BIOS and iLO)Applying server settings (BIOS and iLO) to the server or servers in a group
Example: "Reset"
approvableResourceobject

The approvableResource is the identifier of the resource for which the request is created. This can refer to a server or group.

operationobject

This field indicates the action that is being performed on the resource. The action can be a job or a scheduled job. When a request is created, the operation field will be populated with the job or schedule details.

requesterobject

Indicates details on the requester of the approval request.

approvalStatestring(approvalState)
Enum"APPROVED""CANCELLED""DECLINED"
Example: "APPROVED"
requestRemarksstring

Comments on the request

cancelledBystring

Reason for cancellation of the request

minApproversinteger

Minimum number of approvers required for the request to be approved

Example: 2
requestDataobject

Data for the approval request containing information about approvers ( they have the authority to approve or deny the requested action ) and the state of the request.

Response
application/json
{
  "type": "compute-ops-mgmt/approval-request",
  "resourceUri": "/compute-ops-mgmt/v1beta2/approval-requests/30fa7c27-64a0-4331-9462-73b0e004d4b9",
  "id": "30fa7c27-64a0-4331-9462-73b0e004d4b9",
  "policy": {
    "id": "f196db43-b56b-441c-a60e-73ca3bb53c5d",
    "resourceUri": "/compute-ops-mgmt/v1beta2/approval-policies/f196db43-b56b-441c-a60e-73ca3bb53c5d",
    "type": "compute-ops-mgmt/approval-policy"
  },
  "approvableName": "Reset",
  "approvableResource": {
    "id": "215881-H98+8899215881198831",
    "resourceUri": "/compute-ops-mgmt/v1/servers/215881-H98+8899215881198831",
    "type": "compute-ops-mgmt/server"
  },
  "operation": {
    "id": "e0f1ac57-9fab-468f-afab-67d6746267ee",
    "resourceUri": "/compute-ops-mgmt/v1/jobs/e0f1ac57-9fab-468f-afab-67d6746267ee",
    "type": "compute-ops-mgmt/job"
  },
  "requester": {
    "firstName": "Test",
    "lastName": "User1",
    "email": "anybody@email.org"
  },
  "approvalState": "APPROVED",
  "createdAt": "2025-03-01T10:50:33.736935+00:00",
  "updatedAt": "2025-03-01T11:05:00.554140+00:00",
  "generation": 8450,
  "requestRemarks": "string",
  "cancelledBy": "string",
  "minApprovers": 2,
  "requestData": {
    "approvals": { … }
  }
}

Update the request by id

Request

Updates an approval request

Security
Bearer
Path
request_idstring(uuid)required

Unique Request Identifier

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
approvalStatestring

Set the state of the approval request. The request can be cancelled only if it is in the PENDING state and only the requester has the authority to cancel the request.

Value "CANCELLED"
requestRemarksstring

Comments when modifying the request. This is an optional parameter.

curl -i -X PATCH \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/approval-requests/{request_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

OK

Bodyapplication/json
idstring(uuid)required

Primary identifier for request given by the system.

Example: "30fa7c27-64a0-4331-9462-73b0e004d4b9"
typestringrequired

Type of resource

Value "compute-ops-mgmt/approval-request"
createdAtstringrequired

Time of request entry creation

Example: "2025-03-01T10:50:33.736935+00:00"
updatedAtstringrequired

Time of last request update

Example: "2025-03-01T11:05:00.554140+00:00"
generationintegerrequired

Monotonically increasing update counter

Example: 8450
resourceUristring

URI to the request ifself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta2/approval-requests/30fa7c27-64a0-4331-9462-73b0e004d4b9"
policyobject

Information about the policy that request is associated with.

approvableNamestring

approvableName is used to identify the type of operation that requires approval. A case-sensitive field that must contain a value from the "Approvable Name" column below. The actions that are supported for approval follow:

Approvable NameDescription
Update firmwareUpdating the firmware of server or servers in a group.
Apply internal storage configurationApplying internal storage configuration to the server or servers in a group.
Install operating system imageInstalling the operating system image on the server or servers in a group.
Apply external storage configurationApplying external storage configuration to the server or servers in a group.
Power onPowering on the server.
Power offPowering off the server.
ResetResetting the server.
Cold bootCold booting the server.
Update iLO firmwareUpdating the iLO firmware on the server or servers in a group
Apply server settings (BIOS and iLO)Applying server settings (BIOS and iLO) to the server or servers in a group
Example: "Reset"
approvableResourceobject

The approvableResource is the identifier of the resource for which the request is created. This can refer to a server or group.

operationobject

This field indicates the action that is being performed on the resource. The action can be a job or a scheduled job. When a request is created, the operation field will be populated with the job or schedule details.

requesterobject

Indicates details on the requester of the approval request.

approvalStatestring(approvalState)
Enum"APPROVED""CANCELLED""DECLINED"
Example: "APPROVED"
requestRemarksstring

Comments on the request

cancelledBystring

Reason for cancellation of the request

minApproversinteger

Minimum number of approvers required for the request to be approved

Example: 2
requestDataobject

Data for the approval request containing information about approvers ( they have the authority to approve or deny the requested action ) and the state of the request.

Response
application/json
{
  "type": "compute-ops-mgmt/approval-request",
  "resourceUri": "/compute-ops-mgmt/v1beta2/approval-requests/30fa7c27-64a0-4331-9462-73b0e004d4b9",
  "id": "30fa7c27-64a0-4331-9462-73b0e004d4b9",
  "policy": {
    "id": "f196db43-b56b-441c-a60e-73ca3bb53c5d",
    "resourceUri": "/compute-ops-mgmt/v1beta2/approval-policies/f196db43-b56b-441c-a60e-73ca3bb53c5d",
    "type": "compute-ops-mgmt/approval-policy"
  },
  "approvableName": "Reset",
  "approvableResource": {
    "id": "215881-H98+8899215881198831",
    "resourceUri": "/compute-ops-mgmt/v1/servers/215881-H98+8899215881198831",
    "type": "compute-ops-mgmt/server"
  },
  "operation": {
    "id": "e0f1ac57-9fab-468f-afab-67d6746267ee",
    "resourceUri": "/compute-ops-mgmt/v1/jobs/e0f1ac57-9fab-468f-afab-67d6746267ee",
    "type": "compute-ops-mgmt/job"
  },
  "requester": {
    "firstName": "Test",
    "lastName": "User1",
    "email": "anybody@email.org"
  },
  "approvalState": "APPROVED",
  "createdAt": "2025-03-01T10:50:33.736935+00:00",
  "updatedAt": "2025-03-01T11:05:00.554140+00:00",
  "generation": 8450,
  "requestRemarks": "string",
  "cancelledBy": "string",
  "minApprovers": 2,
  "requestData": {
    "approvals": { … }
  }
}

Approve request

Request

Approves or declines an approval request

Security
Bearer
Path
request_idstring(uuid)required

Unique Request Identifier

curl -i -X POST \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/approval-requests/{request_id}/approve' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
approvalStatestring(userApprovalState)
Enum"APPROVED""DECLINED"
remarksstring

Comments on the approval

Response
application/json
{
  "approvalState": "APPROVED",
  "remarks": "string"
}

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