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
Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_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

Get account details

Request

Retrieve account details by ID.

Security
Bearer
Path
idstring(uuid)required

Application Customer ID

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://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/accounts/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)read-only

Primary identifier of a particular account

Example: "0c3bed66f22211ee8c4e128da47d07ed"
accountTypestring(accountType)read-only

The account type of a particular application customer ID.

Enum"UNKNOWN""STANDALONE""MSP"
applicationCustomerIdstring(uuid)read-only

Application customer Id (same as id)

Example: "0c3bed66f22211ee8c4e128da47d07ed"
platformCustomerIdstring(uuid)read-only

Workspace identifier

Example: "567d21e6c08c11eeb7980ea2e11446eb"
mspApplicationCustomerIdstring or null(uuid)read-only

Application customer Id of a MSP user (if accountType is TENANT)

Example: "482788de186111ef8efeca97be113755"
mspPlatformCustomerIdstring or null(uuid)read-only

Workspace identifier of a MSP user (if accountType is TENANT)

Example: "482788de186111ef8efeca97be113755"
namestringread-only

Name of the account user

Example: "msp-test-com"
descriptionstringread-only

Description of the account

createdAtstring(date-time)read-only

Time of account creation.

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

Time of the last update to the account

Example: "2022-02-11T01:04:20.799937+00:00"
generationinteger>= 1read-only

Monotonically increasing update counter.

Example: 1
operationalModestringread-only

Indicates inventory ownership

Example: "DEFAULT"
accountInfoobject

Provides additional account information

Response
application/json
{ "id": "0c3bed66f22211ee8c4e128da47d07ed", "accountType": "UNKNOWN", "applicationCustomerId": "0c3bed66f22211ee8c4e128da47d07ed", "platformCustomerId": "567d21e6c08c11eeb7980ea2e11446eb", "mspApplicationCustomerId": "482788de186111ef8efeca97be113755", "mspPlatformCustomerId": "482788de186111ef8efeca97be113755", "name": "msp-test-com", "description": "string", "createdAt": "2022-02-11T01:04:20.799937+00:00", "updatedAt": "2022-02-11T01:04:20.799937+00:00", "generation": 1, "operationalMode": "DEFAULT", "accountInfo": { "country": "string", "createdAt": "string", "updatedAt": "string", "countryCode": "string" } }

Get list of tenant accounts

Request

Get list of tenant accounts for an MSP account

Security
Bearer
Path
idstringrequired

Application customer ID

Query
fields[]Array of arrays

Names of fields within the customers. Returns details of all customers for the application customer ID

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://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/accounts/{id}/tenants' \
  -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

totalinteger>= 0required

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

Example: 12
itemsArray of objectsrequired

Array of tenant account details in the page of the collection.

items[].​idstring(uuid)read-only

Primary identifier of a particular account

Example: "0c3bed66f22211ee8c4e128da47d07ed"
items[].​accountTypestring(accountType)read-only

The account type of a particular application customer ID.

Enum"UNKNOWN""STANDALONE""MSP"
items[].​applicationCustomerIdstring(uuid)read-only

Application customer Id (same as id)

Example: "0c3bed66f22211ee8c4e128da47d07ed"
items[].​platformCustomerIdstring(uuid)read-only

Workspace identifier

Example: "567d21e6c08c11eeb7980ea2e11446eb"
items[].​mspApplicationCustomerIdstring or null(uuid)read-only

Application customer Id of a MSP user (if accountType is TENANT)

Example: "482788de186111ef8efeca97be113755"
items[].​mspPlatformCustomerIdstring or null(uuid)read-only

Workspace identifier of a MSP user (if accountType is TENANT)

Example: "482788de186111ef8efeca97be113755"
items[].​namestringread-only

Name of the account user

Example: "msp-test-com"
items[].​descriptionstringread-only

Description of the account

items[].​createdAtstring(date-time)read-only

Time of account creation.

Example: "2022-02-11T01:04:20.799937+00:00"
items[].​updatedAtstring(date-time)read-only

Time of the last update to the account

Example: "2022-02-11T01:04:20.799937+00:00"
items[].​generationinteger>= 1read-only

Monotonically increasing update counter.

Example: 1
items[].​operationalModestringread-only

Indicates inventory ownership

Example: "DEFAULT"
items[].​accountInfoobject

Provides additional account information

Response
application/json
{ "offset": 0, "count": 1, "total": 12, "items": [ {} ] }

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

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