Skip to content
Internal API Catalog
/
HPE Compute Ops Management API
/
jobs - v1beta3

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

jobs - v1

Operations

jobs - v1beta3

Operations

List all jobsDeprecated

Request

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

  • Deprecated at: Fri, 31 Jan 2025 23:59:59 GMT
  • Sunset at : Mon, 3 Mar 2025 23:59:59 GMT
  • Successor version: compute-ops-mgmt/v1/jobs

Retrieve the list of jobs

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/v1beta3/jobs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Headers
Deprecationstring(RFC-5322)required

The path operation will be deprecated as of this date and time.

Sunsetstring(RFC-5322)required

The path operation will be sunset and might become unresponsive anytime after this date and time.

Linkstring

Link to additional information about the deprecation and sunset of this path operation.

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 given by the system

Example: "2500759c-b7dd-4c68-ab7e-6b644bcf4b9c"
items[].​typestringrequired

Type of the resource

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

Monotonically increasing update counter

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

Time of job creation

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

Time of the last job update

items[].​parentJobIdstring or null(uuid)

The identifier of a job which triggered this job

Example: "284f3b7a-7a17-4f0a-9b40-a51bc887c7d0"
items[].​resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1beta3/jobs/2500759c-b7dd-4c68-ab7e-6b644bcf4b9c"
items[].​namestring

Name for the job

Example: "FirmwareUpdate.New"
items[].​deleteOnCompleteboolean

Automatically delete the job after it reaches the COMPLETE state.

Example: true
items[].​jobTemplateUristring

URI to the job template this job is using

Example: "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba"
items[].​associatedResourceUristring

URI to the resource this job is operating against

Example: "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686"
items[].​resourceobject(resource)

Reference to the resource this job is operating against

items[].​dataobject(data)

Data needed for this job

Example: {"state_reason_message":{"message_id":"FWI-100","message_args":["SPP 2022.12.00.00 (19 Dec 2022)"]}}
items[].​jobParamsobject(jobParams)

Parameters used to define this job

items[].​resultsobject(results)

Results from job execution

items[].​statestring(jobState)

The current state of a job, indicating whether a job is waiting, running, or terminal

Enum"PENDING""RUNNING""STALLED"
items[].​resultCodenull or string
One of:

No result code

null

No result code

items[].​statusstring

Status message about the job

items[].​statusDetailsobject or null

Additional information about the job's status

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": [
    { … }
  ]
}

Create a jobDeprecated

Request

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

  • Deprecated at: Fri, 31 Jan 2025 23:59:59 GMT
  • Sunset at : Mon, 3 Mar 2025 23:59:59 GMT
  • Successor version: compute-ops-mgmt/v1/jobs

Create a job for a given resource. A job is a multi-step task performed by Compute Ops Manager.

This table summarizes the jobs and their template IDs. For more information about each job template, expand the Job Definitions section and click on Overview to get started.

NameDescriptionResource TypeTemplate ID
Server Power OffPower off a servercompute-ops/serverd0c13b58-748c-461f-9a61-c0c5c71f1bb4
Server Power OnPower on a servercompute-ops/server0cbb2377-1834-488d-840c-d5bf788c34fb
Server RestartRestart a servercompute-ops/server30110551-cad6-4069-95b8-dbce9bbd8525
Server Cold BootCold boot a servercompute-ops/serveraacfb3e0-6575-4d4f-a711-1ee1ae768407
Server Firmware UpdateUpdate firmware on a servercompute-ops/serverfd54a96c-cabc-42e3-aee3-374a2d009dba
Server iLO Firmware UpdateUpdate iLO component firmware on a servercompute-ops/server94caa4ef-9ff8-4805-9e97-18a09e673b66
Server External Storage DetailsCollect external storage details for a servercompute-ops/server139cc26b-ac93-4da0-826c-220d15e3a422
Appliance Software UpdateUpdate OneView appliancecompute-ops/oneview-appliance1c4ac4be-8eeb-49f2-a86a-fd8c9182616c
Group Firmware UpdateUpdate firmware on servers in a groupcompute-ops/group91159b5e-9eeb-11ec-a9da-00155dc0a0c0
Group Firmware ComplianceCalculate firmware compliance of servers in a groupcompute-ops/group23b8ba2a-6c46-4223-b028-919382c7dcac
Group Appliance UpdateUpdate OneView appliances in a groupcompute-ops/groupf69f553a-5004-4a08-9283-5b60abd9eb4a
Group Internal Storage ConfigurationConfigures internal storage volume for servers in a groupcompute-ops/groupc708eb57-235d-4ea8-9e21-8ceea2438773
Group Apply Server SettingApply server setting on a groupcompute-ops/groupbeff07ce-f36d-4699-9ac3-f872dcd63133
Group Apply External Storage SettingsApply external storage settings on servers in a groupcompute-ops/group1262f08e-79eb-4e9f-91d2-6984da9d31cd
Group External Storage ComplianceCalculate external storage compliance of servers in a groupcompute-ops/group977139e0-f9d9-4940-9418-e0c321b5a458
Carbon Footprint ReportCreate carbon footprint reportcompute-ops/filterb0001d36-6490-48ac-93af-a87adfb997ed
Collect Server InventoryCollect complete or filtered server inventorycompute-ops/serverd6595f1b-84e6-4587-ade5-656e2a5ea20d
Collect Server Network ConnectivityCollect server adapter port to switch port mappingscompute-ops/serverb21ca9e2-8a1b-11ee-b9d1-0242ac120002
Group Operating System InstallationInstall operating system on servers in a groupcompute-ops/groupe2952628-2629-4088-93db-91742304ef0c
Group iLO Settings ComplianceCalculate ilo settings compliance of servers in a groupcompute-ops/groupa55c8b26-3c57-4044-a4ee-1d0e3c108286
Security
Bearer
Headers
Content-Typestringrequired

Content-Type header must designate 'application/json' in order for the request to be performed.

Value "application/json"
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.

Bodyapplication/jsonrequired

Job request

jobTemplateUristringrequired

Identifier of the job template for this job. Supports ID(aacfb3e0-6575-4d4f-a711-1ee1ae768407) in addition to URI(/compute-ops-mgmt/v1beta3/job-templates/aacfb3e0-6575-4d4f-a711-1ee1ae768407)

resourceUristringrequired

Reference to the resource to run this job on

Example: "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686"
dataobject

Data needed for this job (based on the job schema)

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/v1beta3/jobs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta3/job-templates/aacfb3e0-6575-4d4f-a711-1ee1ae768407",
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686"
  }'

Responses

Job data

Headers
Deprecationstring(RFC-5322)required

The path operation will be deprecated as of this date and time.

Sunsetstring(RFC-5322)required

The path operation will be sunset and might become unresponsive anytime after this date and time.

Linkstring

Link to additional information about the deprecation and sunset of this path operation.

Bodyapplication/json
idstring(uuid)required

Primary identifier for the job given by the system

Example: "2500759c-b7dd-4c68-ab7e-6b644bcf4b9c"
typestringrequired

Type of the resource

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

Monotonically increasing update counter

Example: 9
createdAtstring(date-time)required

Time of job creation

updatedAtstring(date-time)required

Time of the last job update

parentJobIdstring or null(uuid)

The identifier of a job which triggered this job

Example: "284f3b7a-7a17-4f0a-9b40-a51bc887c7d0"
resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1beta3/jobs/2500759c-b7dd-4c68-ab7e-6b644bcf4b9c"
namestring

Name for the job

Example: "FirmwareUpdate.New"
deleteOnCompleteboolean

Automatically delete the job after it reaches the COMPLETE state.

Example: true
jobTemplateUristring

URI to the job template this job is using

Example: "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba"
associatedResourceUristring

URI to the resource this job is operating against

Example: "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686"
resourceobject(resource)

Reference to the resource this job is operating against

dataobject(data)

Data needed for this job

Example: {"state_reason_message":{"message_id":"FWI-100","message_args":["SPP 2022.12.00.00 (19 Dec 2022)"]}}
jobParamsobject(jobParams)

Parameters used to define this job

resultsobject(results)

Results from job execution

statestring(jobState)

The current state of a job, indicating whether a job is waiting, running, or terminal

Enum"PENDING""RUNNING""STALLED"
resultCodenull or string
One of:

No result code

null

No result code

statusstring

Status message about the job

statusDetailsobject or null

Additional information about the job's status

Response
application/json
{
  "id": "2500759c-b7dd-4c68-ab7e-6b644bcf4b9c",
  "parentJobId": "284f3b7a-7a17-4f0a-9b40-a51bc887c7d0",
  "type": "compute-ops-mgmt/job",
  "resourceUri": "/compute-ops-mgmt/v1beta3/jobs/2500759c-b7dd-4c68-ab7e-6b644bcf4b9c",
  "name": "FirmwareUpdate.New",
  "generation": 9,
  "deleteOnComplete": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba",
  "associatedResourceUri": "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686",
  "resource": {
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686",
    "type": "servers"
  },
  "data": {
    "state_reason_message": { … }
  },
  "jobParams": {
    "property1": [],
    "property2": []
  },
  "results": {
    "property1": "string",
    "property2": "string"
  },
  "state": "PENDING",
  "resultCode": {},
  "status": "string",
  "statusDetails": {}
}

Get a job by IDDeprecated

Request

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

  • Deprecated at: Fri, 31 Jan 2025 23:59:59 GMT
  • Sunset at : Mon, 3 Mar 2025 23:59:59 GMT
  • Successor version: compute-ops-mgmt/v1/jobs/id

Retrieve details about the job referenced by its id

Security
Bearer
Path
idstring(uuid)required

Unique Job 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/v1beta3/jobs/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Job data

Headers
Deprecationstring(RFC-5322)required

The path operation will be deprecated as of this date and time.

Sunsetstring(RFC-5322)required

The path operation will be sunset and might become unresponsive anytime after this date and time.

Linkstring

Link to additional information about the deprecation and sunset of this path operation.

Bodyapplication/json
idstring(uuid)required

Primary identifier for the job given by the system

Example: "2500759c-b7dd-4c68-ab7e-6b644bcf4b9c"
typestringrequired

Type of the resource

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

Monotonically increasing update counter

Example: 9
createdAtstring(date-time)required

Time of job creation

updatedAtstring(date-time)required

Time of the last job update

parentJobIdstring or null(uuid)

The identifier of a job which triggered this job

Example: "284f3b7a-7a17-4f0a-9b40-a51bc887c7d0"
resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1beta3/jobs/2500759c-b7dd-4c68-ab7e-6b644bcf4b9c"
namestring

Name for the job

Example: "FirmwareUpdate.New"
deleteOnCompleteboolean

Automatically delete the job after it reaches the COMPLETE state.

Example: true
jobTemplateUristring

URI to the job template this job is using

Example: "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba"
associatedResourceUristring

URI to the resource this job is operating against

Example: "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686"
resourceobject(resource)

Reference to the resource this job is operating against

dataobject(data)

Data needed for this job

Example: {"state_reason_message":{"message_id":"FWI-100","message_args":["SPP 2022.12.00.00 (19 Dec 2022)"]}}
jobParamsobject(jobParams)

Parameters used to define this job

resultsobject(results)

Results from job execution

statestring(jobState)

The current state of a job, indicating whether a job is waiting, running, or terminal

Enum"PENDING""RUNNING""STALLED"
resultCodenull or string
One of:

No result code

null

No result code

statusstring

Status message about the job

statusDetailsobject or null

Additional information about the job's status

Response
application/json
{
  "id": "2500759c-b7dd-4c68-ab7e-6b644bcf4b9c",
  "parentJobId": "284f3b7a-7a17-4f0a-9b40-a51bc887c7d0",
  "type": "compute-ops-mgmt/job",
  "resourceUri": "/compute-ops-mgmt/v1beta3/jobs/2500759c-b7dd-4c68-ab7e-6b644bcf4b9c",
  "name": "FirmwareUpdate.New",
  "generation": 9,
  "deleteOnComplete": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba",
  "associatedResourceUri": "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686",
  "resource": {
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686",
    "type": "servers"
  },
  "data": {
    "state_reason_message": { … }
  },
  "jobParams": {
    "property1": [],
    "property2": []
  },
  "results": {
    "property1": "string",
    "property2": "string"
  },
  "state": "PENDING",
  "resultCode": {},
  "status": "string",
  "statusDetails": {}
}

Patch a job by IDDeprecated

Request

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

  • Deprecated at: Fri, 31 Jan 2025 23:59:59 GMT
  • Sunset at : Mon, 3 Mar 2025 23:59:59 GMT
  • Successor version: compute-ops-mgmt/v1/jobs/id

Updates an existing job

Security
Bearer
Path
idstring(uuid)required

Unique Job identifier

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"
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.

Bodyapplication/merge-patch+jsonrequired

Job update data

statestring

New state for the job (currently only Complete or Error is supported)

Enum"COMPLETE""ERROR"
inputobject

Additional input (optional) for the job

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/v1beta3/jobs/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Job data

Headers
Deprecationstring(RFC-5322)required

The path operation will be deprecated as of this date and time.

Sunsetstring(RFC-5322)required

The path operation will be sunset and might become unresponsive anytime after this date and time.

Linkstring

Link to additional information about the deprecation and sunset of this path operation.

Bodyapplication/json
idstring(uuid)required

Primary identifier for the job given by the system

Example: "2500759c-b7dd-4c68-ab7e-6b644bcf4b9c"
typestringrequired

Type of the resource

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

Monotonically increasing update counter

Example: 9
createdAtstring(date-time)required

Time of job creation

updatedAtstring(date-time)required

Time of the last job update

parentJobIdstring or null(uuid)

The identifier of a job which triggered this job

Example: "284f3b7a-7a17-4f0a-9b40-a51bc887c7d0"
resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1beta3/jobs/2500759c-b7dd-4c68-ab7e-6b644bcf4b9c"
namestring

Name for the job

Example: "FirmwareUpdate.New"
deleteOnCompleteboolean

Automatically delete the job after it reaches the COMPLETE state.

Example: true
jobTemplateUristring

URI to the job template this job is using

Example: "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba"
associatedResourceUristring

URI to the resource this job is operating against

Example: "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686"
resourceobject(resource)

Reference to the resource this job is operating against

dataobject(data)

Data needed for this job

Example: {"state_reason_message":{"message_id":"FWI-100","message_args":["SPP 2022.12.00.00 (19 Dec 2022)"]}}
jobParamsobject(jobParams)

Parameters used to define this job

resultsobject(results)

Results from job execution

statestring(jobState)

The current state of a job, indicating whether a job is waiting, running, or terminal

Enum"PENDING""RUNNING""STALLED"
resultCodenull or string
One of:

No result code

null

No result code

statusstring

Status message about the job

statusDetailsobject or null

Additional information about the job's status

Response
application/json
{
  "id": "2500759c-b7dd-4c68-ab7e-6b644bcf4b9c",
  "parentJobId": "284f3b7a-7a17-4f0a-9b40-a51bc887c7d0",
  "type": "compute-ops-mgmt/job",
  "resourceUri": "/compute-ops-mgmt/v1beta3/jobs/2500759c-b7dd-4c68-ab7e-6b644bcf4b9c",
  "name": "FirmwareUpdate.New",
  "generation": 9,
  "deleteOnComplete": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba",
  "associatedResourceUri": "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686",
  "resource": {
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686",
    "type": "servers"
  },
  "data": {
    "state_reason_message": { … }
  },
  "jobParams": {
    "property1": [],
    "property2": []
  },
  "results": {
    "property1": "string",
    "property2": "string"
  },
  "state": "PENDING",
  "resultCode": {},
  "status": "string",
  "statusDetails": {}
}

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