Skip to content
Internal API Catalog
/
Data Services API
/
API reference
/
software-releases

Data Services API (1.3.0)

Data Services API

Download OpenAPI description
data-services-api.json
data-services-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services-api/

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-releases

Software Releases

Operations

List Software Releases

Request

List multiple Software Releases with filtering, sorting and pagination.

Filtering is supported on the softwareComponent/id and version properties using the eq, in, and and or operators. Sorting is supported on the id and version properties.

Security
bearer
Query
filterstring

An expression to filter list query results. Query result items that match the given filter are returned.

Expressions must be in the format \<property> <operator> \<value> or \<value> <operator> \<property>. The available operators are:

  • eq: Test whether a property's value is equal to a literal.
  • in: Test whether a property's value appears in a list of literals.

Literals can be:

  • GUIDs, such as ae09cc99-57e1-4f82-9d80-e68698da641b.
  • Strings, such as 'hello', 'world'.

Expressions can also be joined using the and and or logical operators.

Examples:
filter=softwareComponent/id eq '2f01f86f-4600-4f92-9f72-885b5f7b01c4'
filter=version in ('1.0.0', '1.1.0', '1.2.0')
filter=version eq '1.0.0' or version eq '1.1.0'
filter=softwareComponent/id eq '2f01f86f-4600-4f92-9f72-885b5f7b01c4' and version in ('1.0.0', '1.1.0', '1.2.0')
limitinteger[ 0 .. 100 ]

The number of query results to return. Use limit in conjuction with offset for paging.

Default 100
Examples:
limit=0
limit=100
offsetinteger>= 0

The offset to use for paging through the result set. Use offset in conjunction with limit for paging.

Default 0
Examples:
offset=0
offset=500
selectArray of strings

Comma separated properties to return in the result. If omitted, all properties will be returned. This is applied to sub-properties of the objects in the items array. Selecting nested properties of an object is not supported.

Examples:
select=id
select=id,name,createdAt,updatedAt,generation
sortstring

One or more properties and directions to sort query results by. A direction is optional and can be either asc or desc for ascending and descending order respectively. If the direction is omitted it defaults to asc.

Default "id asc"
Examples:
sort=id asc
sort=version desc
sort=version
sort=id asc,version asc
sort=id asc,version desc
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services-api/data-services/v1beta1/software-releases \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A list of Software Releases.

Bodyapplication/json
countintegerrequired

Number of items in this response.

Example: 1
offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(SoftwareRelease)required

The software releases returned by the query.

Example: [{"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"}]
items[].​idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
items[].​typestringread-onlyrequired

The type of resource.

Example: "data-services/software-release"
items[].​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
items[].​createdAtstring(date-time)required
Example: "2019-08-24T14:15:22Z"
items[].​updatedAtstring(date-time)required
Example: "2019-08-24T14:15:22Z"
items[].​resourceUristringread-onlyrequired

The self reference for this resource.

Example: "/data-services/v1beta1/software-releases/497f6eca-6276-4993-bfeb-53cbbbba6f08"
items[].​customerIdstringread-onlyrequired

The customer application identifier

Example: "00000000000000000000000000000000"
items[].​namestring

A system specified name for the resource.

Example: "Example v1.0.0"
items[].​downloadableboolean

Whether the files within the Software Release can be downloaded.

Example: true
items[].​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.

items[].​softwareobject(SoftwareReleaseFileMetadata)

The metadata for files within a Software Release.

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

The Software Component a Software Release belongs to.

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

The stabilities that can be assigned to a Software Release.

Value"GENERAL_AVAILABILITY"
Example: "GENERAL_AVAILABILITY"
items[].​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"
items[].​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"
totalinteger

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

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

Get a Software Release

Request

Get a single Software Release by its ID.

Security
bearer
Path
idstring(uuid)required

The ID of a Software Release.

Query
selectArray of strings

Comma separated properties to return in the result. If omitted, all properties will be returned. Selecting nested properties of an object is not supported.

Examples:
select=id
select=id,name,createdAt,updatedAt,generation
curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services-api/data-services/v1beta1/software-releases/{id}' \
  -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"
}

Download a Software Release file

Request

Download a file within a Software Release.

Security
bearer
Path
idstring(uuid)required

The ID of a Software Release.

Bodyapplication/json

The request body for SoftwareReleasesDownload.

filestring(SoftwareReleaseFile)required

The files within a Software Release.

Enum"SOFTWARE""SIGNATURE"
curl -i -X POST \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services-api/data-services/v1beta1/software-releases/{id}/download' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "file": "SOFTWARE"
  }'

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

storage-locations

storage-locations API.

Operations

tags

Tags APIs

Operations