Skip to content
Internal API Catalog
/
HPE Compute Ops Management API
/
schedules - 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

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

List all schedules

Request

Retrieve a paginated collection of schedule resources.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security
Bearer
Query
offsetinteger>= 0

Zero-based resource offset to start the response from

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

The maximum number of records to return.

Default 50
Example: limit=10
filterstring

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 characters ! # $ & ' ( ) * + , / : ; = ? @ [ ] 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.

CLASSEXAMPLES
Typesinteger, decimal, timestamp, string, boolean, null
Operationseq, ne, gt, ge, lt, le, in
Logicand, or, not

Schedules can be filtered by:

  • createdAt
  • generation
  • historyUri
  • id
  • nextStartAt
  • operation/body
  • operation/headers
  • operation/method
  • operation/query
  • operation/timeoutInSec
  • operation/type
  • operation/uri
  • resourceUri
  • schedule/intervalInSec
  • schedule/startAt
  • type
  • updatedAt

The following examples are not an exhaustive list of all possible filtering options.

Examples:

Return schedules where a property equals a value. <property> eq <value>

filter=type eq 'compute-ops/schedule'

Return schedules where a nested property equals a value. <property>/<nestedProperty> eq <value>

filter=operation/method eq 'POST'

Return schedules where a property equals a value, using a url. <property>%20eq%20%27<value>

filter=id%20eq%20%2737f66ae4-20a1-48f1-b552-b515457639ca

Return schedules where a property does not equal a value not <property> eq <value>

filter=not type eq 'compute-ops/activities'

Return schedules with populated property. not <property> eq null

filter=not schedule eq null

Return schedules where property contains a value. contains(<property>, <value>)

filter=contains(createdAt,'2022')

Return schedules where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)

filter=not schedule eq null and contains(createdAt,'2022')

Return schedules where property is one of multiple values. <property>/<nestedProperty> in (<value>,<value>)

filter=operation/method in ('POST','GET')
sortstring

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.

Default "createdAt asc"
Examples:

Order resources ascending by name

sort=name asc

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc
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/schedules \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0required

Zero-based resource offset

totalinteger>= 0required

Total number of items in the collection that match the filter query, if one was provided in the request

Example: 12
itemsArray of objectsrequired

Array of schedule resources in the page of the collection.

items[].​idstring(uuid)read-onlyrequired

Primary identifier for the schedule resource given by the system.

Example: "37f66ae4-20a1-48f1-b552-b515457639ca"
items[].​typestringread-onlyrequired

The type of the resource.

Value "compute-ops-mgmt/schedule"
items[].​namestring[ 1 .. 100 ] charactersrequired

The display name of the schedule. Note that multiple schedules can have the same name, so schedules should likely always also be displayed with their start time.

items[].​scheduleobjectrequired

When to execute the scheduled operation.

items[].​schedule.​startAtstring(date-time)required

For a one-time schedule, the time the schedule should be executed. For a fixed interval schedule, the time the schedule should first be executed. The start must be within a year of the current time.

Example: "2022-02-14T04:35:00.000000+00:00"
items[].​schedule.​intervalstring or null(duration)

How long between successive executions for a recurring schedule, or null for a one-time schedule. PT15M < interval < P1Y

Default null
Example: "P7D"
items[].​operationobjectrequired

The action executed by the schedule.

items[].​operation.​typestring

The type of the operation executed by the schedule.

Example: "REST"
Discriminator
items[].​operation.​timeoutInSecnumber( 0 .. 60 ]

Timeout for the operation. If the operation takes longer, it will be aborted.

Default 20
items[].​operation.​methodstringread-only

HTTP method for the request.

Enum"DELETE""GET""HEAD"
Example: "POST"
items[].​operation.​uristring(uri-reference)<= 128 charactersread-only

Relative URI for the request.

Example: "/compute-ops-mgmt/v1beta3/jobs"
items[].​operation.​headersobject<= 32 properties

HTTP request headers for the request.

Example: {"Accept-Language":"en"}
items[].​operation.​queryobject<= 32 properties

Query parameters for the request.

Example: {"force":"true"}
items[].​operation.​bodyArray of null or booleans or objects or arrays or numbers or strings or null or boolean or object or number or string

HTTP request body JSON, for request methods that accept a body.

items[].​descriptionstring or null<= 10000 characters

A longer description of the schedule provided by the client.

Default null
items[].​purposestring or null<= 64 characters

A machine-readable category for the schedule.

Default null
items[].​associatedResourceUristring or null<= 128 characters

Another compute-ops resource the schedule is associated with. If the resource associated with a schedule is deleted, the schedule is also deleted.

Default null
Example: "/compute-ops/v1beta2/groups/cad23390-5209-43d1-b38d-bc96258b47e5"
items[].​generationinteger>= 1read-only

Monotonically increasing update counter.

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

Time of schedule resource creation.

Example: "2022-02-11T01:04:20.799937+00:00"
items[].​updatedAtstring(date-time)read-only

Time of the last update to the schedule resource.

Example: "2022-02-11T01:04:20.799937+00:00"
items[].​resourceUristring(uri-reference)read-only

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

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca"
items[].​historyUristring(uri-reference)read-only

URI of collection of history entries for the schedule.

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history"
items[].​nextStartAtstring or null(date-time)read-only

The time the operation is scheduled to execute next, or null if no future executions are scheduled.

Example: "2022-02-14T04:35:00.000000+00:00"
items[].​lastRunscheduleHistory-v1beta2 (object) or nullread-only

The most recent execution of the schedule, or null if the schedule has not yet executed.

One of:

The most recent execution of the schedule, or null if the schedule has not yet executed.

Response
application/json
{
  "offset": 0,
  "count": 1,
  "total": 12,
  "items": [
    { … }
  ]
}

Create a schedule

Request

Create a new schedule resource. This endpoint requires permission to call the uri endpoint specified in the operation of the request.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security
Bearer
Headers
Content-Typestringrequired

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

Value "application/json"
Idempotency-Keystring(uuid)

A unique value generated by the client which the server uses to recognize subsequent retries of the same request.

Example: 2c578105-adeb-4785-9113-8c577a0681fa
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
namestring[ 1 .. 100 ] characters

The display name of the schedule. Note that multiple schedules can have the same name, so schedules should likely always also be displayed with their start time.

descriptionstring or null<= 10000 characters

A longer description of the schedule provided by the client.

purposestring or null<= 64 characters

A machine-readable category for the schedule.

associatedResourceUristring or null<= 128 characters

Another compute-ops resource the schedule is associated with. If the resource associated with a schedule is deleted, the schedule is also deleted.

Example: "/compute-ops/v1beta2/groups/cad23390-5209-43d1-b38d-bc96258b47e5"
scheduleobject

When to execute the scheduled operation.

operationobject(scheduleOperationPost-v1beta2)
object(scheduleOperationPost-v1beta2)
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/v1beta2/schedules \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Successful Response

Headers
Locationstring(uri-reference)

The URI of the newly-created resource

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca"
Bodyapplication/json
idstring(uuid)read-onlyrequired

Primary identifier for the schedule resource given by the system.

Example: "37f66ae4-20a1-48f1-b552-b515457639ca"
typestringread-onlyrequired

The type of the resource.

Value "compute-ops-mgmt/schedule"
namestring[ 1 .. 100 ] charactersrequired

The display name of the schedule. Note that multiple schedules can have the same name, so schedules should likely always also be displayed with their start time.

scheduleobjectrequired

When to execute the scheduled operation.

schedule.​startAtstring(date-time)required

For a one-time schedule, the time the schedule should be executed. For a fixed interval schedule, the time the schedule should first be executed. The start must be within a year of the current time.

Example: "2022-02-14T04:35:00.000000+00:00"
schedule.​intervalstring or null(duration)

How long between successive executions for a recurring schedule, or null for a one-time schedule. PT15M < interval < P1Y

Default null
Example: "P7D"
operationobjectrequired

The action executed by the schedule.

operation.​typestring

The type of the operation executed by the schedule.

Example: "REST"
Discriminator
operation.​timeoutInSecnumber( 0 .. 60 ]

Timeout for the operation. If the operation takes longer, it will be aborted.

Default 20
operation.​methodstringread-only

HTTP method for the request.

Enum"DELETE""GET""HEAD"
Example: "POST"
operation.​uristring(uri-reference)<= 128 charactersread-only

Relative URI for the request.

Example: "/compute-ops-mgmt/v1beta3/jobs"
operation.​headersobject<= 32 properties

HTTP request headers for the request.

Example: {"Accept-Language":"en"}
operation.​queryobject<= 32 properties

Query parameters for the request.

Example: {"force":"true"}
operation.​bodyArray of null or booleans or objects or arrays or numbers or strings or null or boolean or object or number or string

HTTP request body JSON, for request methods that accept a body.

descriptionstring or null<= 10000 characters

A longer description of the schedule provided by the client.

Default null
purposestring or null<= 64 characters

A machine-readable category for the schedule.

Default null
associatedResourceUristring or null<= 128 characters

Another compute-ops resource the schedule is associated with. If the resource associated with a schedule is deleted, the schedule is also deleted.

Default null
Example: "/compute-ops/v1beta2/groups/cad23390-5209-43d1-b38d-bc96258b47e5"
generationinteger>= 1read-only

Monotonically increasing update counter.

Example: 1
createdAtstring(date-time)read-only

Time of schedule resource creation.

Example: "2022-02-11T01:04:20.799937+00:00"
updatedAtstring(date-time)read-only

Time of the last update to the schedule resource.

Example: "2022-02-11T01:04:20.799937+00:00"
resourceUristring(uri-reference)read-only

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

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca"
historyUristring(uri-reference)read-only

URI of collection of history entries for the schedule.

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history"
nextStartAtstring or null(date-time)read-only

The time the operation is scheduled to execute next, or null if no future executions are scheduled.

Example: "2022-02-14T04:35:00.000000+00:00"
lastRunscheduleHistory-v1beta2 (object) or nullread-only

The most recent execution of the schedule, or null if the schedule has not yet executed.

One of:

The most recent execution of the schedule, or null if the schedule has not yet executed.

Response
application/json
{
  "schedule": {
    "interval": "P7D",
    "startAt": "2022-02-14T04:35:00.000000+00:00"
  },
  "operation": {
    "headers": { … },
    "query": { … },
    "method": "POST",
    "uri": "/compute-ops-mgmt/v1beta3/jobs",
    "body": null,
    "type": "REST",
    "timeoutInSec": 20
  },
  "description": "string",
  "purpose": "string",
  "associatedResourceUri": "/compute-ops/v1beta2/groups/cad23390-5209-43d1-b38d-bc96258b47e5",
  "id": "37f66ae4-20a1-48f1-b552-b515457639ca",
  "type": "compute-ops-mgmt/schedule",
  "generation": 1,
  "createdAt": "2022-02-11T01:04:20.799937+00:00",
  "updatedAt": "2022-02-11T01:04:20.799937+00:00",
  "resourceUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca",
  "historyUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history",
  "name": "string",
  "nextStartAt": "2022-02-14T04:35:00.000000+00:00",
  "lastRun": {
    "operationType": "REST",
    "type": "compute-ops-mgmt/schedule/history",
    "id": "b7bac910-fec8-4907-ab78-f42b499d9041",
    "resourceUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history/b7bac910-fec8-4907-ab78-f42b499d9041",
    "scheduleId": "37f66ae4-20a1-48f1-b552-b515457639ca",
    "scheduleUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca",
    "startedAt": "2022-02-14T04:35:00.051732+00:00",
    "succeeded": true,
    "summary": "OK",
    "debugId": "13628947084908729803 14233605946314091555",
    "durationInSec": 0.035,
    "generation": 1,
    "createdAt": "2022-02-14T04:35:00.051732+00:00",
    "updatedAt": "2022-02-14T04:35:00.051732+00:00",
    "status": 200,
    "headers": { … },
    "body": null
  }
}

Get a schedule

Request

Retrieve a single schedule resource by ID.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security
Bearer
Path
idstring(uuid)required

Schedule ID

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

Responses

OK

Bodyapplication/json
idstring(uuid)read-onlyrequired

Primary identifier for the schedule resource given by the system.

Example: "37f66ae4-20a1-48f1-b552-b515457639ca"
typestringread-onlyrequired

The type of the resource.

Value "compute-ops-mgmt/schedule"
namestring[ 1 .. 100 ] charactersrequired

The display name of the schedule. Note that multiple schedules can have the same name, so schedules should likely always also be displayed with their start time.

scheduleobjectrequired

When to execute the scheduled operation.

schedule.​startAtstring(date-time)required

For a one-time schedule, the time the schedule should be executed. For a fixed interval schedule, the time the schedule should first be executed. The start must be within a year of the current time.

Example: "2022-02-14T04:35:00.000000+00:00"
schedule.​intervalstring or null(duration)

How long between successive executions for a recurring schedule, or null for a one-time schedule. PT15M < interval < P1Y

Default null
Example: "P7D"
operationobjectrequired

The action executed by the schedule.

operation.​typestring

The type of the operation executed by the schedule.

Example: "REST"
Discriminator
operation.​timeoutInSecnumber( 0 .. 60 ]

Timeout for the operation. If the operation takes longer, it will be aborted.

Default 20
operation.​methodstringread-only

HTTP method for the request.

Enum"DELETE""GET""HEAD"
Example: "POST"
operation.​uristring(uri-reference)<= 128 charactersread-only

Relative URI for the request.

Example: "/compute-ops-mgmt/v1beta3/jobs"
operation.​headersobject<= 32 properties

HTTP request headers for the request.

Example: {"Accept-Language":"en"}
operation.​queryobject<= 32 properties

Query parameters for the request.

Example: {"force":"true"}
operation.​bodyArray of null or booleans or objects or arrays or numbers or strings or null or boolean or object or number or string

HTTP request body JSON, for request methods that accept a body.

descriptionstring or null<= 10000 characters

A longer description of the schedule provided by the client.

Default null
purposestring or null<= 64 characters

A machine-readable category for the schedule.

Default null
associatedResourceUristring or null<= 128 characters

Another compute-ops resource the schedule is associated with. If the resource associated with a schedule is deleted, the schedule is also deleted.

Default null
Example: "/compute-ops/v1beta2/groups/cad23390-5209-43d1-b38d-bc96258b47e5"
generationinteger>= 1read-only

Monotonically increasing update counter.

Example: 1
createdAtstring(date-time)read-only

Time of schedule resource creation.

Example: "2022-02-11T01:04:20.799937+00:00"
updatedAtstring(date-time)read-only

Time of the last update to the schedule resource.

Example: "2022-02-11T01:04:20.799937+00:00"
resourceUristring(uri-reference)read-only

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

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca"
historyUristring(uri-reference)read-only

URI of collection of history entries for the schedule.

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history"
nextStartAtstring or null(date-time)read-only

The time the operation is scheduled to execute next, or null if no future executions are scheduled.

Example: "2022-02-14T04:35:00.000000+00:00"
lastRunscheduleHistory-v1beta2 (object) or nullread-only

The most recent execution of the schedule, or null if the schedule has not yet executed.

One of:

The most recent execution of the schedule, or null if the schedule has not yet executed.

Response
application/json
{
  "schedule": {
    "interval": "P7D",
    "startAt": "2022-02-14T04:35:00.000000+00:00"
  },
  "operation": {
    "headers": { … },
    "query": { … },
    "method": "POST",
    "uri": "/compute-ops-mgmt/v1beta3/jobs",
    "body": null,
    "type": "REST",
    "timeoutInSec": 20
  },
  "description": "string",
  "purpose": "string",
  "associatedResourceUri": "/compute-ops/v1beta2/groups/cad23390-5209-43d1-b38d-bc96258b47e5",
  "id": "37f66ae4-20a1-48f1-b552-b515457639ca",
  "type": "compute-ops-mgmt/schedule",
  "generation": 1,
  "createdAt": "2022-02-11T01:04:20.799937+00:00",
  "updatedAt": "2022-02-11T01:04:20.799937+00:00",
  "resourceUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca",
  "historyUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history",
  "name": "string",
  "nextStartAt": "2022-02-14T04:35:00.000000+00:00",
  "lastRun": {
    "operationType": "REST",
    "type": "compute-ops-mgmt/schedule/history",
    "id": "b7bac910-fec8-4907-ab78-f42b499d9041",
    "resourceUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history/b7bac910-fec8-4907-ab78-f42b499d9041",
    "scheduleId": "37f66ae4-20a1-48f1-b552-b515457639ca",
    "scheduleUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca",
    "startedAt": "2022-02-14T04:35:00.051732+00:00",
    "succeeded": true,
    "summary": "OK",
    "debugId": "13628947084908729803 14233605946314091555",
    "durationInSec": 0.035,
    "generation": 1,
    "createdAt": "2022-02-14T04:35:00.051732+00:00",
    "updatedAt": "2022-02-14T04:35:00.051732+00:00",
    "status": 200,
    "headers": { … },
    "body": null
  }
}

Delete a schedule

Request

Delete a schedule resource and its associated history.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security
Bearer
Path
idstring(uuid)required

Schedule ID

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 DELETE \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/schedules/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

No Content

Response
No content

Update a schedule

Request

A update a schedule resource, using the RFC 7396 (JSON Merge Patch) format.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security
Bearer
Path
idstring(uuid)required

Schedule ID

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"
If-Matchstring

Value which must match the "generation" property of the resource in order for the request to be performed.

Example: "3"
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
namestring[ 1 .. 100 ] characters

The display name of the schedule. Note that multiple schedules can have the same name, so schedules should likely always also be displayed with their start time.

descriptionstring or null<= 10000 characters

A longer description of the schedule provided by the client.

purposestring or null<= 64 characters

A machine-readable category for the schedule.

associatedResourceUristring or null<= 128 characters

Another compute-ops resource the schedule is associated with. If the resource associated with a schedule is deleted, the schedule is also deleted.

Example: "/compute-ops/v1beta2/groups/cad23390-5209-43d1-b38d-bc96258b47e5"
scheduleobject

When to execute the scheduled operation.

operationobject(scheduleOperationPatch-v1beta2)
object(scheduleOperationPatch-v1beta2)
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/v1beta2/schedules/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

OK

Bodyapplication/json
idstring(uuid)read-onlyrequired

Primary identifier for the schedule resource given by the system.

Example: "37f66ae4-20a1-48f1-b552-b515457639ca"
typestringread-onlyrequired

The type of the resource.

Value "compute-ops-mgmt/schedule"
namestring[ 1 .. 100 ] charactersrequired

The display name of the schedule. Note that multiple schedules can have the same name, so schedules should likely always also be displayed with their start time.

scheduleobjectrequired

When to execute the scheduled operation.

schedule.​startAtstring(date-time)required

For a one-time schedule, the time the schedule should be executed. For a fixed interval schedule, the time the schedule should first be executed. The start must be within a year of the current time.

Example: "2022-02-14T04:35:00.000000+00:00"
schedule.​intervalstring or null(duration)

How long between successive executions for a recurring schedule, or null for a one-time schedule. PT15M < interval < P1Y

Default null
Example: "P7D"
operationobjectrequired

The action executed by the schedule.

operation.​typestring

The type of the operation executed by the schedule.

Example: "REST"
Discriminator
operation.​timeoutInSecnumber( 0 .. 60 ]

Timeout for the operation. If the operation takes longer, it will be aborted.

Default 20
operation.​methodstringread-only

HTTP method for the request.

Enum"DELETE""GET""HEAD"
Example: "POST"
operation.​uristring(uri-reference)<= 128 charactersread-only

Relative URI for the request.

Example: "/compute-ops-mgmt/v1beta3/jobs"
operation.​headersobject<= 32 properties

HTTP request headers for the request.

Example: {"Accept-Language":"en"}
operation.​queryobject<= 32 properties

Query parameters for the request.

Example: {"force":"true"}
operation.​bodyArray of null or booleans or objects or arrays or numbers or strings or null or boolean or object or number or string

HTTP request body JSON, for request methods that accept a body.

descriptionstring or null<= 10000 characters

A longer description of the schedule provided by the client.

Default null
purposestring or null<= 64 characters

A machine-readable category for the schedule.

Default null
associatedResourceUristring or null<= 128 characters

Another compute-ops resource the schedule is associated with. If the resource associated with a schedule is deleted, the schedule is also deleted.

Default null
Example: "/compute-ops/v1beta2/groups/cad23390-5209-43d1-b38d-bc96258b47e5"
generationinteger>= 1read-only

Monotonically increasing update counter.

Example: 1
createdAtstring(date-time)read-only

Time of schedule resource creation.

Example: "2022-02-11T01:04:20.799937+00:00"
updatedAtstring(date-time)read-only

Time of the last update to the schedule resource.

Example: "2022-02-11T01:04:20.799937+00:00"
resourceUristring(uri-reference)read-only

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

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca"
historyUristring(uri-reference)read-only

URI of collection of history entries for the schedule.

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history"
nextStartAtstring or null(date-time)read-only

The time the operation is scheduled to execute next, or null if no future executions are scheduled.

Example: "2022-02-14T04:35:00.000000+00:00"
lastRunscheduleHistory-v1beta2 (object) or nullread-only

The most recent execution of the schedule, or null if the schedule has not yet executed.

One of:

The most recent execution of the schedule, or null if the schedule has not yet executed.

Response
application/json
{
  "schedule": {
    "interval": "P7D",
    "startAt": "2022-02-14T04:35:00.000000+00:00"
  },
  "operation": {
    "headers": { … },
    "query": { … },
    "method": "POST",
    "uri": "/compute-ops-mgmt/v1beta3/jobs",
    "body": null,
    "type": "REST",
    "timeoutInSec": 20
  },
  "description": "string",
  "purpose": "string",
  "associatedResourceUri": "/compute-ops/v1beta2/groups/cad23390-5209-43d1-b38d-bc96258b47e5",
  "id": "37f66ae4-20a1-48f1-b552-b515457639ca",
  "type": "compute-ops-mgmt/schedule",
  "generation": 1,
  "createdAt": "2022-02-11T01:04:20.799937+00:00",
  "updatedAt": "2022-02-11T01:04:20.799937+00:00",
  "resourceUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca",
  "historyUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history",
  "name": "string",
  "nextStartAt": "2022-02-14T04:35:00.000000+00:00",
  "lastRun": {
    "operationType": "REST",
    "type": "compute-ops-mgmt/schedule/history",
    "id": "b7bac910-fec8-4907-ab78-f42b499d9041",
    "resourceUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history/b7bac910-fec8-4907-ab78-f42b499d9041",
    "scheduleId": "37f66ae4-20a1-48f1-b552-b515457639ca",
    "scheduleUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca",
    "startedAt": "2022-02-14T04:35:00.051732+00:00",
    "succeeded": true,
    "summary": "OK",
    "debugId": "13628947084908729803 14233605946314091555",
    "durationInSec": 0.035,
    "generation": 1,
    "createdAt": "2022-02-14T04:35:00.051732+00:00",
    "updatedAt": "2022-02-14T04:35:00.051732+00:00",
    "status": 200,
    "headers": { … },
    "body": null
  }
}

List all history of a schedule

Request

Retrieve a paginated collection of history entries for a schedule resource.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security
Bearer
Path
idstring(uuid)required

Schedule ID

Query
offsetinteger>= 0

Zero-based resource offset to start the response from

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

The maximum number of records to return.

Default 50
Example: limit=10
filterstring

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 characters ! # $ & ' ( ) * + , / : ; = ? @ [ ] 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.

CLASSEXAMPLES
Typesinteger, decimal, timestamp, string, boolean, null
Operationseq, ne, gt, ge, lt, le, in
Logicand, or, not

Schedules can be filtered by:

  • createdAt
  • generation
  • historyUri
  • id
  • nextStartAt
  • operation/body
  • operation/headers
  • operation/method
  • operation/query
  • operation/timeoutInSec
  • operation/type
  • operation/uri
  • resourceUri
  • schedule/intervalInSec
  • schedule/startAt
  • type
  • updatedAt

The following examples are not an exhaustive list of all possible filtering options.

Examples:

Return schedules where a property equals a value. <property> eq <value>

filter=type eq 'compute-ops/schedule'

Return schedules where a nested property equals a value. <property>/<nestedProperty> eq <value>

filter=operation/method eq 'POST'

Return schedules where a property equals a value, using a url. <property>%20eq%20%27<value>

filter=id%20eq%20%2737f66ae4-20a1-48f1-b552-b515457639ca

Return schedules where a property does not equal a value not <property> eq <value>

filter=not type eq 'compute-ops/activities'

Return schedules with populated property. not <property> eq null

filter=not schedule eq null

Return schedules where property contains a value. contains(<property>, <value>)

filter=contains(createdAt,'2022')

Return schedules where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)

filter=not schedule eq null and contains(createdAt,'2022')

Return schedules where property is one of multiple values. <property>/<nestedProperty> in (<value>,<value>)

filter=operation/method in ('POST','GET')
sortstring

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.

Default "startedAt desc"
Examples:

Order resources ascending by name

sort=name asc

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc
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/schedules/{id}/history' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0required

Zero-based resource offset

totalinteger>= 0required

Total number of items in the collection that match the filter query, if one was provided in the request

Example: 12
itemsArray of objectsrequired

Array of history entires in the page of the collection.

items[].​statusinteger or nullrequired

HTTP status code of the response, or null if there was an error without a status code.

Example: 200
items[].​headersobjectrequired

The HTTP response headers.

Example: {"Location":"/api/compute/v1/jobs/01b7269f-d2c4-4da8-a66a-4675ef5787d1"}
items[].​headers.​property name*stringadditional property
items[].​operationTypestringrequired

The type of operation that was executed.

Example: "REST"
Discriminator
items[].​typestringrequired

The type of the resource.

Value "compute-ops-mgmt/schedule/history"
items[].​idstring(uuid)required

A unique identifier for the execution of the schedule.

Example: "b7bac910-fec8-4907-ab78-f42b499d9041"
items[].​resourceUristring(uri-reference)required

The URI of the history resource.

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history/b7bac910-fec8-4907-ab78-f42b499d9041"
items[].​scheduleIdstring(uuid)required

The ID of the schedule resource that owns the history resource.

Example: "37f66ae4-20a1-48f1-b552-b515457639ca"
items[].​scheduleUristring(uri-reference)required

The URI of the schedule resource that owns the history resource.

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca"
items[].​startedAtstring(date-time)required

The time the execution of the schedule started.

Example: "2022-02-14T04:35:00.051732+00:00"
items[].​succeededbooleanrequired

true if the operation was successful, e.g. if the REST request received a 2xx response.

Example: true
items[].​summarystringrequired

A Human readable summary, e.g. for a REST request, the HTTP status line or short connection error.

Example: "OK"
items[].​debugIdstringrequired

A unique identifier for the execution of the schedule, to be used to help with troubleshooting.

Example: "13628947084908729803 14233605946314091555"
items[].​durationInSecnumberrequired

Amount of time between the operation took to complete.

Example: 0.035
items[].​generationintegerrequired

Monotonically increasing update counter. Since history resources are immutable, the value is always 1.

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

Time of history resource creation.

Example: "2022-02-14T04:35:00.051732+00:00"
items[].​updatedAtstring(date-time)required

Time of the last update to the history resource.

Example: "2022-02-14T04:35:00.051732+00:00"
items[].​bodyArray of null or booleans or objects or arrays or numbers or strings or null or boolean or object or number or string

The JSON payload from the body of the response.

Response
application/json
{
  "offset": 0,
  "count": 1,
  "total": 12,
  "items": [
    { … }
  ]
}

Get a history resource

Request

Retrieve a single history entry for a schedule resource.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security
Bearer
Path
idstring(uuid)required

Schedule ID

history-idstring(uuid)required

History ID

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

Responses

OK

Bodyapplication/json
statusinteger or nullrequired

HTTP status code of the response, or null if there was an error without a status code.

Example: 200
headersobjectrequired

The HTTP response headers.

Example: {"Location":"/api/compute/v1/jobs/01b7269f-d2c4-4da8-a66a-4675ef5787d1"}
headers.​property name*stringadditional property
operationTypestringrequired

The type of operation that was executed.

Example: "REST"
Discriminator
typestringrequired

The type of the resource.

Value "compute-ops-mgmt/schedule/history"
idstring(uuid)required

A unique identifier for the execution of the schedule.

Example: "b7bac910-fec8-4907-ab78-f42b499d9041"
resourceUristring(uri-reference)required

The URI of the history resource.

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history/b7bac910-fec8-4907-ab78-f42b499d9041"
scheduleIdstring(uuid)required

The ID of the schedule resource that owns the history resource.

Example: "37f66ae4-20a1-48f1-b552-b515457639ca"
scheduleUristring(uri-reference)required

The URI of the schedule resource that owns the history resource.

Example: "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca"
startedAtstring(date-time)required

The time the execution of the schedule started.

Example: "2022-02-14T04:35:00.051732+00:00"
succeededbooleanrequired

true if the operation was successful, e.g. if the REST request received a 2xx response.

Example: true
summarystringrequired

A Human readable summary, e.g. for a REST request, the HTTP status line or short connection error.

Example: "OK"
debugIdstringrequired

A unique identifier for the execution of the schedule, to be used to help with troubleshooting.

Example: "13628947084908729803 14233605946314091555"
durationInSecnumberrequired

Amount of time between the operation took to complete.

Example: 0.035
generationintegerrequired

Monotonically increasing update counter. Since history resources are immutable, the value is always 1.

Value 1
createdAtstring(date-time)required

Time of history resource creation.

Example: "2022-02-14T04:35:00.051732+00:00"
updatedAtstring(date-time)required

Time of the last update to the history resource.

Example: "2022-02-14T04:35:00.051732+00:00"
bodyArray of null or booleans or objects or arrays or numbers or strings or null or boolean or object or number or string

The JSON payload from the body of the response.

Response
application/json
{
  "operationType": "REST",
  "type": "compute-ops-mgmt/schedule/history",
  "id": "b7bac910-fec8-4907-ab78-f42b499d9041",
  "resourceUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca/history/b7bac910-fec8-4907-ab78-f42b499d9041",
  "scheduleId": "37f66ae4-20a1-48f1-b552-b515457639ca",
  "scheduleUri": "/compute-ops-mgmt/v1beta2/schedules/37f66ae4-20a1-48f1-b552-b515457639ca",
  "startedAt": "2022-02-14T04:35:00.051732+00:00",
  "succeeded": true,
  "summary": "OK",
  "debugId": "13628947084908729803 14233605946314091555",
  "durationInSec": 0.035,
  "generation": 1,
  "createdAt": "2022-02-14T04:35:00.051732+00:00",
  "updatedAt": "2022-02-14T04:35:00.051732+00:00",
  "status": 200,
  "headers": {
    "Location": "/api/compute/v1/jobs/01b7269f-d2c4-4da8-a66a-4675ef5787d1"
  },
  "body": null
}

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