Skip to content
Internal API Catalog
/
HPE GreenLake APIs for Subscription Management
/
Auto Subscriptions settings - v1

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

Subscriptions - v1beta1

Operations

Auto Subscriptions settings - v1alpha1

Operations

Auto Subscriptions settings - v1

Operations

Get all configured auto-subscriptions settings

Request

Get all configured auto-subscriptions settings in a workspace.

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. 25 requests per minute is supported per workspace. The API returns 429 if this threshold is breached.

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

Responses

Successful response

Bodyapplication/json
countinteger(int32)required

Number of items returned.

Example: 10
itemsArray of objects(AutoSubscriptionsResponseDtoWithTenant)required
items[].​createdAtstringrequired

Time of auto-subscription creation.

Example: "2024-02-07T11:20:35.290Z"
items[].​idstringrequired

The unique identifier of the tenant.

Example: "64343c3c-3016-4234-baee-765651aa4bb3"
items[].​resourceUristringrequired

URI to the auto-subscription.

items[].​updatedAtstringrequired

Time of last auto-subscription update.

Example: "2024-02-07T11:22:35.800Z"
items[].​typestringrequired

Type of the resource

Example: "subscriptions/auto-subscription-settings."
items[].​generationinteger(int32)

Monotonically increasing update counter.

Example: 0
items[].​autoSubscriptionSettingsArray of objects(AutoSubscriptionSettings)
items[].​tenantWorkspaceIdstring

The unique identifier of a tenant workspace.

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: 50
Response
application/json
{
  "items": [
    { … }
  ],
  "count": 10,
  "offset": 0,
  "total": 50
}

Get configured auto-subscriptions settings per workspace

Request

Retrieve the configured auto-subscriptions settings in a workspace.

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

Rate limits are enforced on this API. 25 requests per minute is supported per workspace. The API returns 429 if this threshold is breached.

Security
Bearer
Path
idstringrequired

The unique identifier of the workspace.

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/subscription-management/public/openapi/nbapi-subscription-latest/subscriptions/v1/auto-subscription-settings/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
createdAtstringrequired

The time of auto-subscription creation.

Example: "2024-02-07T11:20:35.290Z"
idstringrequired

The unique identifier of the auto-subscription.

Example: "64343c3c-3016-4234-baee-765651aa4bb3"
resourceUristringrequired

URI to the auto-subscription.

updatedAtstringrequired

The time of last auto-subscription update.

Example: "2024-02-07T11:22:35.800Z"
typestringrequired

The type of the resource.

Example: "subscriptions/auto-subscription-settings"
generationinteger(int32)

Monotonically increasing update counter.

Example: 0
autoSubscriptionSettingsArray of objects(AutoSubscriptionSettings)
Response
application/json
{
  "id": "64343c3c-3016-4234-baee-765651aa4bb3",
  "createdAt": "2024-02-07T11:20:35.290Z",
  "updatedAt": "2024-02-07T11:22:35.800Z",
  "generation": 0,
  "type": "subscriptions/auto-subscription-settings",
  "resourceUri": "string",
  "autoSubscriptionSettings": [
    { … }
  ]
}

Update the configured auto-subscriptions settings of a workspace

Request

Update the configured auto-subscriptions managed in a workspace.

In the payload, you can pass a list of deviceType and tier combinations to be updated or created. If the combination of deviceType and tier is already configured, it is updated. Otherwise, the combination is created. If you need to remove settings for one or more combination of deviceType and tier, pass tier as null for the required deviceType.

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

Rate limits are enforced on this API. 25 requests per minute is supported per workspace. The API returns 429 if this threshold is breached.

Security
Bearer
Path
idstringrequired

The unique identifier of the auto subscription settings.

Bodyapplication/merge-patch+jsonrequired
autoSubscriptionSettingsArray of objects(RequestPostAutoSubscription)
curl -i -X PATCH \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/subscription-management/public/openapi/nbapi-subscription-latest/subscriptions/v1/auto-subscription-settings/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Successful response

Bodyapplication/json
createdAtstringrequired

The time of auto-subscription creation.

Example: "2024-02-07T11:20:35.290Z"
idstringrequired

The unique identifier of the auto-subscription.

Example: "64343c3c-3016-4234-baee-765651aa4bb3"
resourceUristringrequired

URI to the auto-subscription.

updatedAtstringrequired

The time of last auto-subscription update.

Example: "2024-02-07T11:22:35.800Z"
typestringrequired

The type of the resource.

Example: "subscriptions/auto-subscription-settings"
generationinteger(int32)

Monotonically increasing update counter.

Example: 0
autoSubscriptionSettingsArray of objects(AutoSubscriptionSettings)
Response
application/json
{
  "id": "64343c3c-3016-4234-baee-765651aa4bb3",
  "createdAt": "2024-02-07T11:20:35.290Z",
  "updatedAt": "2024-02-07T11:22:35.800Z",
  "generation": 0,
  "type": "subscriptions/auto-subscription-settings",
  "resourceUri": "string",
  "autoSubscriptionSettings": [
    { … }
  ]
}