Skip to content
/encryption

HPE Greenlake For Storage Fleet REST APIs (1.0.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-latest/v1/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

Encryption Backup Action on HPE Alletra Storage MP B10000 identified by {systemId}

Request

Encryption Backup Action on HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Bodyapplication/jsonrequired
parametersobject(DeviceType4EncryptionBackupRekeyRestoreParams)
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1/devtype4-storage-systems/7CE751P312/encryption/backup \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

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

Bodyapplication/json
responsestringrequired

Encryption response

Example: "Encryption Key"
Response
application/json
{
  "response": "Encryption Key"
}

Check EKM configuration on HPE Alletra Storage MP B10000 identified by {systemId}

Request

Check EKM configuration on HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1/devtype4-storage-systems/7CE751P312/encryption/checkekm \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
responsestringrequired

Check EKM Config response

Example: "EKM settings are correct"
Response
application/json
{
  "response": "EKM settings are correct"
}

Encryption Enable Action on HPE Alletra Storage MP B10000 identified by {systemId}

Request

Encryption Enable Action on HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Bodyapplication/jsonrequired
parametersobject(DeviceType4EncryptionParams)
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1/devtype4-storage-systems/7CE751P312/encryption/enable \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

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

Bodyapplication/json
responsestringrequired

Encryption response

Example: "Encryption Key"
Response
application/json
{
  "response": "Encryption Key"
}

Encryption Rekey Action on HPE Alletra Storage MP B10000 identified by {systemId}

Request

Encryption Rekey Action on HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Bodyapplication/jsonrequired
parametersobject(DeviceType4EncryptionBackupRekeyRestoreParams)
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1/devtype4-storage-systems/7CE751P312/encryption/rekey \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

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

Bodyapplication/json
responsestringrequired

Encryption response

Example: "Encryption Key"
Response
application/json
{
  "response": "Encryption Key"
}

Encryption Restore Action on HPE Alletra Storage MP B10000 identified by {systemId}

Request

Encryption Restore Action on HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Bodyapplication/jsonrequired
keystring

Encryption key.

Example: "key"
parametersobject(DeviceType4EncryptionBackupRekeyRestoreParams)
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1/devtype4-storage-systems/7CE751P312/encryption/restore \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

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

Set EKM configuration on HPE Alletra Storage MP B10000 identified by {systemId}

Request

Set EKM configuration on HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Bodyapplication/jsonrequired
parametersobject(DeviceType4SetEKMConfigParams)
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1/devtype4-storage-systems/7CE751P312/encryption/setekm \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

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

Set EKM configuration and Encryption Backup Action on HPE Alletra Storage MP B10000 identified by {systemId}

Request

Set EKM configuration and Encryption Backup Action on HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Bodyapplication/jsonrequired
parametersobject(DeviceType4SetEKMBackupConfigParams)
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1/devtype4-storage-systems/7CE751P312/encryption/setekm-backup \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

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

Bodyapplication/json
responsestringrequired

Encryption response

Example: "Encryption Key"
Response
application/json
{
  "response": "Encryption Key"
}

jbofioms

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

Operations

migrations

The Migrations API allows the management of data migration from source storage systems.

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

vvolscs

Operations