API reference

Service offer management (v1beta1)

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

Download OpenAPI description

service_catalog_v1beta1_nbapi.json

service_catalog_v1beta1_nbapi.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/service_catalog_v1beta1_nbapi/

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

Service offers

Operations

Service offer regions

Operations

UI Management

Operations

Get Service Offers for Catalog

Request

Get Service Offers for Catalog View

Security

bearerAuth

Query

nextstring(Pagination Cursor)

Specifies the category for the next page of service catalog.

Example: next=STORAGE

limitinteger(Pagination Limit)[ 1 .. 2000 ]

Number of entries per page

Default 2000

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_nbapi/service-catalog/v1beta1/service-catalog \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

itemsArray of objects(CategoryWithServiceOffers)required

items[].idstring(Category)required

The category to which a service offer belongs, such as compute, networking, or storage.

Enum"COMPUTE""NETWORKING""STORAGE"

items[].typestring(type)required

Type of resource

Example: "/service-catalog/categorywise-services"

items[].servicesWithRegionsArray of objects(ServiceOfferWithAvailableRegions)required

items[].servicesWithRegions[].serviceOfferobject(ServiceOfferRead)required

A service offer represents a specific set of features or capabilities that can be independently identified and assigned access. Service offers are typically associated with roles and permissions, commerce, metering, quote-to-cash, or trial evaluations.

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

The unique identifier for the service offer.

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

items[].servicesWithRegions[].serviceOffer.resourceUristring(resourceUri)required

The URI reference to this resource.

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

items[].servicesWithRegions[].serviceOffer.namestring(name)required

The name of the service offer.

Example: "Aruba Central"

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

A short identifier for the service offer.

Example: "AC"

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

A brief overview of the service offer.

Example: "Aruba Central overview"

items[].servicesWithRegions[].serviceOffer.capabilitiesArray of stringsrequired

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

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

items[].servicesWithRegions[].serviceOffer.categoriesArray of strings(Category)required

The categories to which the service offer belongs.

Items Enum"COMPUTE""NETWORKING""STORAGE"

Example: ["COMPUTE","NETWORKING"]

items[].servicesWithRegions[].serviceOffer.serviceOfferTypestring(ServiceOfferType)required

The type of service offer.

Enum"FREE""COMMON_TOOLS""SAAS"

Example: "SAAS"

items[].servicesWithRegions[].serviceOffer.serviceManagerobject(ServiceManagerResourceLink)required

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

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

The unique identifier for the service manager.

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

items[].servicesWithRegions[].serviceOffer.serviceManager.resourceUristring(resourceUri)

The URI reference to the service manager resource.

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

items[].servicesWithRegions[].serviceOffer.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[].servicesWithRegions[].serviceOffer.languagesSupportedArray of strings(languagesSupported)required

The ISO codes for languages supported by this service offer.

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

items[].servicesWithRegions[].serviceOffer.documentationUrlstring(documentationURL)required

An HTTPS URL to the documentation.

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

items[].servicesWithRegions[].serviceOffer.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[].servicesWithRegions[].serviceOffer.testDriveUrlstring(testDriveURL)required

An HTTPS URL to test drive.

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

items[].servicesWithRegions[].serviceOffer.contactSalesUrlstring(contactSalesURL)required

The HTTPS URL for contacting the sales team.

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

items[].servicesWithRegions[].serviceOffer.statusstring(ServiceOfferStatus)required

The current status of the service offer.

Enum"ONBOARDING""ONBOARDED""PUBLISHED"

Example: "PUBLISHED"

items[].servicesWithRegions[].serviceOffer.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[].servicesWithRegions[].serviceOffer.shortDescriptionstring(shortDescription)required

A short description or tagline for the service offer.

Example: "description"

items[].servicesWithRegions[].serviceOffer.staticLaunchUrlstring(staticLaunchUrl)required

The relative URL used to launch the service offer.

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

items[].servicesWithRegions[].serviceOffer.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[].servicesWithRegions[].serviceOffer.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[].servicesWithRegions[].serviceOffer.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[].servicesWithRegions[].serviceOffer.isDefaultboolean(isDefault)

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

Default false

Example: true

items[].servicesWithRegions[].serviceOffer.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[].servicesWithRegions[].serviceOffer.generationinteger(generation)

A monotonically increasing update counter.

Example: 1

items[].servicesWithRegions[].availableRegionsArray of objects(availableRegions)required

The list of regions where this service offer is available to the current user or customer.

items[].servicesWithRegions[].availableRegions[].idstring(id)

The code name for a geographical region supported by the HPE GreenLake cloud.

Example: "us-east"

items[].servicesWithRegions[].availableRegions[].typestring(type)

The resource type identifier for the region.

Example: "/service-catalog/region"

items[].servicesWithRegions[].availableRegions[].namestring(name)

The human-readable name for the geographical region.

Example: "US East"

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

The unique identifier for the service offer with available regions.

Example: 1

items[].servicesWithRegions[].typestring(type)

The resource type for this object.

Example: "/service-catalog/service-with-regions"

nextstring(next)required

Example: "STORAGE"

countinteger(count)required

Count Per Page

Default 1

totalinteger(total)required

Total Count

Default 10

Response

application/json

{
  "items": [
    { … }
  ],
  "next": "STORAGE",
  "count": 1,
  "total": 10
}

Get Featured Service Offers

Request

Get Featured Service Offers

Security

bearerAuth

Query

nextstring(Pagination Cursor)

Specifies the category for the next page of featured services.

Example: next=STORAGE

limitinteger(Pagination Limit)[ 1 .. 2000 ]

Number of entries per page

Default 2000

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_nbapi/service-catalog/v1beta1/featured-services \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

itemsArray of objects(CategoryWithFeaturedServiceOffers)required

items[].idstring(Category)required

The category to which a service offer belongs, such as compute, networking, or storage.

Enum"COMPUTE""NETWORKING""STORAGE"

items[].typestring(type)required

Type of resource

Example: "/service-catalog/featured-service"

items[].servicesWithRegionsArray of objects(ServiceOfferWithAvailableRegions)

nextstring(next)required

Example: "STORAGE"

countinteger(count)required

Count Per Page

Default 1

totalinteger(total)required

Total Count

Default 10

Response

application/json

{
  "items": [
    { … }
  ],
  "next": "STORAGE",
  "count": 1,
  "total": 10
}

Get Service Offer Details

Request

Get Detailed Service Offer

Security

bearerAuth

Path

idstring(string)(id)required

Service Offer ID

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_nbapi/service-catalog/v1beta1/detailed-service-offers/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

idstring(id)required

Region with Detailed Provisions identifier

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

typestring(type)required

Type of resource

Example: "/service-catalog/detailed-service-offer"

availableRegionsArray of objects(availableRegions)required

Names of the regions where the Service Offer is available for the logged in user/customer.

availableRegions[].idstring(id)

The code name for a geographical region supported by the HPE GreenLake cloud.

Example: "us-east"

availableRegions[].typestring(type)

The resource type identifier for the region.

Example: "/service-catalog/region"

availableRegions[].namestring(name)

The human-readable name for the geographical region.

Example: "US East"

availableRegions[].locationsArray of strings(location)

A list of physical locations within the region where the application instance is available.

Example: ["Virginia","California"]

provisionsArray of objects(provisions)required

Data pertaining to service and app provisions

provisions[].serviceOfferobject(ServiceOfferPartialDetails)

Partial details for a service offer

provisions[].serviceManagerProvisionobject(ServiceManagerProvision)

Service manager provision details

provisions[].serviceProvisionobject(ServiceProvision)

orgSingletonServiceProvisionsArray of objects(orgSingletonServiceProvision)required

Service-provision entry for the organization that the current workspace belongs to.

orgSingletonServiceProvisions[].serviceOfferobject(ServiceOfferPartialDetails)

Partial details for a service offer

orgSingletonServiceProvisions[].serviceManagerProvisionobject(ServiceManagerProvision)

Service manager provision details

orgSingletonServiceProvisions[].serviceProvisionobject(ServiceProvision)

serviceOfferobject(ServiceOfferReadWithMedia)

serviceManagerobject(DetailedServiceManagerResourceLink)

Response

application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "/service-catalog/detailed-service-offer",
  "serviceOffer": {
    "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": [ … ],
    "categories": [ … ],
    "serviceOfferType": "SAAS",
    "serviceManager": { … },
    "isDefault": true,
    "featuresSupported": [ … ],
    "languagesSupported": [ … ],
    "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.",
    "workspaceTypes": [ … ],
    "logo": { … },
    "screenshots": [ … ],
    "videos": [ … ]
  },
  "availableRegions": [
    { … }
  ],
  "serviceManager": {
    "id": "7267b0e0-013c-4181-8c27-01b395ed0b61",
    "resourceUri": "/service-catalog/v1beta1/service-managers/7267b0e0-013c-4181-8c27-01b395ed0b61",
    "serviceOfferId": "8e22512f-da36-43f7-8141-83c6fc4b025b",
    "name": "Aruba Central"
  },
  "provisions": [
    { … }
  ],
  "orgSingletonServiceProvisions": [
    { … }
  ]
}

Get My Services

Request

Get data to populate My Services

Security

bearerAuth

Query

nextstring(Pagination Cursor)

Specifies the start-id for the next page of my services.

Example: next=us-west

limitinteger(Pagination Limit)[ 1 .. 2000 ]

Number of entries per page

Default 2000

include-omnipresentboolean(Include Omnipresent)

Specifies whether to include omnipresent service offers in response

Default false

Example: include-omnipresent=true

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_nbapi/service-catalog/v1beta1/my-services \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

itemsArray of objects(Provisions)required

Data pertaining to service and app provisions

items[].idstring(id)required

Region with Detailed Provisions identifier

Example: "us-east"

items[].typestring(type)required

Resource Type

Example: "/service-catalog/my-service"

items[].provisionsArray of objects(provisions)required

items[].provisions[].serviceOfferobject(ServiceOfferPartialDetails)

Partial details for a service offer

items[].provisions[].serviceManagerProvisionobject(ServiceManagerProvision)

Service manager provision details

items[].provisions[].serviceProvisionobject(ServiceProvision)

nextstring(next)required

Example: "us-west"

countinteger(count)required

Count Per Page

Default 1

totalinteger(total)required

Total Count

Default 10

Response

application/json

{
  "items": [
    { … }
  ],
  "next": "us-west",
  "count": 1,
  "total": 10
}

Get Recent Services

Request

Get data to populate Recent Services

Security

bearerAuth

Query

nextstring(Pagination Cursor)

Specifies the start-id for the next page of recent services.

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

limitinteger(Pagination Limit)[ 1 .. 2000 ]

Number of entries per page

Default 100

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_nbapi/service-catalog/v1beta1/recent-services \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

itemsArray of objects(RecentService)required

Service offer with provisions and last accessed timestamp

items[].idstring(id)required

Service Offer identifier

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

items[].typestring(type)required

Resource Type

Example: "/service-catalog/recent-service"

items[].serviceOfferobject(ServiceOfferPartialDetails)required

Partial details for a service offer

items[].serviceOffer.idstring(serviceOfferId)required

Identifier of service offer

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

items[].serviceOffer.resourceUristring(resourceUri)required

Resource URI

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

items[].serviceOffer.namestring(name)required

Name of the Service Offer. In case of an app-provision, name of service-manager will be picked. If absent, name of app will be picked.

Example: "Aruba Central"

items[].serviceOffer.categoriesArray of strings(Category)required

Types of categories

Items Enum"COMPUTE""NETWORKING""STORAGE"

Example: ["NETWORKING"]

items[].serviceOffer.slugstring(slug)required

Short identifier for a service offer. In case of an app-provision, slug will be picked from service-manager. If absent, slug will be picked from application.

Example: "CENTRAL"

items[].serviceOffer.staticLaunchUrlstring(staticLaunchUrl)required

Relative URLs to launch

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

items[].serviceOffer.workspaceTypesArray of strings(workspaceTypes)required

Workspace Types supported

Items Enum"BASIC_ORGANIZATION""STANDALONE""MSP"

Example: ["STANDALONE","MSP"]

items[].serviceOffer.workspaceOpModesArray of strings(workspaceOpModes)required

Types of Workspace Operational Modes for Tenant Workspaces

Items Enum"CUSTOMER_OWNED_INVENTORY""MSP_OWNED_INVENTORY""ALL"

Example: ["MSP_OWNED_INVENTORY"]

items[].lastAccessedTimestring(date-time)(lastAccessedTime)

Most recent date and time at which service offer was launched

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

items[].regionalProvisionsArray of objects(regionalProvisions)

nextstring(next)required

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

countinteger(count)required

Count Per Page

Default 1

totalinteger(total)required

Total Count

Default 10

Response

application/json

{
  "items": [
    { … }
  ],
  "next": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "count": 1,
  "total": 10
}

Get Recent Services

Request

Get data to populate Recent Services V2

Security

bearerAuth

Query

nextstring(Pagination Cursor)

Specifies the start-id for the next page of recent services.

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

limitinteger(Pagination Limit)[ 1 .. 2000 ]

Number of entries per page

Default 100

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_nbapi/service-catalog/v1beta2/recent-services \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

itemsArray of objects(RecentService)required

Service offer with provisions and last accessed timestamp

items[].idstring(id)required

Id of service-manager-provision entry or service-provision entry

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

items[].typestring(type)required

Resource Type

Example: "/service-catalog/recent-service"

items[].regionobject(Region)required

items[].region.idstring(id)

The code name for a geographical region supported by the HPE GreenLake cloud.

Example: "us-east"

items[].region.typestring(type)

The resource type identifier for the region.

Example: "/service-catalog/region"

items[].region.namestring(name)

The human-readable name for the geographical region.

Example: "US East"

items[].lastAccessedTimestring(date-time)(lastAccessedTime)required

Most recent date and time at which service was launched

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

items[].serviceOfferobject(ServiceOfferPartialInfo)required

Service offer abraged information. Typically used when only available service-offers in a workspace are to be reported.

items[].serviceOffer.idstring(serviceOfferId)required

Identifier of service offer

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

items[].serviceOffer.resourceUristring(resourceUri)required

Resource URI

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

items[].serviceOffer.namestring(name)required

Name of the Service Offer. In case of an app-provision, name of service-manager will be picked. If absent, name of app will be picked.

Example: "Aruba Central"

items[].serviceOffer.categoriesArray of strings(Category)required

Types of categories

Items Enum"COMPUTE""NETWORKING""STORAGE"

Example: ["NETWORKING"]

items[].serviceOffer.slugstring(slug)required

Short identifier for a service offer. In case of an app-provision, slug will be picked from service-manager. If absent, slug will be picked from application.

Example: "CENTRAL"

items[].serviceOffer.staticLaunchUrlstring(staticLaunchUrl)required

Relative URLs to launch

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

items[].serviceOffer.serviceManagerobject(ServiceManagerResourceLink)

items[].serviceManagerProvisionobject(ServiceManagerProvisionPartialInfo)

Service manager provision abraged information. Typically used when only fully provisioned entries are needed.

items[].serviceProvisionobject(ServiceProvisionPartialInfo)

Service provision abraged information. Typically used when only fully provisioned entries are needed.

nextstring(next)required

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

countinteger(count)required

Count Per Page

Default 1

totalinteger(total)required

Total Count

Default 10

Response

application/json

{
  "items": [
    { … }
  ],
  "next": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "count": 1,
  "total": 10
}

Service offer management (v1beta1)

Service offers

Service offer regions

UI Management

Get Service Offers for Catalog

Request

Responses

Was this helpful?

Get Featured Service Offers

Request

Responses

Was this helpful?

Get Service Offer Details

Request

Responses

Was this helpful?

Get My Services

Request

Responses

Was this helpful?

Get Recent Services

Request

Responses

Was this helpful?

Get Recent Services

Request

Responses

Was this helpful?