Skip to content
Internal API Catalog
/
HPE GreenLake for Private Cloud Business Edition System APIs
/
configuration-analysis-reports

HPE GreenLake for Private Cloud Business Edition System APIs (1.1.0)

HPE GreenLake for Private Cloud Business Edition System APIs

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/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/

https://us-west.api.greenlake.hpe.com/

https://eu-west.api.greenlake.hpe.com/

https://eu-central.api.greenlake.hpe.com/

https://ap-northeast.api.greenlake.hpe.com/

configuration-analysis-reports

APIs to trigger and fetch configuration analysis rules execution results for system

Operations

Returns a list of config analysis rules execution results.

Request

Returns the list of latest config analysis reports for all systems. It also accepts 'filter' query parameter where if 'systemId' is provided as 'filter', it returns the latest config analysis report for that system.

Security
bearer
Query
filterstring

Filter criteria - e.g. systemId eq c0930136-5317-5647-8d92-87ca3984c5f9

sortstring

The resource property to sort by followed by the response order. Response order can be either “asc” (ascending) or “desc” (descending)

Example: sort=totalFailed desc
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/private-cloud-business/v1beta1/configuration-analysis-reports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Config Analysis Report

Bodyapplication/json
itemsArray of objects(ConfigAnalyserResults)required
items[].​idstring(uuid)required

CA report id

items[].​typestringrequired

The type of resource.

items[].​createdAtstring

Timestamp when the config analysis rules execution result is created

items[].​createdBystring

Source type of config analysis rules execution

items[].​nextScheduledRunAtstring

Timestamp when the config analysis rules execution is next scheduled

items[].​resultsobject

Execution results data in json format

items[].​runStartedAtstring

Timestamp when the config analysis rules execution is started

items[].​runTypestring

run type of config analysis rules execution (Manual/Scheduled)

items[].​systemIdstring

UUID of System

items[].​systemNamestring

Name of System

items[].​totalFailedinteger

Number of failed rules in config analysis execution

items[].​totalPassedinteger

Number of rules passed in config analysis execution

items[].​totalWarninginteger

Number of warnings in config analysis execution

countintegerrequired
offsetnumber
totalinteger
Response
application/json
{
  "count": 0,
  "items": [
    { … }
  ],
  "offset": 0,
  "total": 0
}

Initiates config analysis rules execution.

Request

Initiates execution of config analysis rules execution for the System specified by 'systemId' in request body

Security
bearer
Bodyapplication/jsonrequired
systemIdstring(uuid)

An identifier for the System, usually a UUID.

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/private-cloud-business/v1beta1/configuration-analysis-reports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Software prechecks request is accepted.

Headers
Locationstring

Asynchronous operation URI. Use this to track the progress of the asynchronous operation.

Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Returns a config analysis rules execution results for the provided reportId.

Request

Returns config analysis rules execution report identified by 'reportId' parameter.

Security
bearer
Path
reportIdstring(uuid)required

Unique identifier of a Config Analysis Report.

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/private-cloud-business/v1beta1/configuration-analysis-reports/{reportId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Config Analysis Report

Bodyapplication/json
idstring(uuid)required

CA report id

typestringrequired

The type of resource.

createdAtstring

Timestamp when the config analysis rules execution result is created

createdBystring

Source type of config analysis rules execution

nextScheduledRunAtstring

Timestamp when the config analysis rules execution is next scheduled

resultsobject

Execution results data in json format

runStartedAtstring

Timestamp when the config analysis rules execution is started

runTypestring

run type of config analysis rules execution (Manual/Scheduled)

systemIdstring

UUID of System

systemNamestring

Name of System

totalFailedinteger

Number of failed rules in config analysis execution

totalPassedinteger

Number of rules passed in config analysis execution

totalWarninginteger

Number of warnings in config analysis execution

Response
application/json
{
  "createdAt": "string",
  "createdBy": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "nextScheduledRunAt": "string",
  "results": {},
  "runStartedAt": "string",
  "runType": "string",
  "systemId": "string",
  "systemName": "string",
  "totalFailed": 0,
  "totalPassed": 0,
  "totalWarning": 0,
  "type": "string"
}

systems

APIs for HPE GreenLake for Private Cloud Business Edition system operations.

Operations

vm-provisioning-policies

Virtual Machine Provisioning Policies operations

Operations

servers

Operations