Skip to content
API reference
/
Subscription Recommendati...
/
List subscription recomme...

HPE GreenLake APIs for Subscription Management (latest)

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

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Url hostname

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

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/subscription-management/public/openapi/nbapi-subscription/

Subscriptions - v1

Operations

Subscriptions - v2beta1

Operations

Subscriptions - v1alpha1

Operations

Subscriptions - v1beta1

Operations

Auto Subscriptions settings - v1alpha1

Operations

Auto Subscriptions settings - v1

Operations

Subscription Recommendations - v2alpha1

Operations

List subscription recommendations

Request

Returns a paginated list of per-device-type subscription suggestions. Each item represents one device-type group with a scored list of suggested subscriptions ordered highest-confidence first.
Suggestion cap: Each recommendation group returns at most 20 suggestions.

NOTE: You must have read permission for the Subscription service to call this API.

Security
Bearer
Query
limitinteger(int64)[ 1 .. 100 ]

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

Default 20
offsetinteger(int64)>= 0

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

Default 0
curl -i -X GET \
  https://global.api.greenlake.hpe.com/subscriptions/v2alpha1/recommendations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
itemsArray of objects(SubscriptionRecommendation)required
items[].​idstring(uuid)required

Unique recommendation identifier (one per device-type group).

Example: "7aecd217-dab9-41a7-bbf1-acf0aa2f6f12"
items[].​typestringrequired

Resource type discriminator. Always subscription/suggestion.

Value "subscription/suggestion"
items[].​suggestionTypestringrequired

The category of suggestion. Currently always subscription.

Example: "subscription"
items[].​groupIdstring(uuid)required

Shared identifier across all recommendation items in the same API response.

Example: "07fab58a-8c43-4a9a-9568-2481d6d7dc26"
items[].​titlestringrequired

Human-readable recommendation title summarizing the device types.

Example: "Assign subscription to AP, IAP devices"
items[].​descriptionstringrequired

Human-readable detail text including unlicensed device count and available subscription count.

Example: "12 unlicensed devices can use 3 available subscriptions"
items[].​deviceTypesArray of stringsnon-emptyrequired

Sorted list of device type names in this group. These device types share the same set of eligible subscription tiers.

Example: ["AP","IAP"]
items[].​suggestionsArray of objects(SuggestionValue)[ 1 .. 20 ] itemsrequired

Scored list of suggested subscriptions, ordered by score descending. suggestions[0] is the highest-confidence option. Capped at 20 per group.

items[].​suggestions[].​scorenumber(float)[ 0 .. 1 ]required

Composite confidence score (0.0-1.0). Higher is more confident. Computed from capacity fit (60% weight) and urgency/expiry proximity (40% weight). Suggestions are sorted in descending order by this value.

items[].​suggestions[].​subscriptionDetailsArray of objects(SubscriptionSuggestionDetail)non-emptyrequired

Subscription details for this suggestion.

items[].​suggestions[].​subscriptionDetails[].​idstring(uuid)required

The unique identifier for the subscription.

Example: "1a63a0e0-c4bb-524a-8b25-3c2c1f69b5dc"
items[].​suggestions[].​subscriptionDetails[].​subscriptionKeystringrequired

The subscription's business key.

Example: "SUB-AP-ADV-001"
items[].​suggestions[].​subscriptionDetails[].​tierstringrequired

Subscription tier identifier, for example, FOUNDATION_AP, ADVANCED_AP, ENHANCED_COMPUTE.

Example: "ADVANCED_AP"
items[].​suggestions[].​subscriptionDetails[].​tierDescriptionstringrequired

Human-readable tier description.

Example: "Advanced Access Point"
items[].​suggestions[].​subscriptionDetails[].​totalQuantityinteger>= 0required

Total licensed seats for this subscription.

Example: 100
items[].​suggestions[].​subscriptionDetails[].​availableQuantityinteger>= 0required

Currently unassigned (available) seats.

Example: 45
items[].​suggestions[].​subscriptionDetails[].​subscriptionEndAtstring(date-time)required

Subscription expiry date in ISO-8601 format.

Example: "2027-03-15T00:00:00Z"
items[].​suggestions[].​subscriptionDetails[].​tagsobject

Optional key-value metadata tags from the subscription document. Omitted from response when null or empty.

Example: {"site":"San Jose DC","department":"Engineering"}
items[].​createdAtstring(date-time)required

When the recommendation was generated (ISO-8601).

items[].​updatedAtstring(date-time)required

When the recommendation was last recomputed (ISO-8601).

countinteger(int32)required

Number of items in this page.

totalinteger(int32)required

Total number of recommendation groups matching the query.

offsetinteger(int32)required

Current pagination offset.

Example: 0
Response
application/json

Shows a single recommendation group for AP/IAP devices. Two subscription suggestions are returned, each with full subscription details including tier, capacity, and expiry.

{
  "items": [
    { … }
  ],
  "count": 1,
  "total": 1,
  "offset": 0
}