Service offer management (v1beta1)

The API reference documentation for endpoints related to service offer management.

Download OpenAPI description

index.json

index.yaml

Overview

License

HPE End User License Agreement

Servers

Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/service-catalog/public/openapi/service-registry-v1beta1/

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

Service offers

Operations

Get service offers

Request

Retrieve a list of service offers by applying filters. A service offer provides a distinct set of functionality that can be independently identified and assigned access.

Pagination: This API supports cursor-based pagination. Provide the cursor in the next query parameter to retrieve the next page.

Security

bearerAuth

Query

nextstring(Pagination cursor)

Specifies the pagination cursor for the next page of service offers.

Example: next=64136af7-cd64-4b4e-88a8-150ab51a920d

limitinteger(Pagination limit)[ 1 .. 2000 ]

Specifies the number of results to be returned.

Default 2000

filterstring

The filter query parameter is used to filter the set of resources returned in a GET request. The returned set of resources must match the criteria in the filter query parameter.

The value of the filter query parameter is a subset of OData 4.0 filter expressions consisting of simple comparison operations joined by logical operators.

Supported fields: category, serviceManagerId, status, isDefault, slug, and staticLaunchUrl.
Supported operand: eq
Supported operations: and

Examples:

Filter by serviceManagerId

Return service offers for given service manager ID

Filter by category

Return service offers for a given category

Filter by isDefault

Return service offers that are service managers

Filter by staticLaunchUrl

Return service offers for a given static launch URL

Filter by status

Return service offers with a given status

Filter by slug

Return service offers with a given slug

curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/service-catalog/public/openapi/service-registry-v1beta1/service-catalog/v1beta1/service-offers \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

itemsArray of objects(ServiceOfferList)required

items[].idstring(uuid)(id)required

The unique identifier for the service offer.

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

items[].resourceUristring(resourceUri)required

The URI reference to this resource.

Example: "/service-catalog/v1beta1/service-offers/3fa85f64-5717-4562-b3fc-2c963f66afa6"

items[].namestring(name)required

The name of the service offer.

Example: "Aruba Central"

items[].slugstring(slug)[ 2 .. 8 ] characters^[A-Z-]+$required

A short identifier for the service offer.

Example: "AC"

items[].overviewstring(overview)<= 128 charactersrequired

A brief overview of the service offer.

Example: "Aruba Central overview"

items[].capabilitiesArray of stringsrequired

A list of key features or functionalities provided by the service offer.

Example: ["Capability 1","Capability 2"]

items[].categoriesArray of strings(Category)required

The categories to which the service offer belongs.

Items Enum"COMPUTE""NETWORKING""STORAGE"

Example: ["COMPUTE","NETWORKING"]

items[].serviceOfferTypestring(ServiceOfferType)required

The type of service offer.

Enum"FREE""COMMON_TOOLS""SAAS"

Example: "SAAS"

items[].serviceManagerobject(ServiceManagerResourceLink)required

The associated service manager application for this service offer, including its ID and resource URI.

items[].serviceManager.idstring(uuid)(id)

The unique identifier for the service manager.

Example: "7267b0e0-013c-4181-8c27-01b395ed0b61"

items[].serviceManager.resourceUristring(resourceUri)

The URI reference to the service manager resource.

Example: "/service-catalog/v1beta1/service-managers/7267b0e0-013c-4181-8c27-01b395ed0b61"

items[].featuresSupportedArray of strings(SupportedFeature)required

The features supported by this service offer, such as deep linking or RBAC.

Items Enum"DEEP_LINKING""EVALUATION""SERVICE_PROVISIONING"

Example: ["DEEP_LINKING","SERVICE_PROVISIONING","HONOR_UNPROVISION_RESPONSE"]

items[].languagesSupportedArray of strings(languagesSupported)required

The ISO codes for languages supported by this service offer.

Example: ["en-US","de-DE"]

items[].documentationUrlstring(documentationURL)required

An HTTPS URL to the documentation.

Example: "https://www.arubanetworks.com/techdocs/central/latest/content/home.htm"

items[].termsOfServiceUrlstring(termsOfServiceURL)required

An HTTPS URL to the terms of service.

Example: "https://www.hpe.com/us/en/about/legal/ccs-terms.html#Storage"

items[].testDriveUrlstring(testDriveURL)required

An HTTPS URL to test drive.

Example: "https://testdrive.greenlake.hpe.com"

items[].contactSalesUrlstring(contactSalesURL)required

The HTTPS URL for contacting the sales team.

Example: "https://contact-sales.hpe.com/"

items[].statusstring(ServiceOfferStatus)required

The current status of the service offer.

Enum"ONBOARDING""ONBOARDED""PUBLISHED"

Example: "PUBLISHED"

items[].createdAtstring(date-time)(createdAt)required

Date and time at which the service offer was created.

Example: "2021-04-23T10:20:30.400+02:30"

items[].shortDescriptionstring(shortDescription)required

A short description or tagline for the service offer.

Example: "description"

items[].staticLaunchUrlstring(staticLaunchUrl)required

The relative URL used to launch the service offer.

Example: "https://${sub-domain}/infosight.hpe.com"

items[].evalUrlstring(evalUrl)required

The URL to sign up for a time-limited evaluation or trial of the service offer.

Example: "https://connect.hpe.com/HPE_Backup_and_Recovery_Trial"

items[].brokerUristring(brokerUri)required

HPE Internal. Applies only to internal service offers. It is the relative path starting with API group (the API group is sufficient). The base URI is the API gateway for the HPE GreenLake cloud cluster. This is the application API endpoint exposed by application to be called from HPE GreenLake cloud.

Example: "/igc"

items[].preProvisionMessagestring(preProvisionMessage)required

A message displayed to users before provisioning the service offer, such as warnings or important information.

Example: "Users will be logged out during provisioning."

items[].isDefaultboolean(isDefault)

Indicates whether this service offer is the default for its service manager.

Default false

Example: true

items[].updatedAtstring(date-time)(updatedAt)

Date and time at which the service offer was last updated.

Example: "2021-04-29T10:20:30.400+02:30"

items[].generationinteger(generation)

A monotonically increasing update counter.

Example: 1

nextstring(next)required

Cursor for the next page of resources.

Example: "64136af7-cd64-4b4e-88a8-150ab51a920d"

countinteger(count)required

The number of returned items per page.

Default 1

totalinteger(total)required

The total number of items in the result set.

Default 10

Response

application/json

{
  "items": [
    { … }
  ],
  "next": "64136af7-cd64-4b4e-88a8-150ab51a920d",
  "count": 1,
  "total": 10
}

Get a service offer

Request

Retrieve detailed information about a specific service offer by supplying its unique identifier in the request path. To obtain valid service offer IDs, use the Get service offers endpoint to list available offers.

Security

bearerAuth

Path

idstring(uuid)(id)required

The unique identifier of the service offer.

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/service-catalog/public/openapi/service-registry-v1beta1/service-catalog/v1beta1/service-offers/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

idstring(uuid)(id)required

The unique identifier for the service offer.

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

resourceUristring(resourceUri)required

The URI reference to this resource.

Example: "/service-catalog/v1beta1/service-offers/3fa85f64-5717-4562-b3fc-2c963f66afa6"

namestring(name)required

The name of the service offer.

Example: "Aruba Central"

slugstring(slug)[ 2 .. 8 ] characters^[A-Z-]+$required

A short identifier for the service offer.

Example: "AC"

overviewstring(overview)<= 128 charactersrequired

A brief overview of the service offer.

Example: "Aruba Central overview"

capabilitiesArray of stringsrequired

A list of key features or functionalities provided by the service offer.

Example: ["Capability 1","Capability 2"]

categoriesArray of strings(Category)required

The categories to which the service offer belongs.

Items Enum"COMPUTE""NETWORKING""STORAGE"

Example: ["COMPUTE","NETWORKING"]

serviceOfferTypestring(ServiceOfferType)required

The type of service offer.

Enum"FREE""COMMON_TOOLS""SAAS"

Example: "SAAS"

serviceManagerobject(ServiceManagerResourceLink)required

The associated service manager application for this service offer, including its ID and resource URI.

serviceManager.idstring(uuid)(id)

The unique identifier for the service manager.

Example: "7267b0e0-013c-4181-8c27-01b395ed0b61"

serviceManager.resourceUristring(resourceUri)

The URI reference to the service manager resource.

Example: "/service-catalog/v1beta1/service-managers/7267b0e0-013c-4181-8c27-01b395ed0b61"

featuresSupportedArray of strings(SupportedFeature)required

The features supported by this service offer, such as deep linking or RBAC.

Items Enum"DEEP_LINKING""EVALUATION""SERVICE_PROVISIONING"

Example: ["DEEP_LINKING","SERVICE_PROVISIONING","HONOR_UNPROVISION_RESPONSE"]

languagesSupportedArray of strings(languagesSupported)required

The ISO codes for languages supported by this service offer.

Example: ["en-US","de-DE"]

documentationUrlstring(documentationURL)required

An HTTPS URL to the documentation.

Example: "https://www.arubanetworks.com/techdocs/central/latest/content/home.htm"

termsOfServiceUrlstring(termsOfServiceURL)required

An HTTPS URL to the terms of service.

Example: "https://www.hpe.com/us/en/about/legal/ccs-terms.html#Storage"

testDriveUrlstring(testDriveURL)required

An HTTPS URL to test drive.

Example: "https://testdrive.greenlake.hpe.com"

contactSalesUrlstring(contactSalesURL)required

The HTTPS URL for contacting the sales team.

Example: "https://contact-sales.hpe.com/"

statusstring(ServiceOfferStatus)required

The current status of the service offer.

Enum"ONBOARDING""ONBOARDED""PUBLISHED"

Example: "PUBLISHED"

createdAtstring(date-time)(createdAt)required

Date and time at which the service offer was created.

Example: "2021-04-23T10:20:30.400+02:30"

shortDescriptionstring(shortDescription)required

A short description or tagline for the service offer.

Example: "description"

staticLaunchUrlstring(staticLaunchUrl)required

The relative URL used to launch the service offer.

Example: "https://${sub-domain}/infosight.hpe.com"

evalUrlstring(evalUrl)required

The URL to sign up for a time-limited evaluation or trial of the service offer.

Example: "https://connect.hpe.com/HPE_Backup_and_Recovery_Trial"

brokerUristring(brokerUri)required

Example: "/igc"

preProvisionMessagestring(preProvisionMessage)required

A message displayed to users before provisioning the service offer, such as warnings or important information.

Example: "Users will be logged out during provisioning."

isDefaultboolean(isDefault)

Indicates whether this service offer is the default for its service manager.

Default false

Example: true

updatedAtstring(date-time)(updatedAt)

Date and time at which the service offer was last updated.

Example: "2021-04-29T10:20:30.400+02:30"

generationinteger(generation)

A monotonically increasing update counter.

Example: 1

Response

application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "resourceUri": "/service-catalog/v1beta1/service-offers/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Aruba Central",
  "slug": "AC",
  "overview": "Aruba Central overview",
  "capabilities": [
    "Capability 1",
    "Capability 2"
  ],
  "categories": [
    "COMPUTE",
    "NETWORKING"
  ],
  "serviceOfferType": "SAAS",
  "serviceManager": {
    "id": "7267b0e0-013c-4181-8c27-01b395ed0b61",
    "resourceUri": "/service-catalog/v1beta1/service-managers/7267b0e0-013c-4181-8c27-01b395ed0b61"
  },
  "isDefault": true,
  "featuresSupported": [
    "DEEP_LINKING",
    "SERVICE_PROVISIONING",
    "HONOR_UNPROVISION_RESPONSE"
  ],
  "languagesSupported": [
    "en-US",
    "de-DE"
  ],
  "documentationUrl": "https://www.arubanetworks.com/techdocs/central/latest/content/home.htm",
  "termsOfServiceUrl": "https://www.hpe.com/us/en/about/legal/ccs-terms.html#Storage",
  "testDriveUrl": "https://testdrive.greenlake.hpe.com",
  "contactSalesUrl": "https://contact-sales.hpe.com/",
  "status": "PUBLISHED",
  "createdAt": "2021-04-23T10:20:30.400+02:30",
  "updatedAt": "2021-04-29T10:20:30.400+02:30",
  "generation": 1,
  "shortDescription": "description",
  "staticLaunchUrl": "https://${sub-domain}/infosight.hpe.com",
  "evalUrl": "https://connect.hpe.com/HPE_Backup_and_Recovery_Trial",
  "brokerUri": "/igc",
  "preProvisionMessage": "Users will be logged out during provisioning."
}

Service offer regions

Operations

UI Management

Operations

Service offer management (v1beta1)

Service offers

Get service offers

Request

Responses

Was this helpful?

Get a service offer

Request

Responses

Was this helpful?

Service offer regions

UI Management