Skip to content
Internal API Catalog
/
Data Services API
/
API reference
/
storage-locations

Data Services API (1.3.0)

Data Services API

Download OpenAPI description
data-services-api.json
data-services-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services-api/

https://us-west.api.greenlake.hpe.com/

https://eu-west.api.greenlake.hpe.com/

https://eu-central.api.greenlake.hpe.com/

https://ap-northeast.api.greenlake.hpe.com/

async-operations

Async Operations API

Operations

dual-auth-operations

Dual Authorization API

Operations

issues

Issues API

Operations

secret-assignments

Secret Assignment Management APIs

Operations

secrets

Secret Management APIs

Operations

settings

Settings API

Operations

software-releases

Software Releases

Operations

storage-locations

storage-locations API.

Operations

List storage locations

Request

Returns a list of enabled storage locations. The following parameters are supported to reduce the collection according to the specified criteria:

  • filtering locations by capabilities;
Security
bearer
Query
filterstring<= 1000 characters

The expression to use for filtering responses.

The filter expression for this endpoint accepts the following operators on the following properties:

  • in operator on the capabilities property;

For example:

  • 'backup-and-recovery' in capabilities;

Grouping of expressions to change the evaluation precedence is NOT supported.

Example: filter='backup-and-recovery' in capabilities 
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services-api/data-services/v1beta1/storage-locations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A list of storage locations.

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(StorageLocation)required

The storage locations returned by the query.

items[].​idstringrequired

An identifier for the resource.

items[].​namestringrequired

A system specified name for the resource.

items[].​cloudServiceProviderstringrequired

The Cloud Service Provider (CSP) of the location.

Enum"AWS""AZURE""GCP"
items[].​cloudServiceProviderIdstringrequired

The Cloud Service Provider (CSP) ID.

items[].​geographystringrequired

The geographical location of the storage location.

Enum"North America""Europe""Asia Pacific"
items[].​citystringrequired

The city the storage location is in.

items[].​timezonestringrequired

The Timezone of the location as defined by the local standard time (non summer time) offset from UTC.

items[].​capabilitiesArray of stringsrequired

The list of features that support the storage location.

items[].​typestringrequired

The type of resource.

items[].​generationinteger(int64)required

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

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

The 'self' reference for this resource.

totalinteger

Total number of items matching the filter parameter in the request.

Response
application/json
{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

tags

Tags APIs

Operations