Skip to content
Internal API Catalog
/
Backup and Recovery API
/
API reference
/
v1beta1
/
volume-protection-groups

Backup and Recovery API (1.1.0)

Backup and Recovery API

Download OpenAPI description
backup-recovery-api.json
backup-recovery-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery-api/

https://us-west.api.greenlake.hpe.com/

https://eu-west.api.greenlake.hpe.com/

https://eu-central.api.greenlake.hpe.com/

https://ap-northeast.api.greenlake.hpe.com/

Protection Store Gateway

Protection Store Gateway APIs

Operations

StoreOnce

StoreOnce APIs

Operations

application-hosts

The Application Hosts API allows the registration and management of Application Hosts.

Operations

data-orchestrators

APIs for managing Data Orchestrator operations.

Operations

datastores

The datastores API allows the data management operations on datastores.

Operations

mssql-database-backups

The MSSQL database backups API allows the creation and management of MSSQL database backups.

Operations

mssql-database-protection-groups

The MSSQL database Protection Groups API allows management of MSSQL database Protection Groups.

Operations

mssql-database-snapshots

The MSSQL database snapshots API allows the creation and management of MSSQL database snapshots.

Operations

mssql-databases

The MSSQL Databases API allows management of MSSQL databases.

Operations

mssql-instances

The MSSQL Instances API allows management of MSSQL instances.

Operations

protection-jobs

The Protection Jobs API allows the creation and management of Protection Jobs.

Operations

protection-policies

The Protection Policies API allows the creation and management of Protection Policies.

Operations

protection-stores

This API allows the creation and management of Protection Stores that represents the backup target for the copies.

Operations

virtual-machine-protection-groups

The virtual machine Protection Groups API allows the creation and management of virtual machine Protection Groups (Group of Virtual Machines, Datastores or Folder for Protection).

Operations

virtual-machines

The virtual machines API allows the data management operations on virtual machines.

Operations

volume-protection-groups

The Volume Protection Groups API allows the creation and management of Volume Protection Groups (Group of Volumes for Protection).

Operations

Get all Volume Protection Groups.

Request

List all Volume Protection Groups.

Security
bearer
Query
offsetinteger<= 1000

The number of items to skip before starting to collect the result set

Default 0
limitinteger<= 20000

The numbers of items to return

Default 100
filterstring

The filter query parameter is used to filter the set of resources returned in the response. The returned set of resources must match the criteria in the filter query parameter.

A comparison compares a property name to a literal. The following comparisons are supported: “eq” : Is a property equal to value. Valid for number, boolean and string properties. “gt” : Is a property greater than a value. Valid for number or string timestamp properties. “lt” : Is a property less than a value. Valid for number or string timestamp properties “in” : Is a value in a property (that is an array of strings) Examples: GET /backup-recovery/v1beta1/volume-protection-groups?filter=volumeProtectionGroupType eq NATIVE

Filters are supported on following attributes:

  • volumeProtectionGroupType
  • createdAt
  • name
sortstring

Comma separated list of properties defining the sort order

selectstring

The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas.

curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery-api/backup-recovery/v1beta1/volume-protection-groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Total number of records returned.

itemsArray of objects(VolumeProtectionGroup)required
items[].​idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
items[].​typestringread-onlyrequired

The type of resource.

items[].​generationinteger(int64)read-onlyrequired

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.

items[].​createdAtstring(date-time)required

Time in UTC at which the object was created.

items[].​updatedAtstring(date-time)required

Time in UTC at which the object was last updated.

items[].​assetsArray of objects

Captures the list of volumes that would be part of the Protection Group.

items[].​consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

items[].​descriptionstring<= 255 characters

A brief description of the Protection Group.

items[].​namestring<= 255 charactersread-only

A user-friendly name to identify Volume Protection Group.

Example: "myProtectionGroup"
items[].​nativeGroupInfoobject
items[].​protectionJobInfoobject(DataManagementJobInfo)

Information about the assigned Protection Policy and the Protection Job.

items[].​resourceUristring(uri)

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
items[].​statestring

Current state of the group

Enum"OK""ERROR""CREATING"
items[].​stateReasonstring<= 255 characters

Brief reason for the current state of the group

items[].​statusstring

Current status of the group

Enum"OK""ERROR""WARNING"
items[].​storageSystemInfoobject

Describes a storage system.

items[].​volumeProtectionGroupTypestring

The type of the Protection Group. This can be Native for storage system specific constructs and Custom if its just a collection of assets (Volume).

Enum"NATIVE""CUSTOM"
offsetintegerrequired

The number of items to skip before starting to collect the result set

totalinteger

Total number of documents matching filter criteria.

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

Create a new Volume Protection Group.

Request

Create the Volume Protection Group for data management.

Security
bearer
Bodyapplication/jsonrequired
assetsArray of objects

List of asset's. Required in case of custom vpg type.

descriptionstring<= 255 characters

A brief description of the Protection Group.

nativeGroupInfoobject
storageSystemInfoobject

Information about storage system of the volumes.

volumeProtectionGroupTypestring

The type of the Protection Group. This can be Native for storage system specific constructs and Custom if its just a collection of assets (Volume).

Enum"NATIVE""CUSTOM"
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery-api/backup-recovery/v1beta1/volume-protection-groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

Remove a Volume Protection Group.

Request

Remove a Volume Protection Group.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Query
cascadedeleteboolean

Cascade delete option for Volume Protection Group.

Default false
Example: cascadedelete=true
curl -i -X DELETE \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery-api/backup-recovery/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

Get a Volume Protection Group resource identified by {id}.

Request

Get detailed information for a registered Volume Protection Group qualified by id.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery-api/backup-recovery/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

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.

createdAtstring(date-time)required

Time in UTC at which the object was created.

updatedAtstring(date-time)required

Time in UTC at which the object was last updated.

assetsArray of objects

Captures the list of volumes that would be part of the Protection Group.

consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

descriptionstring<= 255 characters

A brief description of the Protection Group.

namestring<= 255 charactersread-only

A user-friendly name to identify Volume Protection Group.

Example: "myProtectionGroup"
nativeGroupInfoobject
protectionJobInfoobject(DataManagementJobInfo)

Information about the assigned Protection Policy and the Protection Job.

resourceUristring(uri)

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
statestring

Current state of the group

Enum"OK""ERROR""CREATING"
stateReasonstring<= 255 characters

Brief reason for the current state of the group

statusstring

Current status of the group

Enum"OK""ERROR""WARNING"
storageSystemInfoobject

Describes a storage system.

volumeProtectionGroupTypestring

The type of the Protection Group. This can be Native for storage system specific constructs and Custom if its just a collection of assets (Volume).

Enum"NATIVE""CUSTOM"
Response
application/json
{
  "assets": [
    { … }
  ],
  "consoleUri": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "generation": 0,
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "name": "myProtectionGroup",
  "nativeGroupInfo": {
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "volume protection native group.",
    "resourceUri": "string",
    "type": "VOLUME_COLLECTION"
  },
  "protectionJobInfo": {
    "id": "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4",
    "name": "string",
    "protectionPolicyInfo": { … },
    "resourceUri": "string",
    "type": "string"
  },
  "resourceUri": "/backup-recovery/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "storageSystemInfo": {
    "id": "6a38acc7-e470-4ed7-b141-ca9509672dac",
    "name": "alletra9000.domain.net",
    "productFamily": "deviceType1",
    "resourceUri": "string",
    "type": "string"
  },
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "volumeProtectionGroupType": "NATIVE"
}

Update a Volume Protection Group.

Request

Update attributes for a Volume Protection Group. Edit is not available on a native group.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/merge-patch+jsonrequired
assetsArray of objects

List of asset's. Applicable in case of custom vpg type.

descriptionstring<= 255 characters

A brief description of the Protection Group.

curl -i -X PATCH \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery-api/backup-recovery/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

Refreshes a Volume Protection Group.

Request

Refreshes a Volume Protection Group and the corresponding snapshots and backups.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/jsonrequired
fullRefreshboolean
Example: true
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery-api/backup-recovery/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/refresh \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

Restores a Volume Protection Group from snapshot or backup.

Request

Restores a Volume Protection Group from selected snapshot or backup.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/jsonrequired
individualBackupIdsArray of strings

UUIDs of the individual backups on volumes. Required in case of granular restore from backup.

individualSnapshotIdsArray of strings

UUIDs of the individual snapshots on volumes. Required in case of granular restore from snapshot.

restoreTypestring

Specifies the type of restore to be performed. Alternate restore is only supported from backups.

Enum"PARENT""ALTERNATE"
targetStorageSystemIdstring(uuid)

UUID string uniquely identifying the storage system. Applicable only in case of alternate restore.

Example: "6a38acc7-e470-4ed7-b141-ca9509672dac"
vpgBackupIdstring(uuid)

UUID string uniquely identifying the Volume Protection Group backup.

vpgSnapshotIdstring(uuid)

UUID string uniquely identifying the Volume Protection Group snapshot.

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery-api/backup-recovery/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/restore \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

datastore-backups

Operations

datastore-snapshots

Operations

virtual-machine-backups

Operations

virtual-machine-snapshots

Operations

volume-protection-group-backups

Operations

volume-protection-group-snapshots

Operations