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

Create an approval policy

Request

Creates an approval policy

Security
Bearer
Bodyapplication/jsonrequired
namestring

Policy name

Example: "demo-policy"
descriptionstring

Policy description

Example: "Example policy"
policyDataobject

Data for the policy containing information about approvers and resources that are assigned to the policy.

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

Responses

Created

Headers
Locationstring(uri-reference)

The URI of the newly-created resource

Example: "/compute-ops-mgmt/v1beta2/approval-policies/4c102e14-87cd-4c00-8f5a-73073f85c9az"
Bodyapplication/json
idstring(uuid)required

Primary identifier for policy given by the system.

Example: "4c102e14-87cd-4c00-8f5a-73073f85c9az"
typestringrequired

Type of the resource

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

Time of policy entry creation

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

Time of last policy update

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

Monotonically increasing update counter

Example: 8450
namestring

Policy name

Example: "demo-policy"
resourceUristring(uri-reference)

URI to the policy itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta2/approval-policies/4c102e14-87cd-4c00-8f5a-73073f85c9az"
descriptionstring

Policy description

Example: "Example policy"
statestring

Approval policy state

Enum"ACTIVE""INACTIVE"
remarksstring

Comments on the policy

Example: "This is a demo policy"
policyDataobject

Information about approvers and other resources assigned to the policy

Response
application/json
{
  "name": "demo-policy",
  "type": "compute-ops-mgmt/approval-policy",
  "id": "4c102e14-87cd-4c00-8f5a-73073f85c9az",
  "resourceUri": "/compute-ops-mgmt/v1beta2/approval-policies/4c102e14-87cd-4c00-8f5a-73073f85c9az",
  "description": "Example policy",
  "state": "ACTIVE",
  "remarks": "This is a demo policy",
  "createdAt": "2025-03-01T10:50:33.736935+00:00",
  "updatedAt": "2025-03-01T11:05:00.554140+00:00",
  "generation": 8450,
  "policyData": {
    "approvables": [ … ],
    "resources": [ … ]
  }
}

List all approval policies

Request

Retrieves all active approval policies

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 policies can be filtered by:

  • createdAt
  • description
  • name
  • policyData/resources/id
  • policyData/resources/type
  • updatedAt

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

Examples:

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

filter=policyData/resources/id eq '24055ec0-eba3-483a-9fd5-644e4b7304ae'

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

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

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

filter=contains(description,'Demo policy')

Return approval policies 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 policies where a property does not equal a value not <property> eq <value>

filter=not contains(name, 'Test policy')

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

filter=policyData/resources/type eq 'compute-ops-mgmt/group' and policyData/resources/id eq '24055ec0-eba3-483a-9fd5-644e4b7304ae'
curl -i -X GET \
  https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/approval-policies \
  -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(approvalPolicyResponse-v1beta2)required
items[].​idstring(uuid)required

Primary identifier for policy given by the system.

Example: "4c102e14-87cd-4c00-8f5a-73073f85c9az"
items[].​typestringrequired

Type of the resource

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

Time of policy entry creation

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

Time of last policy update

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

Monotonically increasing update counter

Example: 8450
items[].​namestring

Policy name

Example: "demo-policy"
items[].​resourceUristring(uri-reference)

URI to the policy itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta2/approval-policies/4c102e14-87cd-4c00-8f5a-73073f85c9az"
items[].​descriptionstring

Policy description

Example: "Example policy"
items[].​statestring

Approval policy state

Enum"ACTIVE""INACTIVE"
items[].​remarksstring

Comments on the policy

Example: "This is a demo policy"
items[].​policyDataobject

Information about approvers and other resources assigned to the policy

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 policy by id

Request

Retrieves approval policy by id

Security
Bearer
Path
policy_idstring(uuid)required

Unique Policy Identifier

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

Responses

OK

Bodyapplication/json
idstring(uuid)required

Primary identifier for policy given by the system.

Example: "4c102e14-87cd-4c00-8f5a-73073f85c9az"
typestringrequired

Type of the resource

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

Time of policy entry creation

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

Time of last policy update

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

Monotonically increasing update counter

Example: 8450
namestring

Policy name

Example: "demo-policy"
resourceUristring(uri-reference)

URI to the policy itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta2/approval-policies/4c102e14-87cd-4c00-8f5a-73073f85c9az"
descriptionstring

Policy description

Example: "Example policy"
statestring

Approval policy state

Enum"ACTIVE""INACTIVE"
remarksstring

Comments on the policy

Example: "This is a demo policy"
policyDataobject

Information about approvers and other resources assigned to the policy

Response
application/json
{
  "name": "demo-policy",
  "type": "compute-ops-mgmt/approval-policy",
  "id": "4c102e14-87cd-4c00-8f5a-73073f85c9az",
  "resourceUri": "/compute-ops-mgmt/v1beta2/approval-policies/4c102e14-87cd-4c00-8f5a-73073f85c9az",
  "description": "Example policy",
  "state": "ACTIVE",
  "remarks": "This is a demo policy",
  "createdAt": "2025-03-01T10:50:33.736935+00:00",
  "updatedAt": "2025-03-01T11:05:00.554140+00:00",
  "generation": 8450,
  "policyData": {
    "approvables": [ … ],
    "resources": [ … ]
  }
}

Update the policy by id

Request

Updates an approval policy

Security
Bearer
Path
policy_idstring(uuid)required

Unique Policy 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
namestring

Policy name. This is an optional parameter that can be used to update the policy name.

Example: "demo-policy"
descriptionstring

Policy description. This is an optional parameter that can be used to update the policy description.

Example: "Example policy"
policyDataobject

Data for the policy containing information about approvers and resources that are assigned to the policy. User can modify the approvables and resources assigned to the policy. If the user wants to modify a policy assigned to a group resource, then the user must specify the resource ID of the group in the resources array. This is an optional parameter that can be used to update the policy data.

curl -i -X PATCH \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/approval-policies/{policy_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 policy given by the system.

Example: "4c102e14-87cd-4c00-8f5a-73073f85c9az"
typestringrequired

Type of the resource

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

Time of policy entry creation

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

Time of last policy update

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

Monotonically increasing update counter

Example: 8450
namestring

Policy name

Example: "demo-policy"
resourceUristring(uri-reference)

URI to the policy itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta2/approval-policies/4c102e14-87cd-4c00-8f5a-73073f85c9az"
descriptionstring

Policy description

Example: "Example policy"
statestring

Approval policy state

Enum"ACTIVE""INACTIVE"
remarksstring

Comments on the policy

Example: "This is a demo policy"
policyDataobject

Information about approvers and other resources assigned to the policy

Response
application/json
{
  "name": "demo-policy",
  "type": "compute-ops-mgmt/approval-policy",
  "id": "4c102e14-87cd-4c00-8f5a-73073f85c9az",
  "resourceUri": "/compute-ops-mgmt/v1beta2/approval-policies/4c102e14-87cd-4c00-8f5a-73073f85c9az",
  "description": "Example policy",
  "state": "ACTIVE",
  "remarks": "This is a demo policy",
  "createdAt": "2025-03-01T10:50:33.736935+00:00",
  "updatedAt": "2025-03-01T11:05:00.554140+00:00",
  "generation": 8450,
  "policyData": {
    "approvables": [ … ],
    "resources": [ … ]
  }
}

Delete an approval policy

Request

Deletes an approval policy

Security
Bearer
Path
policy_idstring(uuid)

Unique Policy Identifier

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

Responses

Successful Response

Response
No content

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