HPE GreenLake for Object Storage offers RESTful APIs for Object Storage, enabling management and configuration of buckets, users, and group and access policies.
Endpoints are the host URLs that you submit your API requests to. Object Storage has unique endpoints in specific regions. Use the following list to identify your application endpoint.
- US West: https://us-west.api.greenlake.hpe.com
- EU West : https://eu-west.api.greenlake.hpe.com
- EU Central: https://eu-central.api.greenlake.hpe.com
- AP NorthEast: https://ap-northeast.api.greenlake.hpe.com
The Object Storage API uses an access token for authentication. Instructions for obtaining an access token can be found on the Authentication page.
The HTTP Authorization request header is used to provide the access token in all API requests as a Bearer token.
Authorization:Bearer <access token>
All API requests are authorized using permissions. The user owning the access token must have the required permissions assigned for the resources being accessed in order to be authorized. The required permissions are documented in the following guide pages.
To use the HPE GreenLake Object Storage API, you need appropriate permissions based on your role:
object-storage.bucket.readfor allGETandLISTrequests on bucket resourcesobject-storage.bucket.createfor allPOSTrequests on bucket resourcesobject-storage.bucket.updatefor allPUTrequests on bucket resourcesobject-storage.bucket.deletefor allDELETErequests on bucket resourcesobject-storage.object-user.readfor allGETandLISTrequests for user resourcesobject-storage.object-user.createfor allPOSTrequests for user resourcesobject-storage.object-user.updatefor allPUTrequests for user resourcesobject-storage.object-user.deletefor allDELETErequests for user resourcesobject-storage.object-group.readfor allGETandLISTrequests for group resourcesobject-storage.object-group.createfor allPOSTrequests for group resourcesobject-storage.object-group.updatefor allPUTrequests for group resourcesobject-storage.object-group.deletefor allDELETErequests for group resourcesobject-storage.object-access-policy.readfor allGETandLISTrequests for access policy resourcesobject-storage.object-access-policy.createfor allPOSTrequests for access policy resourcesobject-storage.object-access-policy.updatefor allPUTrequests for access policy resourcesobject-storage.object-access-policy.deletefor allDELETErequests for access policy resources
For more information about roles and permissions, see the HPE GreenLake Cloud User Guide.
The Object Storage APIs are broadly categorized into the following feature areas:
- Create, list, update and delete object storage buckets
- Configure bucket properties including versioning, object locking, and lifecycle policies
- Report bucket capacity and performance
- Manage bucket metadata
- Manage bucket access control lists (ACLs)
- Manage users and user groups
For asynchronous operations that return HTTP status 201 or 202, use the Location header in the API response to track progress.
Replace the base URL in examples with the endpoint for your region.
Create a bucket on an HPE Alletra Storage MP X10000 device. Provide name, optional bucketTags (array of key/value pairs), and compression (example: DISABLED). Replace {systemId} with your system identifier.
POST https://us-west.api.greenlake.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/{systemId}/bucketsPayload:
{
"name": "myBucketName",
"compression": "DISABLED",
"bucketTags": [
{
"key": "location",
"value": ""
}
],
"versioning": "ENABLED",
"objectLockConfiguration": {
"objectLockEnabled": "ENABLED",
"rule": {
"defaultRetention": {
"days": 1,
"mode": "GOVERNANCE",
"years": 1
}
}
},
"notificationService": "DISABLED",
"notificationServiceConfiguration": {}
}The endpoint https://us-west.api.greenlake.hpe.com is the endpoint for the US West application. If you are using HPE GreenLake for Object Storage in a different region, replace the endpoint with the endpoint the corresponding region.
Retrieve the list of buckets for the specified HPE Alletra Storage MP X10000 device. Replace {systemId} with your system identifier.
GET https://us-west.api.greenlake.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/{systemId}/bucketsDelete the specified bucket on the given HPE Alletra Storage MP X10000 device. Replace {systemId} and {bucketId} with actual IDs.
DELETE https://us-west.api.greenlake.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/{systemId}/buckets/{bucketId}Create a user on an HPE Alletra Storage MP X10000 device. Provide the username in the payload. Replace {systemId} with your system identifier.
POST https://us-west.api.greenlake.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/{systemId}/usersPayload:
{
"name": "NewUser"
}Retrieve the list of users for the specified HPE Alletra Storage MP X10000 device. Replace {systemId} with your system identifier.
GET https://us-west.api.greenlake.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/{systemId}/usersDelete the specified user from the given HPE Alletra Storage MP X10000 device. Replace {systemId} and {userId} with actual IDs.
DELETE https://us-west.api.greenlake.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/{systemId}/users/{userId}Create a group on an HPE Alletra Storage MP X10000 device. Provide group name and optional users array (member names). Replace {systemId} with your system identifier.
POST https://us-west.api.greenlake.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/{systemId}/groupsPayload:
{
"name": "NewGroup1",
"users": [
"MyUser"
]
}Retrieve the list of groups for the specified HPE Alletra Storage MP X10000 device. Replace {systemId} with your system identifier.
GET https://us-west.api.greenlake.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/{systemId}/groupsDelete the specified group on the given HPE Alletra Storage MP X10000 device. Replace {systemId} and {groupId} with actual IDs.
DELETE https://us-west.api.greenlake.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/{systemId}/groups/{groupId}