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

Find a Software Release to install.

Request

Find the latest stable Software Release that can be installed for the specified Software Component. A Software Release is considered stable if the stability property is set to GENERAL_AVAILABILITY.

Security
bearer
Path
idstring(uuid)required

The ID of a Software Component.

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

Responses

A Software Release.

Bodyapplication/json
idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
typestringread-onlyrequired

The type of resource.

Example: "data-services/software-release"
generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

Example: 1
createdAtstring(date-time)required
Example: "2019-08-24T14:15:22Z"
updatedAtstring(date-time)required
Example: "2019-08-24T14:15:22Z"
resourceUristringread-onlyrequired

The self reference for this resource.

Example: "/data-services/v1beta1/software-releases/497f6eca-6276-4993-bfeb-53cbbbba6f08"
customerIdstringread-onlyrequired

The customer application identifier

Example: "00000000000000000000000000000000"
namestring

A system specified name for the resource.

Example: "Example v1.0.0"
downloadableboolean

Whether the files within the Software Release can be downloaded.

Example: true
signatureOptionalSoftwareReleaseFileMetadata (null) or SoftwareReleaseFileMetadata (object)(OptionalSoftwareReleaseFileMetadata)

The metadata for files within a Software Release.

Example: {"filename":"example.ova.sig","sha256Checksum":"c6a73c39b2c0d1f91594f81d01f0b79f40f6cd7a939cb3b6f1775fcf939ab3e6","sizeInBytes":1000}
Any of:

The metadata for files within a Software Release.

null(OptionalSoftwareReleaseFileMetadata)

The metadata for files within a Software Release.

softwareobject(SoftwareReleaseFileMetadata)

The metadata for files within a Software Release.

Example: {"filename\"":"example.ova","sha256Checksum\"":"d63c742ff2c761619914400c18f34d2368ae84babc7eac9ffcaea8f40b68b505","sizeInBytes\"":10000}
softwareComponentobject(SoftwareComponentReference)

The Software Component a Software Release belongs to.

Example: {"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"Example","type":"data-services/software-component"}
stabilitystring(SoftwareReleaseStability)

The stabilities that can be assigned to a Software Release.

Value"GENERAL_AVAILABILITY"
Example: "GENERAL_AVAILABILITY"
usagestring(SoftwareReleaseUsage)

An indicator of how a Software Release should be used:

  • INSTALL: Used for an initial install, such as the OVA for a virtual machine.
  • UPGRADE: Upgrades an existing release.
  • UNIVERSAL: Acts as both an install and upgrade media.
Enum"INSTALL""UPGRADE""UNIVERSAL"
Example: "INSTALL"
versionstring(SoftwareReleaseVersion)[ 1 .. 32 ] characters^(0|[1-9]\d*)(\.(0|[1-9]\d*))*(-(0|[1-9]\d*)(...

The version of a Software Release.

Example: "1.0.0"
Response
application/json
{
  "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.ova.sig",
    "sha256Checksum": "c6a73c39b2c0d1f91594f81d01f0b79f40f6cd7a939cb3b6f1775fcf939ab3e6",
    "sizeInBytes": 1000
  },
  "software": {
    "filename"": "example.ova",
    "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": "INSTALL",
  "version": "1.0.0"
}

software-releases

Software Releases

Operations

software-upgrades

Software Upgrades

Operations

storage-locations

storage-locations API.

Operations

tags

Tags APIs

Operations