Skip to content

Data Services API (1.3.0)

Data Services API

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/data-services/public/openapi/data-services-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/

async-operations

Async Operations API

Operations

dual-auth-operations

Dual Authorization API

Operations

issues

Issues API

Operations

secret-assignments

Secret Assignment Management APIs

Operations

secrets

Secret Management APIs

Operations

settings

Settings API

Operations

software-components

Software Components

Operations

software-releases

Software Releases

Operations

software-upgrades

Software Upgrades

Operations

List upgrades for a Software Release

Request

List the available upgrades for an installed Software Release, identified by a version and Software Component ID. Pagination is not supported on the returned items.

The returned items are upgrades that can be applied to an existing installation of a Software Release. Some releases can be applied immediately, while others may require corrective actions to be completed before the release is allowed.

Upgrades beyond those initially returned can be found by recursively calling this API with the new Software Release version. This can be useful for presenting the series of updates required to bring an installation to the latest version.

Security
bearer
Query
software-component-idstring(uuid)required

The ID of a Software Component.

versionstring(SoftwareReleaseVersion)[ 1 .. 32 ] characters^(0|[1-9]\d*)(\.(0|[1-9]\d*))*(-(0|[1-9]\d*)(...required

The version of an installed Software Release that is being upgraded.

serial-numberstring

The serial number of the hardware being upgraded. Either agent-id or serial-number must be supplied.

Example: serial-number=AC-109329
agent-idstring(uuid)

The identifier for the virtual machine being upgraded. Either agent-id or serial-number must be supplied.

curl -i -X GET \
  'https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/software-upgrades?software-component-id=497f6eca-6276-4993-bfeb-53cbbbba6f08&version=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Upgrades for a Software Release.

Bodyapplication/json
countintegerrequired

Number of items in this response.

Example: 2
offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(SoftwareUpgrade)required

The software upgrades.

Example: [{"allowed":true,"id":"497f6eca-6276-5993-bfeb-53cbbbba6f08","notes":[],"softwareRelease":{"createdAt":"2019-08-24T14:15:22Z","customerId":"00000000000000000000000000000000","downloadable":true,"generation":1,"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"Example v1.0.0","resourceUri":"/data-services/v1beta1/software-releases/497f6eca-6276-4993-bfeb-53cbbbba6f08","signature":{"filename":"example.iso.sig","sha256Checksum":"c6a73c39b2c0d1f91594f81d01f0b79f40f6cd7a939cb3b6f1775fcf939ab3e6","sizeInBytes":1000},"software":{"filename\"":"example.iso","sha256Checksum\"":"d63c742ff2c761619914400c18f34d2368ae84babc7eac9ffcaea8f40b68b505","sizeInBytes\"":10000},"softwareComponent":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"Example","type":"data-services/software-component"},"stability":"GENERAL_AVAILABILITY","type":"data-services/software-release","updatedAt":"2019-08-24T14:15:22Z","usage":"UPGRADE","version":"1.0.0"},"type":"data-services/software-upgrade"},{"allowed":false,"id":"example-2","notes":["Action required"],"softwareRelease":{"createdAt":"2019-08-24T14:15:22Z","customerId":"00000000000000000000000000000000","downloadable":true,"generation":1,"id":"497f6eca-6276-5993-bfeb-53cbbbba6f07","name":"Example v2.0.0","resourceUri":"/data-services/v1beta1/software-releases/497f6eca-6276-4993-bfeb-53cbbbba6f08","signature":{"filename":"example.iso.sig","sha256Checksum":"c6a73c39b2c0d1f91594f81d01f0b79f40f6cd7a939cb3b6f1775fcf939ab3e6","sizeInBytes":1000},"software":{"filename\"":"example.iso","sha256Checksum\"":"d63c742ff2c761619914400c18f34d2368ae84babc7eac9ffcaea8f40b68b505","sizeInBytes\"":10000},"softwareComponent":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"Example","type":"data-services/software-component"},"stability":"GENERAL_AVAILABILITY","type":"data-services/software-release","updatedAt":"2019-08-24T14:15:22Z","usage":"UPGRADE","version":"2.0.0"},"type":"data-services/software-upgrade"}]
items[].​idstring(uuid)required

The ID of the resource.

items[].​typestringrequired

The type of resource.

items[].​allowedboolean

Whether access to the release is currently allowed. If it is not allowed, the notes property contains actions to complete to make it allowed.

items[].​notesArray of strings

Actions to completed before the upgrade is allowed. Empty if allowed is true.

items[].​softwareReleaseobject(SoftwareRelease)

A release of software.

totalinteger

Total number of items matching the filter parameter in the request.

Response
application/json
{
  "count": 2,
  "items": [
    { … },
    { … }
  ]
}

storage-locations

storage-locations API.

Operations

tags

Tags APIs

Operations