Skip to content
/
Patch a server

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

Get a server

Request

Retrieve data for a Server specified by its id

Servers without a valid subscription will not return the following:

  • hardware.health
  • hardware.memoryMb
  • hardware.formFactor
  • hardware.bmc
  • hardware.platform
  • hardware.powerState
  • hardware.indicatorLed
  • firmwareInventory
  • softwareInventory
  • lastFirmwareUpdate
  • host
  • firmwareBundleUri
  • tags
  • originIp
  • biosFamily
  • storageInventory
  • processorVendor
  • autoIloFwupdate
  • serverGeneration
  • connectionType
  • oneview
Security
Bearer
Path
idstringrequired

Unique Server identifier

Query
selectstring

Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.

The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.

For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.

Examples:

Select only the id and name properties of the resource

select=id,name
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}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Server Data

Bodyapplication/json
idstring(productId+serialNumber)

Primary identifier for the server given by the system

namestring

Name given to resource

Example: "myServer"
typestring

Type of the resource

Value "compute-ops-mgmt/server"
resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB"
generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of server creation

updatedAtstring(date-time)

Time of the last server update

platformFamilynull or string
One of:

No Platform family

null
serverGenerationstring

Server Hardware Generation

Enum"GEN_8""GEN_9""GEN_10"
hardwareobject(hardware)

Server hardware details

stateobject(state)

Server connectivity state

firmwareInventoryArray of objects or null(firmwareInventoryItem-v1)

Firmware Inventory

softwareInventoryArray of objects or null(softwareInventoryItem-v1)

Software Inventory

firmwareBundleUristring or null
lastFirmwareUpdateobject or null

Details of the last firmware update

tagsobject or null

Extra identifiers a server

Example: {"location":"San Jose"}
processorVendorstring or null

Type and brand of processor

Example: "Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz"
biosFamilystring or null

Bios version

hostobject or null(host)

host details

autoIloFwUpdateboolean

To opt in for automatic iLO-only firmware update

oneviewobject or null

Details of the OneView managed server

lastFullInventoryCollectionAtstring or null
Any of:

Last complete inventory collection time

string(date-time)
lastFullInventoryCollectionPowerStatestring

Power state of the server when the complete inventory is collected

Response
application/json
{
  "id": "string",
  "name": "myServer",
  "type": "compute-ops-mgmt/server",
  "resourceUri": "/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "platformFamily": {},
  "serverGeneration": "GEN_8",
  "hardware": {
    "serialNumber": "string",
    "model": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "productId": "string",
    "powerState": "UNKNOWN",
    "indicatorLed": "UNKNOWN",
    "health": { … },
    "platform": "string",
    "formFactor": "string",
    "bmc": { … },
    "memoryMb": {},
    "manufacturer": "string"
  },
  "state": {
    "managed": true,
    "connected": true,
    "connectedModifiedAt": "2019-08-24T14:15:22Z",
    "subscriptionState": "REQUIRED",
    "subscriptionTier": "STANDARD",
    "subscriptionExpiresAt": "2019-08-24T14:15:22Z"
  },
  "firmwareInventory": [
    { … }
  ],
  "softwareInventory": [
    { … }
  ],
  "firmwareBundleUri": "string",
  "lastFirmwareUpdate": {
    "status": "OK",
    "attemptedAt": "2019-08-24T14:15:22Z",
    "firmwareInventoryUpdates": [ … ]
  },
  "tags": {
    "location": "San Jose"
  },
  "processorVendor": "Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz",
  "biosFamily": "string",
  "host": {
    "osName": "string",
    "osVersion": "string",
    "hostname": "string",
    "osDescription": "string",
    "osType": 0
  },
  "autoIloFwUpdate": true,
  "oneview": {
    "applianceUri": "string",
    "maintenanceMode": true,
    "name": "string",
    "state": "string"
  },
  "lastFullInventoryCollectionAt": "2019-08-24T14:15:22Z",
  "lastFullInventoryCollectionPowerState": "string"
}

Patch a server

Request

Partially update a Server specified by its id

Servers without a valid subscription will not return the following:

  • hardware.health
  • hardware.memoryMb
  • hardware.formFactor
  • hardware.bmc
  • hardware.platform
  • hardware.powerState
  • hardware.indicatorLed
  • firmwareInventory
  • softwareInventory
  • lastFirmwareUpdate
  • host
  • firmwareBundleUri
  • tags
  • originIp
  • biosFamily
  • storageInventory
  • processorVendor
  • autoIloFwupdate
  • serverGeneration
  • connectionType
  • oneview
Security
Bearer
Path
idstringrequired

Unique Server 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"
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
applianceobject

Associated secure gateway for the server.

autoIloFwUpdateboolean

To opt in for automatic iLO-only firmware update

Default true
hardwareobject or null
Any of:

Server hardware details

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

Responses

Successful Response

Bodyapplication/json
idstring(productId+serialNumber)

Primary identifier for the server given by the system

namestring

Name given to resource

Example: "myServer"
typestring

Type of the resource

Value "compute-ops-mgmt/server"
resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB"
generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of server creation

updatedAtstring(date-time)

Time of the last server update

platformFamilynull or string
One of:

No Platform family

null
serverGenerationstring

Server Hardware Generation

Enum"GEN_8""GEN_9""GEN_10"
hardwareobject(hardware)

Server hardware details

stateobject(state)

Server connectivity state

firmwareInventoryArray of objects or null(firmwareInventoryItem-v1)

Firmware Inventory

softwareInventoryArray of objects or null(softwareInventoryItem-v1)

Software Inventory

firmwareBundleUristring or null
lastFirmwareUpdateobject or null

Details of the last firmware update

tagsobject or null

Extra identifiers a server

Example: {"location":"San Jose"}
processorVendorstring or null

Type and brand of processor

Example: "Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz"
biosFamilystring or null

Bios version

hostobject or null(host)

host details

autoIloFwUpdateboolean

To opt in for automatic iLO-only firmware update

oneviewobject or null

Details of the OneView managed server

lastFullInventoryCollectionAtstring or null
Any of:

Last complete inventory collection time

string(date-time)
lastFullInventoryCollectionPowerStatestring

Power state of the server when the complete inventory is collected

Response
application/json
{
  "id": "string",
  "name": "myServer",
  "type": "compute-ops-mgmt/server",
  "resourceUri": "/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "platformFamily": {},
  "serverGeneration": "GEN_8",
  "hardware": {
    "serialNumber": "string",
    "model": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "productId": "string",
    "powerState": "UNKNOWN",
    "indicatorLed": "UNKNOWN",
    "health": { … },
    "platform": "string",
    "formFactor": "string",
    "bmc": { … },
    "memoryMb": {},
    "manufacturer": "string"
  },
  "state": {
    "managed": true,
    "connected": true,
    "connectedModifiedAt": "2019-08-24T14:15:22Z",
    "subscriptionState": "REQUIRED",
    "subscriptionTier": "STANDARD",
    "subscriptionExpiresAt": "2019-08-24T14:15:22Z"
  },
  "firmwareInventory": [
    { … }
  ],
  "softwareInventory": [
    { … }
  ],
  "firmwareBundleUri": "string",
  "lastFirmwareUpdate": {
    "status": "OK",
    "attemptedAt": "2019-08-24T14:15:22Z",
    "firmwareInventoryUpdates": [ … ]
  },
  "tags": {
    "location": "San Jose"
  },
  "processorVendor": "Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz",
  "biosFamily": "string",
  "host": {
    "osName": "string",
    "osVersion": "string",
    "hostname": "string",
    "osDescription": "string",
    "osType": 0
  },
  "autoIloFwUpdate": true,
  "oneview": {
    "applianceUri": "string",
    "maintenanceMode": true,
    "name": "string",
    "state": "string"
  },
  "lastFullInventoryCollectionAt": "2019-08-24T14:15:22Z",
  "lastFullInventoryCollectionPowerState": "string"
}

Delete a credential based server

Request

Delete a credential based server.

Security
Bearer
Path
idstring(uuid)required

Unique Server identifier

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

Responses

Successful Response

Response
No content

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