Skip to content
Internal API Catalog
/
Service offer management
/
Service offer regions

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

Languages
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

Service offer regions

Operations

Get service offer regions

Request

Retrieve a list of service offer regions by applying filters. Each service offer region represents a service offer provisioned in a specific region.

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 offer regions.

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: serviceOfferId, status, and region.
Supported operand: eq
Supported operations: and

Examples:

Return service offer regions with a given service offer ID

Return service offer regions with a given region

Return service offer regions with a given status

Return service offer regions with a given service offer ID and region

Return service offer regions with a given service offer ID and status

Return service offer regions with a given service offer ID and status and region

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-offer-regions \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful Response

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

The unique identifier for the service offer region.

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
items[].​typestring(type)required

The type of the resource.

Example: "/service-catalog/service-offer-region"
items[].​regionstring(region)required

The code name of the region where this service offer is available.

Example: "us-east"
items[].​statusstring(ServiceOfferStatus)required

The current status of the service offer.

Enum"ONBOARDING""ONBOARDED""PUBLISHED"
Example: "ONBOARDED"
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[].​updatedAtstring(date-time)(updatedAt)required

Date and time at which the service offer was updated.

Example: "2021-04-29T10:20:30.400+02:30"
items[].​generationinteger(int64)(generation)required

A monotonically increasing update counter.

Example: "1"
items[].​resourceUristring(resourceUri)

The URI reference to this resource.

Example: "/service-catalog/v1beta1/service-offer-regions/3fa85f64-5717-4562-b3fc-2c963f66afa6"
items[].​serviceOfferobject(ServiceOfferResourceLink)

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.

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

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 service offer region

Request

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

Security
bearerAuth
Path
idstring(uuid)(id)required

The unique service offer region 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/service-offer-regions/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 region.

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
typestring(type)required

The type of the resource.

Example: "/service-catalog/service-offer-region"
regionstring(region)required

The code name of the region where this service offer is available.

Example: "us-east"
statusstring(ServiceOfferStatus)required

The current status of the service offer.

Enum"ONBOARDING""ONBOARDED""PUBLISHED"
Example: "ONBOARDED"
createdAtstring(date-time)(createdAt)required

Date and time at which the service offer was created.

Example: "2021-04-23T10:20:30.400+02:30"
updatedAtstring(date-time)(updatedAt)required

Date and time at which the service offer was updated.

Example: "2021-04-29T10:20:30.400+02:30"
generationinteger(int64)(generation)required

A monotonically increasing update counter.

Example: "1"
resourceUristring(resourceUri)

The URI reference to this resource.

Example: "/service-catalog/v1beta1/service-offer-regions/3fa85f64-5717-4562-b3fc-2c963f66afa6"
serviceOfferobject(ServiceOfferResourceLink)

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.

Response
application/json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "/service-catalog/service-offer-region",
  "resourceUri": "/service-catalog/v1beta1/service-offer-regions/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "serviceOffer": {
    "id": "4ab85f64-5717-4562-b3fc-2c963f66afa6",
    "resourceUri": "/service-catalog/v1beta1/service-offers/4ab85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "region": "us-east",
  "status": "ONBOARDED",
  "createdAt": "2021-04-23T10:20:30.400+02:30",
  "updatedAt": "2021-04-29T10:20:30.400+02:30",
  "generation": "1"
}

UI Management

Operations