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

List all server settings

Request

Get the list of a user's server-settings

Security
Bearer
Query
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

Server Settings can be filtered by:

  • category
  • description
  • name
  • platformFamily
  • settings

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

Examples:

Return server settings where a property equals a value. <property> eq <value>

filter=category eq 'FIRMWARE'

Return server settings where a nested property equals a value. <property>/<nestedProperty> eq <value>

filter=settings/DEFAULT/raidType eq 'RAID0'

Return server settings where a property does not equal a value not <property> eq <value>

filter=not platformFamily eq 'PROLIANT'

Return server settings with populated property. not <property> eq null

filter=not name eq null

Return server settings where property contains a value. contains(<property>, <value>)

filter=contains(category,'FIRM')

Return server settings where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)

filter=not name eq null and contains(category,'FIRM')

Return server settings where property is one of multiple values. <property>/<nestedProperty> in (<value>,<value>)

filter=settings/DEFAULT/raidType in ('RAID0','RAID1')
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://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta1/server-settings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0required

Zero-based resource offset

itemsArray of objectsrequired
items[].​idstring(uuid)required

Primary identifier for the server-settings given by the system

items[].​typestringrequired

Type of the resource

Value "compute-ops/server-setting"
items[].​namestring[ 1 .. 100 ] charactersrequired

The display name for the server-settings item

items[].​categorystringrequired

The category to which the settings data applies.

The available server settings categories are:

  • BIOS - BIOS configuration
  • EXTERNAL_STORAGE - storage configured in HPE GreenLake for Data Services Cloud Console (DSCC)
  • FIRMWARE - firmware configuration
  • ILO - iLO security configuration
  • OS - operating system
  • STORAGE - internal storage configuration
Enum"FIRMWARE""BIOS""STORAGE"
items[].​generationinteger>= 1required

Monotonically increasing update counter

items[].​createdAtstring(date-time)required

Time of server-settings creation

items[].​updatedAtstring(date-time)required

Time of the last server-settings update

items[].​descriptionstring or null<= 10000 characters

Server settings description

items[].​platformFamilystring

Server platform family to which this server setting applies. There are no restrictions for server settings and all supported server types are allowed. This optional attribute will be set to a default value of "ANY", to indicate that any server platform family can be in the group(s) which are associated with this server setting, regardless of the value passed in.

Default "ANY"
Enum"ANY""PROLIANT"
items[].​settingsobject

Configuration data corresponding to the specified category

items[].​resourceUristring(uri-reference)

URI to the server-settings itself (i.e. a self link)

Example: "/compute-ops/v1beta1/server-settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e"
totalinteger>= 0

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

Create server settings

Request

Create a server settings entry

Security
Bearer
Headers
Content-Typestringrequired

Content-Type header must designate 'application/json' in order for the request to be performed.

Value "application/json"
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
namestring[ 1 .. 100 ] charactersrequired

The display name for the server-settings item

categorystringrequired

The category to which the settings data applies.

The available server settings categories are:

CategoryPurpose
BIOSBIOS configuration
EXTERNAL_STORAGEHPE GreenLake for Data Services Cloud Console (DSCC) configuration
FIRMWAREfirmware configuration
ILOiLO security configuration
OSoperating system
STORAGEinternal storage configuration
Enum"BIOS""EXTERNAL_STORAGE""FIRMWARE"
descriptionstring or null<= 10000 characters
Example: "Firmware server setting"
platformFamilystring

Server platform family to which this server setting applies. There are no restrictions for server setting and all supported server types are allowed. This optional attribute will be set to a default value of "ANY", to indicate that any server platform family servers can be in the group(s) which are associated with this server setting, regardless of the value passed in.

Default "ANY"
Enum"ANY""PROLIANT"
settingsobject

Configuration data corresponding to the specified category.

ILO settings are HPE-defined only. Adding a new ILO setting is not supported.

The following table shows the available schema keys for each settings category:

CategoryKey(s)Details
BIOSDEFAULTserver BIOS configuration
EXTERNAL_STORAGEDEFAULTHPE GreenLake for DSCC storage configuration
FIRMWAREGEN10, GEN11, GEN12Firmware for the specified platform(s)
ILODEFAULTiLO security configuration
OSDEFAULTInstalled operating system
STORAGEDEFAULTInternal storage configuration
curl -i -X POST \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta1/server-settings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "category": "BIOS"
  }'

Responses

Successful Response

Headers
Locationstring(uri-reference)

Location for the server-settings item that was created

Example: "/compute-ops/v1beta1/server-settings/0e7f516c-0829-4135-83d6-09ce844ddd9d"
Bodyapplication/json
idstring(uuid)required

Primary identifier for the server-settings given by the system

typestringrequired

Type of the resource

Value "compute-ops/server-setting"
namestring[ 1 .. 100 ] charactersrequired

The display name for the server-settings item

categorystringrequired

The category to which the settings data applies.

The available server settings categories are:

  • BIOS - BIOS configuration
  • EXTERNAL_STORAGE - storage configured in HPE GreenLake for Data Services Cloud Console (DSCC)
  • FIRMWARE - firmware configuration
  • ILO - iLO security configuration
  • OS - operating system
  • STORAGE - internal storage configuration
Enum"FIRMWARE""BIOS""STORAGE"
generationinteger>= 1required

Monotonically increasing update counter

createdAtstring(date-time)required

Time of server-settings creation

updatedAtstring(date-time)required

Time of the last server-settings update

descriptionstring or null<= 10000 characters

Server settings description

platformFamilystring

Server platform family to which this server setting applies. There are no restrictions for server settings and all supported server types are allowed. This optional attribute will be set to a default value of "ANY", to indicate that any server platform family can be in the group(s) which are associated with this server setting, regardless of the value passed in.

Default "ANY"
Enum"ANY""PROLIANT"
settingsobject

Configuration data corresponding to the specified category

resourceUristring(uri-reference)

URI to the server-settings itself (i.e. a self link)

Example: "/compute-ops/v1beta1/server-settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e"
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "category": "FIRMWARE",
  "platformFamily": "ANY",
  "settings": {
    "GEN10": { … },
    "GEN11": { … },
    "GEN12": { … },
    "DEFAULT": { … }
  },
  "generation": 1,
  "resourceUri": "/compute-ops/v1beta1/server-settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e",
  "type": "compute-ops/server-setting",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get a server-settings item by ID

Request

Get a specific server-settings item by server-settings id.

Security
Bearer
Path
idstring(uuid)required
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://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta1/server-settings/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)required

Primary identifier for the server-settings given by the system

typestringrequired

Type of the resource

Value "compute-ops/server-setting"
namestring[ 1 .. 100 ] charactersrequired

The display name for the server-settings item

categorystringrequired

The category to which the settings data applies.

The available server settings categories are:

  • BIOS - BIOS configuration
  • EXTERNAL_STORAGE - storage configured in HPE GreenLake for Data Services Cloud Console (DSCC)
  • FIRMWARE - firmware configuration
  • ILO - iLO security configuration
  • OS - operating system
  • STORAGE - internal storage configuration
Enum"FIRMWARE""BIOS""STORAGE"
generationinteger>= 1required

Monotonically increasing update counter

createdAtstring(date-time)required

Time of server-settings creation

updatedAtstring(date-time)required

Time of the last server-settings update

descriptionstring or null<= 10000 characters

Server settings description

platformFamilystring

Server platform family to which this server setting applies. There are no restrictions for server settings and all supported server types are allowed. This optional attribute will be set to a default value of "ANY", to indicate that any server platform family can be in the group(s) which are associated with this server setting, regardless of the value passed in.

Default "ANY"
Enum"ANY""PROLIANT"
settingsobject

Configuration data corresponding to the specified category

resourceUristring(uri-reference)

URI to the server-settings itself (i.e. a self link)

Example: "/compute-ops/v1beta1/server-settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e"
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "category": "FIRMWARE",
  "platformFamily": "ANY",
  "settings": {
    "GEN10": { … },
    "GEN11": { … },
    "GEN12": { … },
    "DEFAULT": { … }
  },
  "generation": 1,
  "resourceUri": "/compute-ops/v1beta1/server-settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e",
  "type": "compute-ops/server-setting",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a server-settings item

Request

Delete a server-settings item.

Security
Bearer
Path
idstring(uuid)required
Query
forceboolean
Default false
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 DELETE \
  'https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta1/server-settings/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response
No content

Patch a server-settings item

Request

Partially update a server-settings item.

Security
Bearer
Path
idstring(uuid)required
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"
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/merge-patch+jsonrequired
descriptionstring or null<= 10000 characters
Example: "All prod server settings"
namestring[ 1 .. 100 ] characters
Example: "Production Server Settings"
settingsobject

Configuration data corresponding to the specified category.

ILO Security server settings are HPE-defined only. Adding a new ILO Security server setting is not supported.

curl -i -X PATCH \
  'https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta1/server-settings/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)required

Primary identifier for the server-settings given by the system

typestringrequired

Type of the resource

Value "compute-ops/server-setting"
namestring[ 1 .. 100 ] charactersrequired

The display name for the server-settings item

categorystringrequired

The category to which the settings data applies.

The available server settings categories are:

  • BIOS - BIOS configuration
  • EXTERNAL_STORAGE - storage configured in HPE GreenLake for Data Services Cloud Console (DSCC)
  • FIRMWARE - firmware configuration
  • ILO - iLO security configuration
  • OS - operating system
  • STORAGE - internal storage configuration
Enum"FIRMWARE""BIOS""STORAGE"
generationinteger>= 1required

Monotonically increasing update counter

createdAtstring(date-time)required

Time of server-settings creation

updatedAtstring(date-time)required

Time of the last server-settings update

descriptionstring or null<= 10000 characters

Server settings description

platformFamilystring

Server platform family to which this server setting applies. There are no restrictions for server settings and all supported server types are allowed. This optional attribute will be set to a default value of "ANY", to indicate that any server platform family can be in the group(s) which are associated with this server setting, regardless of the value passed in.

Default "ANY"
Enum"ANY""PROLIANT"
settingsobject

Configuration data corresponding to the specified category

resourceUristring(uri-reference)

URI to the server-settings itself (i.e. a self link)

Example: "/compute-ops/v1beta1/server-settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e"
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "category": "FIRMWARE",
  "platformFamily": "ANY",
  "settings": {
    "GEN10": { … },
    "GEN11": { … },
    "GEN12": { … },
    "DEFAULT": { … }
  },
  "generation": 1,
  "resourceUri": "/compute-ops/v1beta1/server-settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e",
  "type": "compute-ops/server-setting",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

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