Skip to content
Internal API Catalog
/
Backup and Recovery API
/
volume-protection-group-snapshots

Backup and Recovery API (1.1.0)

Backup and Recovery API

Download OpenAPI description
index.json
index.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/

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

datastore-backups

Operations

datastore-snapshots

Operations

virtual-machine-backups

Operations

virtual-machine-snapshots

Operations

volume-protection-group-backups

Operations

volume-protection-group-snapshots

Operations

Get all Volume Protection Group snapshots.

Request

List all Volume Protection Group snapshots.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
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/{id}/snapshots?filter=storageSystemInfo/name eq 'myStorageSystem'

Filters are supported on following attributes:

  • state
  • status
  • storageSystemInfo/id
  • storageSystemInfo/name
  • pointInTime
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/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/snapshots \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Total number of records returned.

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

UUID string uniquely identifying the Volume Protection Group snapshot.

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[].​createdByInfoobject

Information about the user who initiated the workflow that created this snapshot or Protection Policy.

items[].​customerIdstring(uuid)

The customer application identifier.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
items[].​descriptionstring<= 255 characters

A brief description of the Volume Protection Group snapshot.

items[].​expiresAtstring(date-time)

Absolute value of time in UTC at which the application.

Example: "2020-04-03T05:03:08.900Z"
items[].​individualSnapshotsInfoArray of objects

Information about the individual snapshots on volumes.

items[].​lockedUntilstring(date-time)

Absolute value of time in UTC until which the application snapshot is locked.

Example: "2020-04-03T05:03:08.900Z"
items[].​namestring<= 255 charactersread-only

A user-friendly name to identify Volume Protection Group snapshot.

Example: "myVpgSnapshot"
items[].​pointInTimestring(date-time)

Time in UTC at which the application snapshot was created on the device.

Example: "2020-03-03T05:03:08.902Z"
items[].​resourceUristring(uri)

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/volume-protection-groups/8740e4f8-9f68-4b36-8f89-6bdf0808e111/snapshots/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
items[].​scheduleInfoobject(ScheduleInfo)

Details about the schedule which created this snapshot.

items[].​statestring

Current state of the snapshot

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

Brief reason for the current state of the snapshot

items[].​statusstring

Current status of the snapshot

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

Describes a storage system.

items[].​storageSystemSnapshotIdstring(uuid)

Reference to the group snapshot

items[].​vpgInfoobject

Information about the Volume Protection Group.

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 snapshot copy of a Volume Protection Group.

Request

Create a snapshot copy of a Volume Protection Group.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/jsonrequired
namestring<= 255 charactersrequired

Name of the application snapshot.

Example: "vpg-snapshot"
descriptionstring

Brief description about the application snapshot.

expireAfterobject(ExpireAfter)

Copy expiration attribute, which specifies the expiration for the artifacts created.

lockForobject(LockFor)

Retention attribute, which specifies the retention period for the artifacts created. Artifacts are locked for deletion for the specified period of time.

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/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/snapshots \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "vpg-snapshot"
  }'

Responses

Accepted

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

Remove a Volume Protection Group snapshot.

Request

Remove a Volume Protection Group snapshot.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
snapshot-idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group snapshot.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
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/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/snapshots/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 snapshot identified by {id}.

Request

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

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
snapshot-idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group snapshot.

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/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/snapshots/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 snapshot.

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.

createdByInfoobject

Information about the user who initiated the workflow that created this snapshot or Protection Policy.

customerIdstring(uuid)

The customer application identifier.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
descriptionstring<= 255 characters

A brief description of the Volume Protection Group snapshot.

expiresAtstring(date-time)

Absolute value of time in UTC at which the application.

Example: "2020-04-03T05:03:08.900Z"
individualSnapshotsInfoArray of objects

Information about the individual snapshots on volumes.

lockedUntilstring(date-time)

Absolute value of time in UTC until which the application snapshot is locked.

Example: "2020-04-03T05:03:08.900Z"
namestring<= 255 charactersread-only

A user-friendly name to identify Volume Protection Group snapshot.

Example: "myVpgSnapshot"
pointInTimestring(date-time)

Time in UTC at which the application snapshot was created on the device.

Example: "2020-03-03T05:03:08.902Z"
resourceUristring(uri)

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/volume-protection-groups/8740e4f8-9f68-4b36-8f89-6bdf0808e111/snapshots/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
scheduleInfoobject(ScheduleInfo)

Details about the schedule which created this snapshot.

statestring

Current state of the snapshot

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

Brief reason for the current state of the snapshot

statusstring

Current status of the snapshot

Enum"OK""ERROR""WARNING"
storageSystemInfoobject

Describes a storage system.

storageSystemSnapshotIdstring(uuid)

Reference to the group snapshot

vpgInfoobject

Information about the Volume Protection Group.

Response
application/json
{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByInfo": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "customerId": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "description": "string",
  "expiresAt": "2020-04-03T05:03:08.900Z",
  "generation": 0,
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "individualSnapshotsInfo": [
    { … }
  ],
  "lockedUntil": "2020-04-03T05:03:08.900Z",
  "name": "myVpgSnapshot",
  "pointInTime": "2020-03-03T05:03:08.902Z",
  "resourceUri": "/backup-recovery/v1beta1/volume-protection-groups/8740e4f8-9f68-4b36-8f89-6bdf0808e111/snapshots/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "scheduleInfo": {
    "name": "Hourly snapshot schedule",
    "recurrence": "BY_MINUTES",
    "scheduleId": 0
  },
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "storageSystemInfo": {
    "id": "6a38acc7-e470-4ed7-b141-ca9509672dac",
    "name": "alletra9000.domain.net",
    "productFamily": "deviceType1",
    "resourceUri": "string",
    "type": "string"
  },
  "storageSystemSnapshotId": "5d991e37-5be8-4aeb-a185-dd5008c68317",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "vpgInfo": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "resourceUri": "string",
    "type": "string"
  }
}

Update a Volume Protection Group snapshot.

Request

Update attributes for a Volume Protection Group snapshot. 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
snapshot-idstring(uuid)required

UUID string uniquely identifying the Volume Protection Group snapshot.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/merge-patch+jsonrequired
descriptionstring<= 255 characters

A brief description of the Volume Protection Group snapshot.

expiresAtstring(date-time)

Absolute value of time in UTC at which the application.

lockedUntilstring(date-time)

Absolute value of time in UTC until which the application snapshot is locked.

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/v1beta1/volume-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/snapshots/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
{}