Skip to content
Internal API Catalog
/
HPE GreenLake APIs for Subscription Management
/
Subscriptions - v1alpha1

HPE GreenLake APIs for Subscription Management (latest)

With the HPE GreenLake APIs for Subscription Management you can add subscriptions, get subscription information, and update auto-subscription settings for your HPE GreenLake workspace.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/subscription-management/public/openapi/nbapi-subscription-latest/

Url hostname

https://global.api.greenlake.hpe.com/

Subscriptions - v1

Operations

Subscriptions - v1alpha1

Operations

Get subscriptions of a workspaceDeprecated

Request

Get subscriptions managed in a workspace. Pass filters to limit results based on conditional expressions.

NOTE: You need to have the view permission for the Devices and subscription service to invoke this API.

Rate limits are enforced on this API. 40 requests per minute is supported per workspace. API will result in 429 if this threshold is breached.

Security
Bearer
Query
filterstring

Filter expressions consisting of simple comparison operations joined by logical operators.

Example: filter=key eq 'MHNBAP0001' and key in 'PAYHAH3YJE6THY, E91A7FDFE04D44C339'
sortstring

A comma separated list of sort expressions. A sort expression is a property name optionally followed by a direction indicator asc or desc. Default is ascending order.

Example: sort=key, quote desc
selectArray of stringsunique

A comma separated list of select properties to return in the response. By default, all properties are returned.

Example: select=id,key
limitinteger(int64)[ 1 .. 2000 ]

Specifies the number of results to be returned. The default value is 2000.

Default 2000
offsetinteger(int64)

Specifies the zero-based resource offset to start the response from. Default value is 0.

Default 0
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/subscription-management/public/openapi/nbapi-subscription-latest/subscriptions/v1alpha1/subscriptions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Headers
Deprecationstring

Wed, 15 Jan 2025 23:59:59 GMT

Sunsetstring

Tue, 15 Apr 2025 23:59:59 GMT

Bodyapplication/json
itemsArray of objects(SubscriptionDetail)required
items[].​idstring[ 0 .. 36 ] charactersrequired

The unique identifier for the subscription.

Example: "b49bf6d2-02b4-4735-9ae5-f88834af9b7e"
items[].​keystring

The subscription key.

Example: "BAASOAAg95"
items[].​quantitystring

Total quantity of the subscription.

Example: 10
items[].​evaluationTypestring

The type of license.

Enum"EVAL""ALPHA""NONE"
items[].​productSkustring

The product stock keeping unit (SKU).

Example: "ROTO1AAE"
items[].​productDescriptionstring

A description of the product stock keeping unit.

Example: "HPE GreenLake for Block Storage 3 Year(s)"
items[].​quotestring

A unique number that identifies an order and all its attached subscriptions.

Example: "quote1"
items[].​postring

The purchase order number.

Example: "POAQE451"
items[].​contractstring
Example: "V16BMAAS"
items[].​endUserNamestring

The customer name to which the subscription belongs.

Example: "ACCUTECH DATA SUPPLIES, INC."
items[].​orderClassstring

The ordering system source.

Example: "class1"
items[].​aasTypestring

Defines the as a service (aaS) type. For example, infrastructure as a service (IAAS).

Value"IAAS"
items[].​appointmentobject(Appointment)
countinteger(int32)required

Number of items returned.

Example: 20
offsetinteger(int32)

Zero-based resource offset.

Example: 0
totalinteger(int32)

Total number of items in the collection that match the filter query, if one was provided in the request otherwise total number of items for a given resource.

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

Subscriptions - v1beta1

Operations

Auto Subscriptions settings - v1alpha1

Operations

Auto Subscriptions settings - v1

Operations