Retrieve data for all OneView server templates
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
Overview
License
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/
Query
Examples:
The order in which to return the resources in the collection.
The value of the sort query parameter is a comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).
The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direciton indicator is omitted the default direction is ascending.
Order resources ascending by name
Order resources ascending by name and then by descending by createdAt
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 charecters ! # $ & ' ( ) * + , / : ; = ? @ [ ] 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.
| CLASS | EXAMPLES |
|---|---|
| Types | integer, decimal, timestamp, string, boolean, null |
| Operations | eq, ne, gt, ge, lt, le, in |
| Logic | and, or, not |
Server templates can be filtered by:
- uri
- applianceId
Return resources where applianceId == d42c2b9b-b366-4e40-96a2-95e1138cf968
Return resources where uri contains a56e80bc-6ee4-4414-82e7-36dc7f79a62e
Headers
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/oneview-server-templates
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/oneview-server-templates
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/oneview-server-templates
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/oneview-server-templates
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/oneview-server-templates \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'OK
Description of the oneview server template
Example: "Server profile template"
Primary identifier for the appliance where OneView server template is created
Name of the appliance where OneView server template is created
Example: "devcat-dhcp-cent77-53"
URI of the server template in the OneView
Example: "/rest/server-profile-templates/a56e80bc-6ee4-4414-82e7-36dc7f79a62e"
Response
application/json
{ "offset": 0, "count": 1, "total": 12, "items": [ { … } ] }
Headers
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/oneview-server-templates/{id}
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/oneview-server-templates/{id}
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/oneview-server-templates/{id}
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/oneview-server-templates/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/oneview-server-templates/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Successful Response
Primary identifier for the appliance where OneView server template is created
Name of the appliance where OneView server template is created
Example: "devcat-dhcp-cent77-53"
URI of the server template in the OneView
Example: "/rest/server-profile-templates/a56e80bc-6ee4-4414-82e7-36dc7f79a62e"
Response
application/json
{ "createdAt": "2019-08-24T14:15:22Z", "description": "Server profile template", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "applianceId": "4a333222-8502-40ae-83cc-1e5b22f9d675", "applianceName": "devcat-dhcp-cent77-53", "name": "Server_profile_template", "uri": "/rest/server-profile-templates/a56e80bc-6ee4-4414-82e7-36dc7f79a62e", "attributes": {}, "status": "OK", "state": "string", "subscription": "string", "type": "compute-ops-mgmt/oneview-server-template", "updatedAt": "2019-08-24T14:15:22Z" }