API reference

v1beta1

virtual-machine-protection-groups

Update a virtual machine protection group snapshot.

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

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

Get details of a virtual machine protection group snapshot.

Request

Get detailed information for a virtual-machine-protection-group snapshot qualified by snapshot-id.

Security

bearer

Path

vmpg-idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group.

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

snapshot-idstringrequired

UUID string uniquely identifying the 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-api/backup-recovery/v1beta1/virtual-machine-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/snapshots/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Detailed information of a Virtual Machine protection group snapshot

Bodyapplication/json

idstringrequired

UUID string uniquely identifying the snapshot.

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

typestringread-onlyrequired

The type of resource

Example: "backup-recovery/virtual-machine-protection-group-snapshot"

consistencystring(Consistency)

Specifies whether to create crash consistent or application consistent snapshot. CrashConsistentOnFailure: If an application consistent snapshot fails for any reason, with this option it will then take a crash consistent snapshot and continue.

Enum"CRASH""APPLICATION""CRASH_CONSISTENT_ON_FAILURE"

consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

containsRdmDisksboolean

Indicates if the recovery point has RDM disk or not

createdAtstring(date-time)read-only

Time in UTC at which the object was created.

createdByInfoobject

Information about the user who initiated the workflow that created this snapshot or protection policy.

customerIdstringread-only

The customer application identifier

dataOrchestratorInfoArray of objects

descriptionstring

Brief description about the application snapshot.

expiresAtstring(date-time)

Absolute value of time in UTC at which the application.

generationinteger(int64)read-only

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.

lockedUntilstring(date-time)

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

Example: "2020-04-03T05:03:08.900Z"

namestring

Name of the application snapshot.

Example: "Nimble-DS1-snap"

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)read-only

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/virtual-machine-protection-groups/id/snapshots/id/"

scheduleInfoobject

Details about the schedule which created this snapshot.

snapshotTypestring

Value"SNAPSHOT"

statestring

The current state of the application snapshot.

Enum"OK""ERROR""CREATING"

Example: "OK"

stateReasonstring<= 255 characters

Brief reason for the current state of the application snapshot.

statusstring

Current status of the application snapshot.

Enum"OK""ERROR""WARNING"

storageSystemsInfoobject(VolumeStorageSystemInfo)

Describes a storage system.

updatedAtstring(date-time)

Time in UTC at which the object was last updated.

volumesSnapshotInfoArray of objects(VolumeSnapshotInfo)

Details of the associated snapshot volumes

Response

application/json

{
  "consistency": "APPLICATION",
  "consoleUri": "string",
  "containsRdmDisks": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByInfo": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "customerId": "string",
  "dataOrchestratorInfo": [
    { … }
  ],
  "description": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "generation": 0,
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "lockedUntil": "2020-04-03T05:03:08.900Z",
  "name": "Nimble-DS1-snap",
  "pointInTime": "2020-03-03T05:03:08.902Z",
  "resourceUri": "/backup-recovery/v1beta1/virtual-machine-protection-groups/id/snapshots/id/",
  "scheduleInfo": {
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "Hourly snapshot schedule",
    "recurrence": "BY_MINUTES"
  },
  "snapshotType": "SNAPSHOT",
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "storageSystemsInfo": {
    "displayName": "my-dev-3par1.ind.hpecorp.net",
    "id": "6a38acc7-e470-4ed7-b141-ca9509672dac",
    "managed": true,
    "name": "atlas-dev-3par1.ind.hpecorp.net",
    "resourceUri": "/storage-fleet/v1/storage-systems/{uuid}",
    "serialNumber": "AF-10122",
    "storageSystemType": "HPE_ALLETRA_STORAGE_MP",
    "type": "storage-fleet/storage-system",
    "vendorName": "hpe"
  },
  "type": "backup-recovery/virtual-machine-protection-group-snapshot",
  "updatedAt": "2019-08-24T14:15:22Z",
  "volumesSnapshotInfo": [
    { … }
  ]
}

Update a virtual machine protection group snapshot.

Request

Update attributes of a virtual machine protection group snapshot.

Security

bearer

Path

vmpg-idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group.

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

snapshot-idstringrequired

UUID string uniquely identifying the snapshot.

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

Bodyapplication/merge-patch+jsonrequired

descriptionstring

Brief description about the application 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.

namestring

Name of the application snapshot.

Example: "Nimble-DS1-snap"

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/virtual-machine-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

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

Bodyapplication/json

object

Response

application/json

{}

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

Backup and Recovery API (1.1.0)

Protection Store Gateway

StoreOnce

application-hosts

data-orchestrators

datastores

mssql-database-backups

mssql-database-protection-groups

mssql-database-snapshots

mssql-databases

mssql-instances

protection-jobs

protection-policies

protection-stores

virtual-machine-protection-groups

Get details of a virtual machine protection group snapshot.

Request

Responses

Was this helpful?

Update a virtual machine protection group snapshot.

Request

Responses

Was this helpful?

virtual-machines

volume-protection-groups

datastore-backups

datastore-snapshots

virtual-machine-backups

virtual-machine-snapshots

volume-protection-group-backups

volume-protection-group-snapshots