API reference

v1beta1

virtual-machine-protection-groups

Get details of a virtual machine protection group backup.

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

Delete a virtual machine protection group backup.

Request

Remove a virtual machine protection group backup.

Security

bearer

Path

vmpg-idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group.

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

backup-idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group backup.

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

Responses

Accepted

Headers

Locationstring

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

Bodyapplication/json

object

Response

application/json

{}

Get details of a virtual machine protection group backup.

Request

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

Security

bearer

Path

vmpg-idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group.

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

backup-idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group backup.

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/backups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Detailed information of a virtual-machine-protection-group backup

Bodyapplication/json

idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group backup.

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

typestringread-onlyrequired

The type of resource

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

appTypestring

Type of the application to which the backup belongs.

Value"VMWARE"

backupSetsInfoArray of objects

Information about the associated backupSetInfo. This is an array to handle application backups spanning multiple objects in the device.

backupTypestring

Enum"BACKUP""CLOUD_BACKUP"

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 backup.

customerIdstringread-only

The customer application identifier

dataOrchestratorInfoArray of objects

descriptionstring

Brief description about the application backup.

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 backup is locked.

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

namestring<= 255 charactersread-only

A user-friendly name to identify Virtual Machine Protection Group backup.

Example: "backup1"

pointInTimestring(date-time)

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

Example: "2020-03-03T05:03:08.902Z"

protectionStoreInfoobject(CopyPoolInfo)

Information about the protection store where the copy is created.

resourceUristring(uri)read-only

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/virtual-machine-protection-groups/{id}/backups/id/"

scheduleInfoobject

Details about the schedule which created this snapshot.

sourceCopyInfoobject

statestring

The current state of the application backup.

Enum"OK""ERROR""CREATING"

stateReasonstring<= 255 characters

Brief reason for the current state of the application backup.

statusstring

Current status of the application backup.

Enum"OK""ERROR""WARNING"

storageSystemInfoobject

Information about storage system where backup is created.

updatedAtstring(date-time)read-only

Time in UTC at which the object was last updated.

verificationInfoobject

Backup verification status details. Block level verification of backup with snapshot.

verifiedboolean

Flag indicating whether backup-set was verified or not

Response

application/json

{
  "appType": "VMWARE",
  "backupSetsInfo": [
    { … }
  ],
  "backupType": "BACKUP",
  "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": "backup1",
  "pointInTime": "2020-03-03T05:03:08.902Z",
  "protectionStoreInfo": {
    "id": "6a38acc7-e470-4ed7-b141-ca9509672dac",
    "name": "string",
    "protectionStoreType": "ON_PREMISES",
    "resourceUri": "/backup-recovery/v1beta1/protection-stores/6a38acc7-e470-4ed7-b141-ca9509672da",
    "type": "backup-recovery/protection-store"
  },
  "resourceUri": "/backup-recovery/v1beta1/virtual-machine-protection-groups/{id}/backups/id/",
  "scheduleInfo": {
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "Hourly snapshot schedule",
    "recurrence": "BY_MINUTES"
  },
  "sourceCopyInfo": {
    "id": "d0e48314-730a-11ea-b496-48452098762c",
    "name": "string",
    "resourceUri": "http://example.com",
    "type": "SNAPSHOT"
  },
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "storageSystemInfo": {
    "displayName": "atlas-dev-3par1.ind.hpecorp.net",
    "id": "6a38acc7-e470-4ed7-b141-ca9509672dac",
    "name": "atlas-dev-3par1.ind.hpecorp.net",
    "resourceUri": "string",
    "type": "string"
  },
  "type": "backup-recovery/virtual-machine-protection-group-backup",
  "updatedAt": "2019-08-24T14:15:22Z",
  "verificationInfo": {
    "state": "VERIFIED",
    "stateReason": "Successfully completed.",
    "status": "OK",
    "verifiedAt": "2020-03-03T05:03:08.902Z"
  },
  "verified": true
}

Update a virtual machine protection groups backup.

Request

Update attributes for a virtual machine protection groups backup.

Security

bearer

Path

vmpg-idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group.

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

backup-idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group backup.

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

Bodyapplication/merge-patch+jsonrequired

descriptionstring

Brief description about the application backup.

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 backup is locked.

namestring

Name of the application backup.

Example: "Nimble-dat1-backup"

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/backups/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

Delete a virtual machine protection group backup.

Request

Responses

Was this helpful?

Get details of a virtual machine protection group backup.

Request

Responses

Was this helpful?

Update a virtual machine protection groups backup.

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