Skip to content
Internal API Catalog
/
HPE Compute Ops Management API
/
ahs-files - v1beta1
/
Download parsed AHS file contents

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

activation-keys - v1beta1

Operations

activation-tokens - v1beta1

Operations

activities - v1beta2

Operations

ahs-files - v1beta1

Operations

Create AHS file upload

Request

A pre-signed URL can be created by issuing this POST call with correct payload for the task. The pre-signed URL allows the user to upload the selected file directly and securely to the Compute Ops Management data store provided by Amazon Web Services (AWS) Simple Storage Service (S3).

The pre-signed URL is valid for a maximum of 10 minutes. The user must upload the file within this time period, or the link will expire, and the upload will fail.

Note: Use the “parameters” list to create a pre-signed URL response to fill all the values in <>. It will form the upload command.

An example curl command to upload an AHS file is shown below:

curl -i -F key=AHS_DISCONNECTED/427275fcddef29436/c924e770-...-9219276d2a5f/upload_file_presigned_post.ahs 
-F x-amz-algorithm=AWS4-HMAC-SHA256 -F x-amz-credential=example_credential -F x-amz-date=20250213T000000Z 
-F x-amz-security-token=example_token 
-F policy=example_policy 
-F x-amz-signature=example_signature -F file=@P05172-B21+2M2D110304_FWUFailure.ahs 
'https://dev-hpecomputesupport-us-west-2.s3.amazonaws.com/'

Sample Success Response:

HTTP/1.1 200 Connection Established
Proxy-Agent: Zscaler/6.2
HTTP/1.1 100 Continue
HTTP/1.1 204 No Content
x-amz-id-2: LYH6S+m7DrtihxwwXGNm8l7DFsJNwlBS5ps0+vOuucVy2dzDd9OMBZLeund2vJvUUtBWiQETYn0=
x-amz-request-id: 3RNFF7X985Y2M0WV
Date: Mon, 16 Dec 2024 14:17:04 GMT
x-amz-server-side-encryption: aws:kms
x-amz-server-side-encryption-aws-kms-key-id: arn:aws:kms:us-west-2:647619633241:key/ebcad3a6-b6e2-4314-acf1-447f9f38f9bc
x-amz-server-side-encryption-bucket-key-enabled: true
ETag: "6e215e86cc62e52ad1ff5f184edd483d"
Location: https://dev-hpecomputesupport-us-west-2.s3.amazonaws.com/AHS_DISCONNECTED%2F427275fcddef11ebaeaea25b204e9436%2F72684583-59cf-4a81-b4c4-c4e586c8b0c1%2FP05172-B21+2M2D110304_FWUFailure.ahs
Server: AmazonS3
Security
Bearer
Bodyapplication/jsonrequired
fileNamestringrequired

Name of the AHS file which needs to be uploaded.

Example: "2024-08-26_19-20-42_P05172-B21+2M2D110304_FWUFailure.ahs"
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/ahs-files \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "fileName": "2024-08-26_19-20-42_P05172-B21+2M2D110304_FWUFailure.ahs"
  }'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)

Unique file identifier (File UUID) of the ahs-files resource given by the system.

Example: "017a9224-4d6e-4adb-9c78-321f95c7bb2c"
typestring

Type of the resource

Value "compute-ops-mgmt/ahs-file"
baseUrlstring

Bucket url where file is being uploaded.

Value "https://dev-hpecomputesupport-us-west-2.s3.amazonaws.com/"
parametersArray of objects

Key value pairs attributes of parameters list supplied for uploading the AHS file to AWS S3 bucket.

Example: [{"name":"key","value":"AHS_DISCONNECTED/427275fcddef29436/c924e770-...-9219276d2a5f/upload_file_presigned_post.ahs"},{"name":"x-amz-algorithm","value":"AWS4-HMAC-SHA256"},{"name":"x-amz-credential","value":"example_credential"},{"name":"x-amz-date","value":"20250213T000000Z"},{"name":"x-amz-security-token","value":"example_token"},{"name":"policy","value":"example_policy"},{"name":"x-amz-signature","value":"example_signature"}]
Response
application/json
{
  "id": "017a9224-4d6e-4adb-9c78-321f95c7bb2c",
  "type": "compute-ops-mgmt/ahs-file",
  "baseUrl": "https://dev-hpecomputesupport-us-west-2.s3.amazonaws.com/",
  "parameters": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

List of all AHS files

Request

Retrieves the status of the AHS file parsing request.

Security
Bearer
Query
offsetinteger>= 0

Zero-based resource offset to start the response from

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

The maximum number of records to return.

Example: limit=10
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/ahs-files \
  -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

Array of ahs file parsing status responses.

items[].​idstring(uuid)

Unique file identifier (File UUID) of the ahs-files resource given by the system.

Example: "017a9224-4d6e-4adb-9c78-321f95c7bb2c"
items[].​typestring

Type of the resource

Value "compute-ops-mgmt/ahs-file"
items[].​generationnumber

Monotonically increasing update counter.

Example: 1
items[].​createdAtstring(date-time)

Time of ahs-file creation.

Example: "2024-12-05 10:25:23.302032Z"
items[].​updatedAtstring(date-time)

Time of ahs-file updation.

Example: "2024-12-05 10:25:46.562205Z"
items[].​resourceUristring

Resource URI of the ahs-file.

Example: "/compute-ops-mgmt/v1beta1/ahs-files/017a9224-4d6e-4adb-9c78-321f95c7bb2c"
items[].​namestring

Name of the AHS file.

Example: "HPE_MXQ0xxxT3_20250108_Server.ahs"
items[].​baseUrlstring or null

AWS S3 bucket pre-signed URL generated while uploading the AHS file.

Example: null
items[].​parametersArray of objects

Key value pairs attributes of parameters list supplied for uploading the AHS file to AWS S3 bucket.

Example: "[]"
items[].​parsingStatusobject(parsingStatus)

file parsing request details

items[].​parsingResultsobject(parsingResults)

file parsing result details

items[].​hardwareobject(hardware)

Server hardware details

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 AHS file by id

Request

Retrieves the status of the AHS file parsing request by its id.

Security
Bearer
Path
idstring(uuid)required

Unique File Identifier (File UUID)

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/ahs-files/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)

Unique file identifier (File UUID) of the ahs-files resource given by the system.

Example: "017a9224-4d6e-4adb-9c78-321f95c7bb2c"
typestring

Type of the resource

Value "compute-ops-mgmt/ahs-file"
generationnumber

Monotonically increasing update counter.

Example: 1
createdAtstring(date-time)

Time of ahs-file creation.

Example: "2024-12-05 10:25:23.302032Z"
updatedAtstring(date-time)

Time of ahs-file updation.

Example: "2024-12-05 10:25:46.562205Z"
resourceUristring

Resource URI of the ahs-file.

Example: "/compute-ops-mgmt/v1beta1/ahs-files/017a9224-4d6e-4adb-9c78-321f95c7bb2c"
namestring

Name of the AHS file.

Example: "HPE_MXQ0xxxT3_20250108_Server.ahs"
baseUrlstring

AWS S3 bucket pre-signed URL generated while uploading the AHS file.

Example: null
parametersArray of objects

Key value pairs attributes of parameters list supplied for uploading the AHS file to AWS S3 bucket.

Example: []
parsingStatusobject(parsingStatus)

file parsing request details

parsingResultsobject(parsingResults)

file parsing result details

hardwareobject(hardware)

Server hardware details

Response
application/json
{
  "id": "017a9224-4d6e-4adb-9c78-321f95c7bb2c",
  "type": "compute-ops-mgmt/ahs-file",
  "generation": 1,
  "createdAt": "2024-12-05 10:25:23.302032Z",
  "updatedAt": "2024-12-05 10:25:46.562205Z",
  "resourceUri": "/compute-ops-mgmt/v1beta1/ahs-files/017a9224-4d6e-4adb-9c78-321f95c7bb2c",
  "name": "HPE_MXQ0xxxT3_20250108_Server.ahs",
  "baseUrl": null,
  "parameters": [],
  "parsingStatus": {
    "status": "ANALYSIS_SUCCESS",
    "statusModifiedAt": "2024-12-05 10:25:49.562196Z",
    "statusReason": "string",
    "errorCode": "string"
  },
  "parsingResults": {
    "components": { … }
  },
  "hardware": {
    "productId": "P2xx99-B21",
    "serialNumber": "MXQ0xxxT3"
  }
}

Update the parsing status of an AHS file

Request

This API triggers a patch request to update the parsing status of an AHS file. The patch request allows updating the existing parsing status of an AHS file from ANALYSIS_PENDING or ANALYSIS_IN_PROGRESS to ANALYSIS_FAILED.

Security
Bearer
Path
idstring(uuid)required

Unique File Identifier (File UUID)

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/jsonrequired
parsingStatusobject
Example: {"status":"ANALYSIS_FAILED"}
curl -i -X PATCH \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/ahs-files/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parsingStatus": {
      "status": "ANALYSIS_FAILED"
    }
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)

Unique file identifier (File UUID) of the ahs-files resource given by the system.

Example: "017a9224-4d6e-4adb-9c78-321f95c7bb2c"
typestring

Type of the resource

Value "compute-ops-mgmt/ahs-file"
generationnumber

Monotonically increasing update counter.

Example: 2
createdAtstring(date-time)

Time of ahs-file creation.

Example: "2024-12-05 10:25:23.302032Z"
updatedAtstring(date-time)

Time of ahs-file updation.

Example: "2024-12-05 10:25:46.562205Z"
resourceUristring

Resource URI of the ahs-file.

Example: "/compute-ops-mgmt/v1beta1/ahs-files/017a9224-4d6e-4adb-9c78-321f95c7bb2c"
namestring

Name of the AHS file.

Example: "HPE_MXQ0xxxT3_20250108_Server.ahs"
baseUrlstring or null

AWS S3 bucket pre-signed URL generated while uploading the AHS file.

Example: null
parametersArray of objects

Key value pairs attributes of parameters list supplied for uploading the AHS file to AWS S3 bucket.

Example: []
parsingStatusobject(parsingStatus)

file parsing request details

parsingResultsobject(parsingResults)

file parsing result details

Example: {}
hardwareobject(hardware)

Server hardware details

Response
application/json
{
  "id": "017a9224-4d6e-4adb-9c78-321f95c7bb2c",
  "type": "compute-ops-mgmt/ahs-file",
  "generation": 2,
  "createdAt": "2024-12-05 10:25:23.302032Z",
  "updatedAt": "2024-12-05 10:25:46.562205Z",
  "resourceUri": "/compute-ops-mgmt/v1beta1/ahs-files/017a9224-4d6e-4adb-9c78-321f95c7bb2c",
  "name": "HPE_MXQ0xxxT3_20250108_Server.ahs",
  "baseUrl": null,
  "parameters": [],
  "parsingStatus": {
    "status": "ANALYSIS_FAILED",
    "statusModifiedAt": "2024-12-05 10:25:49.562196Z",
    "statusReason": "due to intermittent issue. Retry the upload operation (error code: AHSE-101).",
    "errorCode": "AHSE-101"
  },
  "parsingResults": {},
  "hardware": {
    "productId": "",
    "serialNumber": ""
  }
}

Parse uploaded AHS file

Request

This API triggers a post request to parse an AHS file.

Security
Bearer
Path
idstring(uuid)required

Unique File Identifier (File UUID)

Bodyapplication/jsonrequired
componentsArray of strings(ahsfileComponent)non-emptyrequired

Name of component from AHS file which needs to be parsed.

  • INVENTORY - Server Inventory details
Items Value"INVENTORY"
Example: ["INVENTORY"]
curl -i -X POST \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/ahs-files/{id}/parse' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "components": [
      "INVENTORY"
    ]
  }'

Responses

OK

Response
No content

Download parsed AHS file contents

Request

This API triggers a get request to download parsed (CSV/JSON) AHS file contents.

Security
Bearer
Path
idstring(uuid)required

Unique File Identifier (File UUID)

Query
filenamestringrequired

File name to be downloaded

Example: filename=MXQ0xxxT3-20241205-1025-SERVER_INVENTORY.json
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/ahs-files/{id}/download?filename=MXQ0xxxT3-20241205-1025-SERVER_INVENTORY.json' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
object(ahsfilesDownloadResponse-v1beta1)

Response of parsed AHS file (CSV/JSON) contents.

Response
application/json
{
  "ProductName": "ProLiant ML350 Gen10",
  "SerialNumber": "MXQOxxxT3",
  "ServerID": "R4xx5A:MXQOxxxT3",
  "DateProcessed": "2025-04-02 12:47:25.868511+00:00 UTC",
  "PowerState": "Not Available",
  "Chassis": [
    { … }
  ],
  "ILO": [
    { … }
  ],
  "BIOS": [
    { … }
  ],
  "Processor": [
    { … },
    { … }
  ],
  "Device": [
    { … },
    { … }
  ],
  "Memory": [
    { … },
    { … }
  ],
  "Storage": [
    { … },
    { … }
  ],
  "Storage_NVME": [],
  "Network": [],
  "Power": [
    { … },
    { … }
  ],
  "Thermal-FanInformation": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "Firmware": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "Applications": [],
  "Drivers": [],
  "SDcards": [
    { … }
  ],
  "IntegratedManagementLogs": [],
  "ILOEventLogs": [],
  "SecurityEventLogs": [],
  "PowerSupplySummary": [
    { … }
  ],
  "Thermal-SensorTemperatureInformationInCelsius": [
    { … },
    { … },
    { … }
  ]
}

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