Skip to content
/
object-notification-clien...

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

Get all Object Notification Client config for HPE Alletra Storage MP X10000 system identified by {systemId}

Request

Get all Object Notification Client config for HPE Alletra Storage MP X10000 system identified by {systemId}

Security
bearer
Path
systemIdstringrequired

ID of the Storage system

Example: USE603C8P1
Query
selectstring

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

Example: select=id
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
filterstring

Lucene query to filter systems by Key.

Example: filter=NAME eq g1a1
sortstring

Lucene query to sort systems by Key.

Example: sort=name desc
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/USE603C8P1/object-notification-clients \
  -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(MessageBrokerConfigDetailsListAttributes)required
items[].​idstringrequired

Unique identifier for the Storage system.Filter, Sort

Example: "ASHBFY6567YGHJ"
items[].​typestringrequired

type

Example: "string"
items[].​apiVersionstring or null

API version Details.

Example: "sc.hpe.com/v1"
items[].​associatedBucketsArray of objects or null or null(associatedBuckets)

Associated Bucket detail for Storage system Object Notification Clients.

items[].​associatedLinksArray of objects or null or null(homefleetAssociatedLinks)
items[].​commonResourceAttributesobject or null(commonResourceAttrs)
items[].​customerIdstring or null

CustomerID for the Storage system.Filter, Sort

Example: "ASHBFDJHFB6567YGHJ"
items[].​generationinteger or null(int64)

The most recent specification that has been observed by the controller. Filter, Sort

Example: 1690045300
items[].​kindstring or null

Kind of the resource

Example: "smtpSettings"
items[].​resourceUristring or null(homefleetResourceUri)
items[].​statusobject or null(brokerDetails)
items[].​systemIdstring or null

Identifier of the Storage system. Filter, Sort

Example: "USE603C8P1"
totalinteger

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

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

Add Object Notification Client settings of HPE Alletra Storage MP X10000 system identified by {systemId}

Request

Add Object Notification Client settings of HPE Alletra Storage MP X10000 system identified by {systemId}

Security
bearer
Path
systemIdstringrequired

ID of the Storage system

Example: USE603C8P1
Bodyapplication/jsonrequired
identifierstring or nullrequired

Unique identifier to represent endpoint configuration.

Example: "kafka_buckets_fianance_topic_endpoint"
hostsArray of strings or nullrequired

List of broker endpoints.

authnTypestring or nullrequired

User should specify authentication mechanism to use.

Value"SASL"
Example: "SASL"
tlsboolean or nullrequired

User should specify 'true' to enable TLS connectivity to the Kafka broker(s).

Example: true
clientCertstring or null

Client certificate.

Example: "Certificate"
clientTypestring or null

ClientType of broker. Possible values are Producer or Consumer.

Example: "Producer"
commentstring or null

A comment to associate with the configuration.

Example: "Comment"
queueLimitinteger or null(int64)

Specify the maximum limit for undelivered event messages for a bucket

Example: 1000
saslMechanismstring or null

SASL mechanism to use for authenticating to the Kafka broker(s).

Enum"PLAIN""SHA256""SHA512"
Example: "PLAIN"
saslPasswordstring or null

Password for SASL authentication.

Example: "passwrf"
saslUsernamestring or null

User name for SASL authentication.

Example: "kafka_admin_x"
trustStorestring or null

TrustStore certificate.

Example: "Certificate"
typestring or null

Type of broker. We will support only Kafka for now.

Example: "Kafka"
verifyPeerboolean or null

Verify Peer.

Example: true
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/USE603C8P1/object-notification-clients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "authnType": "SASL",
    "hosts": [
      "string"
    ],
    "identifier": "kafka_buckets_fianance_topic_endpoint",
    "tls": true
  }'

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"
}

Delete Object Notification Client settings of HPE Alletra Storage MP X10000 system identified by {clientId}

Request

Edit Object Notification Client settings of HPE Alletra Storage MP X10000 system identified by {clientId}

Security
bearer
Path
systemIdstringrequired

ID of the Storage system

Example: USE603C8P1
clientIdstringrequired

ID of the Object Notification Client

Example: dummyId
curl -i -X DELETE \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/USE603C8P1/object-notification-clients/dummyId \
  -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"
}

Get Object Notification Client config for HPE Alletra Storage MP X10000 system identified by {clientId}

Request

Get Object Notification Client config for HPE Alletra Storage MP X10000 system identified by {clientId}

Security
bearer
Path
systemIdstringrequired

ID of the Storage system

Example: USE603C8P1
clientIdstringrequired

ID of the Object Notification Client

Example: dummyId
Query
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/devtype7-storage-systems/USE603C8P1/object-notification-clients/dummyId \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
object or null(MessageBrokerConfigDetails)
Response
application/json
{
  "customerId": "ASHBFDJHFB6567YGHJ",
  "generation": 1690045300,
  "id": "ASHBFY6567YGHJ",
  "status": {
    "config": { … },
    "name": "kafka_buckets_fianance_topic_endpoint",
    "lastModifiedTime": "2025-03-18T20:52:30Z",
    "observedGeneration": 1234,
    "ready": true
  },
  "systemId": "USE603C8P1",
  "apiVersion": "sc.hpe.com/v1",
  "associatedBuckets": [
    { … }
  ],
  "associatedLinks": [
    { … }
  ],
  "commonResourceAttributes": {
    "cloudState": "CONNECTED",
    "errCode": "E01",
    "errMessage": "This storage system is not actively monitored in the cloud portal. Data Services Cloud Console proactively disabled monitoring and management of storage system with serial number {systemId} for sending excessive cloud events or for not responding to requests."
  },
  "kind": "smtpSettings",
  "resourceUri": "/storage-fleet/v1alpha1/devtype7-storage-systems/4UN042PTDW",
  "type": "string"
}

Edit Object Notification Client settings of HPE Alletra Storage MP X10000 system identified by {clientId}

Request

Edit Object Notification Client settings of HPE Alletra Storage MP X10000 system identified by {clientId}

Security
bearer
Path
systemIdstringrequired

ID of the Storage system

Example: USE603C8P1
clientIdstringrequired

ID of the Object Notification Client

Example: dummyId
Bodyapplication/jsonrequired
hostsArray of strings or nullrequired

List of broker endpoints.

authnTypestring or nullrequired

User should specify authentication mechanism to use.

Value"SASL"
Example: "SASL"
tlsboolean or nullrequired

User should specify 'true' to enable TLS connectivity to the Kafka broker(s).

Example: true
clientCertstring or null

Client certificate.

Example: "Certificate"
clientTypestring or null

Type of notification client. Values can be either Producer or Consumer.

Example: "Producer"
commentstring or null

A comment to associate with the configuration.

Example: "Comment"
queueLimitinteger or null(int64)

Specify the maximum limit for undelivered event messages for a bucket

Example: 1000
saslMechanismstring or null

SASL mechanism to use for authenticating to the Kafka broker(s).

Enum"PLAIN""SHA256""SHA512"
Example: "PLAIN"
saslPasswordstring or null

Password for SASL authentication.

Example: "passwrf"
saslUsernamestring or null

User name for SASL authentication.

Example: "kafka_admin_x"
trustStorestring or null

Trust Store

Example: "Certificate"
typestring or null

Type of broker. We will support only Kafka for now.

Example: "Kafka"
verifyPeerboolean or null

Trust server TLS verification.

Example: true
curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/USE603C8P1/object-notification-clients/dummyId \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "authnType": "SASL",
    "hosts": [
      "string"
    ],
    "tls": true
  }'

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"
}

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

vvolscs

Operations