Skip to content
/access-policies

Object Storage REST APIs. (1.0.0)

Object Storage REST APIs.

Download OpenAPI description
object-storage-api.json
object-storage-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/object-storage/public/openapi/object-storage-public-v1alpha1/object-storage-api/

access-policies

The Access Policies API provides endpoints for creating, managing, and configuring access policies.

Operations

Get all access policies for HPE Alletra Storage MP X10000 ObjectStore

Request

Retrieves all access policies associated with the HPE Alletra Storage MP X10000 ObjectStore identified by {systemId}. The response can be filtered, sorted, and paginated using query parameters.

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
Query
filterstring

oData query to filter bucket by Key.

Example: filter=id eq "abc"
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

A query to retrieve only the specified parameters. Use . to denote nested fields.

Example: select=id
sortstring

A list of properties defining the sort order. This takes a single property name followed by the direction to sort in, separated by a space. The supported properties are id, systemUid and generation. If not specified, the default behaviour is to sort by generation. The supported directions are asc and desc for ascending and descending respectively.

Default "generation desc"
Example: sort=id desc
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/access-policies \
  -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(AccessPolicy)required
items[].​idstringrequired

policy ID

Example: "123456"
items[].​typestringrequired

Type of resource

Example: "access-policy"
items[].​commonResourceAttributesobject or null(CommonResourceAttributes)
items[].​customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1sd"
items[].​generationinteger(Uint64)
items[].​namestring

Name of the policy

Example: "testPolicy"
items[].​statementArray of objects(PolicyStatement)
items[].​systemUidstring

Cluster ID

Example: "2FF70002AC0263D0"
items[].​versionstring

Version of the policy

Example: "2012-10-17"
totalinteger

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

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

Create new access policy for HPE Alletra Storage MP X10000 ObjectStore

Request

Create new access policy for HPE Alletra Storage MP X10000 ObjectStore identified by {systemId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
Bodyapplication/json
namestringrequired

Name of the Access Policy to be created

Example: "NewAccessPolicy1"
versionstringrequired

Access policy version

Example: "2012-10-17"
statementArray of objects(PolicyStatementInput)required
statement[].​resourceArray of strings or stringrequired
One of:
string
statement[].​actionArray of stringsrequired
statement[].​effectstringrequired
Enum"ALLOW""DENY"
Example: "ALLOW"
statement[].​conditionobject
statement[].​sidstring
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/access-policies \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "NewAccessPolicy1",
    "statement": [
      {
        "action": [
          "string"
        ],
        "effect": "ALLOW",
        "resource": [
          "string"
        ]
      }
    ],
    "version": "2012-10-17"
  }'

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 HPE Alletra Storage MP X10000 ObjectStore access policy

Request

Delete HPE Alletra Storage MP X10000 ObjectStore access policy identified by {policyId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
policyIdstringrequired

A unique identifier assigned to each access policy created in the ObjectStore

Example: policy1
curl -i -X DELETE \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/access-policies/policy1 \
  -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 single HPE Alletra Storage MP X10000 ObjectStore access policy

Request

Get HPE Alletra Storage MP X10000 ObjectStore access policy identified by {policyId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
policyIdstringrequired

A unique identifier assigned to each access policy created in the ObjectStore

Example: policy1
Query
selectstring

A query to retrieve only the specified parameters. Use . to denote nested fields.

Example: select=id
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/access-policies/policy1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

policy ID

Example: "123456"
typestringrequired

Type of resource

Example: "access-policy"
commonResourceAttributesobject or null(CommonResourceAttributes)
customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1sd"
generationinteger(Uint64)
namestring

Name of the policy

Example: "testPolicy"
statementArray of objects(PolicyStatement)
systemUidstring

Cluster ID

Example: "2FF70002AC0263D0"
versionstring

Version of the policy

Example: "2012-10-17"
Response
application/json
{
  "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."
  },
  "customerId": "fc5f41652a53497e88cdcebc715cc1sd",
  "generation": 0,
  "id": "123456",
  "name": "testPolicy",
  "statement": [
    { … }
  ],
  "systemUid": "2FF70002AC0263D0",
  "type": "access-policy",
  "version": "2012-10-17"
}

Update HPE Alletra Storage MP X10000 ObjectStore access policy

Request

Update HPE Alletra Storage MP X10000 ObjectStore access policy identified by {policyId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
policyIdstringrequired

A unique identifier assigned to each access policy created in the ObjectStore

Example: policy1
Bodyapplication/jsonrequired
versionstringrequired

Access policy version

Example: "2012-10-17"
statementArray of objects(PolicyStatementInput)required
statement[].​resourceArray of strings or stringrequired
One of:
string
statement[].​actionArray of stringsrequired
statement[].​effectstringrequired
Enum"ALLOW""DENY"
Example: "ALLOW"
statement[].​conditionobject
statement[].​sidstring
curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/access-policies/policy1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "statement": [
      {
        "action": [
          "string"
        ],
        "effect": "ALLOW",
        "resource": [
          "string"
        ]
      }
    ],
    "version": "2012-10-17"
  }'

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

Apply policy to existing user or group in HPE Alletra Storage MP X10000 ObjectStore

Request

Apply policy to existing user or group in HPE Alletra Storage MP X10000 ObjectStore identified by {systemId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
Bodyapplication/jsonrequired
namestringrequired

Name of the user or group

Example: "NewAccessPolicy1"
typestringrequired

user or group

Enum"USER""GROUP"
policiesArray of stringsrequired

List of policies to apply

curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/apply-policy \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "NewAccessPolicy1",
    "policies": [
      "string"
    ],
    "type": "USER"
  }'

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

buckets

The Buckets API provides endpoints for creating, managing, and configuring storage buckets. Buckets are containers for organizing and storing data, and this API allows full control over their lifecycle, including creation, updates, retrieval, and deletion.

Operations

groups

The Groups API provides endpoints for creating, managing, and configuring groups.

Operations

users

The Users API provides endpoints for creating, managing, and configuring users.

Operations