Skip to content
Internal API Catalog
/
HPE Compute Ops Management API
/
job-templates - v1beta2

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

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

List all job templates

Request

Note: This path operation is going to be deprecated and sunset!

  • Deprecated at: Fri, 28 Feb 2025 23:59:59 GMT
  • Sunset at : Tue, 1 Apr 2025 23:59:59 GMT
  • This resource is being removed. The information necessary to create jobs is documented in the Jobs Definition section. There you can find all available jobs and details on how to create each job.

Retrieve the list of job templates

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
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/v1beta2/job-templates \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of job templates

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0required

Zero-based resource offset

itemsArray of objectsrequired
items[].​idstring(uuid)required

Primary identifier for the job template given by the system

items[].​typestringrequired

Type of the resource

Value "compute-ops-mgmt/job-template"
items[].​generationinteger>= 0required

Monotonically increasing update counter

items[].​createdAtstring(date-time)required

Time of job template creation

items[].​updatedAtstring(date-time)required

Time of the last job template update

items[].​resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1beta2/job-templates/e94fea5a-115e-41b2-8ca2-406b4bf710df"
items[].​namestring
items[].​descriptionstring
items[].​schemaobject or null(JSON)

JSON Schema that describes the required data for an instance of this job

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 a job template

Request

Note: This path operation is going to be deprecated and sunset!

  • Deprecated at: Fri, 28 Feb 2025 23:59:59 GMT
  • Sunset at : Tue, 1 Apr 2025 23:59:59 GMT
  • This resource is being removed. The information necessary to create jobs is documented in the Jobs Definition section. There you can find all available jobs and details on how to create each job.

Retrieve details about the job template referenced by its id

Security
Bearer
Path
idstring(uuid)required

Unique Job template identifier

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/v1beta2/job-templates/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Job template data

Bodyapplication/json
idstring(uuid)required

Primary identifier for the job template given by the system

typestringrequired

Type of the resource

Value "compute-ops-mgmt/job-template"
generationinteger>= 0required

Monotonically increasing update counter

createdAtstring(date-time)required

Time of job template creation

updatedAtstring(date-time)required

Time of the last job template update

resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1beta2/job-templates/e94fea5a-115e-41b2-8ca2-406b4bf710df"
namestring
descriptionstring
schemaobject or null(JSON)

JSON Schema that describes the required data for an instance of this job

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "compute-ops-mgmt/job-template",
  "resourceUri": "/compute-ops-mgmt/v1beta2/job-templates/e94fea5a-115e-41b2-8ca2-406b4bf710df",
  "generation": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "schema": {
    "property1": "string",
    "property2": "string"
  }
}

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