Skip to content
/system-settings

HPE Greenlake For Storage Fleet REST APIs (1.2.0)

HPE Greenlake For Storage Fleet REST APIs

Download OpenAPI description
storage-fleet-api.json
storage-fleet-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers

https://eu1.data.cloud.hpe.com/

https://us1.data.cloud.hpe.com/

https://jp1.data.cloud.hpe.com/

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/storage-fleet/public/openapi/storage-fleet-public-v1alpha1/storage-fleet-api/

certificates

The Certificate API provides endpoints for managing and configuring certificates.

Operations

controllers

The controllers API allows the management of controller fleet.

Operations

enclosures

The Enclosure API provides endpoints for managing and configuring enclosures.

Operations

encryption

The encryption API allows the actions on encryption.

Operations

jbofioms

The JBOF IOM API provides endpoints for managing and configuring JBOF IOMs.

Operations

object-notification-clients

The Object Notification Client API provides endpoints for managing and configuring object notification clients.

Operations

ports

The ports API allows the management of ports.

Operations

shelves

The shelves API allows the management of shelves.

Operations

storage-nodes

The Storage Node API provides endpoints for managing and configuring storage nodes.

Operations

storage-systems

The storage-systems API allows the management of storage device.

Operations

switches

The Switch API provides endpoints for managing and configuring switches.

Operations

system-settings

The System Settings API allows the monitoring of System settings for the device.

Operations

Get alert-contact details for an HPE Alletra Storage MP B10000 storage system

Request

Get alert-contact details for an HPE Alletra Storage MP B10000 storage system

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Query
limitinteger[ 0 .. 5000 ]

Number of items to return at a time

Default 100
Example: limit=10
offsetinteger[ 0 .. 100000 ]

The offset of the first item in the collection to return

Default 0
Example: offset=5
selectstring

Query to select only the required parameters, separated by . if nested

Example: select=id
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/alert-contacts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects or null(DeviceType4AlertContactsDetails)required
items[].​idstringrequired

Unique Identifier of the contact

Example: "67d09515-8526-9b02-c0c4-c1f443a39402"
items[].​typestringrequired

The type of resource

Example: "alert-contacts"
items[].​companystring or null

Company

Example: "HPE"
items[].​companyCodestring or null

Company code

Example: "HPE"
items[].​countrystring or null

Country

Example: "US"
items[].​customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1sd"
items[].​faxstring or null

Fax number

Example: "+1 323 555 1234"
items[].​firstNamestring or null

First name

Example: "john"
items[].​generationinteger(int64)

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.

Example: 1627540907421
items[].​includeSvcAlertsboolean or null

Email sent to contact shall include service alert

Example: false
items[].​lastNamestring or null

Last name

Example: "kevin"
items[].​notificationSeveritiesArray of integers or null

Severities of notifications the contact will be notificated. An array of number: 0 - Fatal, 1 - Critical, 2 - Major, 3 - Minor, 4 - Degraded, 5 - Info, 6 - Debug

Example: [0,1,2,3,4,5]
items[].​preferredLanguagestring or null

Preferred language when being contacted or emailed

Example: "en"
items[].​primaryEmailstring or null

Primary email address

Example: "kevin.john@hpe.com"
items[].​primaryPhonestring or null

Primary phone

Example: "98783456"
items[].​receiveGroupedboolean or null

Contact will receive grouped low urgency email notifications

Example: true
items[].​secondaryEmailstring or null

Secondary email address

Example: "winny.pooh@hpe.com"
items[].​secondaryPhonestring or null

Secondary phone

Example: "23456789"
items[].​systemIdstring or null

SystemId/serialNumber of the array.

Example: "7CE751P312"
items[].​systemSupportContactboolean or null

Contact will be called for any system issues

Example: false
totalinteger

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

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

Add Alert/Mail contact details

Request

Add Alert/Mail contact details

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Bodyapplication/jsonrequired
companystring or null

Company

Example: "HPE"
companyCodestring or null

Company code

Example: "HPE"
countrystring or null

Country

Example: "US"
faxstring or null

Fax number

Example: "fax_id"
firstNamestring or null

First name

Example: "john"
includeSvcAlertsboolean or null

Email sent to contact shall include service alert

Example: false
lastNamestring or null

Last name

Example: "kevin"
notificationSeveritiesArray of integers or null

Severities of notifications the contact will be notificated. An array of number: 0 - Fatal, 1 - Critical, 2 - Major, 3 - Minor, 4 - Degraded, 5 - Info, 6 - Debug

Example: [0,1,2,3,4,5]
preferredLanguagestring or null

Preferred language when being contacted or emailed

Example: "en"
primaryEmailstring or null

Primary email address

Example: "kevin.john@hpe.com"
primaryPhonestring or null

Primary phone

Example: "98783456"
receiveGroupedboolean or null

Contact will receive grouped low urgency email notifications

Example: true
secondaryEmailstring or null

Secondary email address

Example: "winny.pooh@hpe.com"
secondaryPhonestring or null

Secondary phone

Example: "23456789"
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/alert-contacts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Created

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
application/json
{
  "message": "Successfully submitted",
  "status": "SUBMITTED",
  "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete Alert/Email contact for HPE Alletra Storage MP B10000 storage system identified by {id}

Request

Delete Alert/Email contact for HPE Alletra Storage MP B10000 storage system identified by {id}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

Unique Identifier of the alert contact

Example: a4c78226-69cd-b9e7-af3e-445ca8f8a655
curl -i -X DELETE \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/alert-contacts/a4c78226-69cd-b9e7-af3e-445ca8f8a655 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
application/json
{
  "message": "Successfully submitted",
  "status": "SUBMITTED",
  "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

vvolscs

Operations