Skip to content
Internal API Catalog
/
Backup and Recovery API
/
API reference
/
v1beta1
/
virtual-machine-snapshots

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

datastore-backups

Operations

datastore-snapshots

Operations

virtual-machine-backups

Operations

virtual-machine-snapshots

Operations

Get information about all virtual machine snapshots.

Request

Get information about all virtual machine snapshots.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the virtual machine

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

The number of items to omit from the beginning of the result set. The offset and limit query parameters are used in conjunction with pagination. For example "offset=30&limit=10" indicates the fourth page of 10 items.

limitinteger[ 1 .. 1000 ]

The maximum number of items to include in the response. The offset and limit query parameters are used in conjunction with pagination. For example "offset=30&limit=10" indicates the fourth page of 10 items.

Default 20
filterstring

An expression that enables you to filter the results.

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

Filters are supported on the following attributes:

  • snapshotType
  • state
  • status
  • createdByInfo/id
  • createdByInfo/name
  • storageSystemsInfo/id
  • storageSystemsInfo/storageSystemType
  • storageSystemsInfo/name
  • consistency
  • pointInTime
  • dataOrchestratorInfo/id
  • expiresAt
  • name
sortstring

Comma separated list of properties defining the sort order. Each item in the “sort” query parameter is a property name optionally followed by a direction indicator. The direction indicator may only be either “asc” (ascending) or “desc” (descending). If no direction indicator is specified, the default order is ascending.

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 formatted as an exclusive comma separated list of properties. If not specified, all properties are returned.

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

Responses

virtual machine snapshots list

Bodyapplication/json
countintegerrequired

The number of resources in the items array.

itemsArray of objects(VirtualMachineSnapshot)required
items[].​idstringrequired

UUID string uniquely identifying the snapshot.

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

The type of resource.

Example: "backup-recovery/virtual-machine-snapshot"
items[].​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"
items[].​consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

items[].​containsRdmDisksboolean

Indicates if the recovery point has RDM disk or not.

items[].​createdAtstring(date-time)read-only

Time in UTC at which the object was created.

items[].​createdByInfoobject

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

items[].​customerIdstringread-only

The customer application identifier

items[].​dataOrchestratorInfoArray of objects
items[].​descriptionstring

Brief description about the application snapshot.

items[].​expiresAtstring(date-time)

Absolute value of time in UTC when the application snapshot expires.

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

items[].​indexedstring

The index state of the snapshot.

Enum"INDEXED""PARTIALLY_INDEXED""NOT_INDEXED"
items[].​lockedUntilstring(date-time)

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

Example: "2020-04-03T05:03:08.900Z"
items[].​namestring

Name of the application snapshot.

Example: "Nimble-VM1-snap"
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)read-only

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/virtual-machines/id/snapshots/id"
items[].​scheduleInfoobject(ScheduleInfoObj)

Details about the schedule that created this snapshot.

items[].​snapshotTypestring
Value"SNAPSHOT"
items[].​statestring

The current state of the application snapshot.

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

Brief reason for the current state of the application snapshot.

items[].​statusstring

Current status of the application snapshot.

Enum"OK""ERROR""WARNING"
items[].​storageSystemsInfoArray of objects(VolumeStorageSystemInfo)

Storage info details of this virtual machine.

items[].​updatedAtstring(date-time)

Time in UTC at which the object was last updated.

items[].​virtualDisksArray of objects

A list of objects encapsulating information about the storage disks provisioned to a virtual machine.

items[].​vmConfigInfoobject

Information about the virtual machine configuration at the time snapshot was created.

items[].​volumesSnapshotInfoArray of objects(VolumeSnapshotInfo)

Details of the associated snapshot volumes.

offsetintegerrequired

The offset specified in the offset query parameter.

totalinteger

The total count of objects in the result set.

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

Delete a virtual machine snapshot.

Request

Remove a virtual machine snapshot.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the virtual machine

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

UUID string uniquely identifying the 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-api/backup-recovery/v1beta1/virtual-machines/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 details of a virtual machine snapshot.

Request

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

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the virtual machine

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

Responses

Detailed information of a virtual machine 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-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 template.

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 when the application snapshot expires.

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.

indexedstring

The index state of the snapshot.

Enum"INDEXED""PARTIALLY_INDEXED""NOT_INDEXED"
lockedUntilstring(date-time)

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

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

Name of the application snapshot.

Example: "Nimble-VM1-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-machines/id/snapshots/id"
scheduleInfoobject(ScheduleInfoObj)

Details about the schedule that 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"
storageSystemsInfoArray of objects(VolumeStorageSystemInfo)

Storage info details of this virtual machine.

updatedAtstring(date-time)

Time in UTC at which the object was last updated.

virtualDisksArray of objects

A list of objects encapsulating information about the storage disks provisioned to a virtual machine.

vmConfigInfoobject

Information about the virtual machine configuration at the time snapshot was created.

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",
  "indexed": "INDEXED",
  "lockedUntil": "2020-04-03T05:03:08.900Z",
  "name": "Nimble-VM1-snap",
  "pointInTime": "2020-03-03T05:03:08.902Z",
  "resourceUri": "/backup-recovery/v1beta1/virtual-machines/id/snapshots/id",
  "scheduleInfo": {
    "name": "Hourly snapshot schedule",
    "recurrence": "BY_MINUTES",
    "scheduleId": 0
  },
  "snapshotType": "SNAPSHOT",
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "storageSystemsInfo": [
    { … }
  ],
  "type": "backup-recovery/virtual-machine-snapshot",
  "updatedAt": "2019-08-24T14:15:22Z",
  "virtualDisks": [
    { … }
  ],
  "vmConfigInfo": {
    "computeInfo": { … },
    "networkAdapters": [ … ]
  },
  "volumesSnapshotInfo": [
    { … }
  ]
}

Update a virtual machine snapshot.

Request

Update attributes for a virtual machine snapshot.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the virtual machine

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 when the application snapshot expires.

lockedUntilstring(date-time)

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

namestring

Name of the application snapshot.

Example: "Nimble-VM1-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-machines/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
{}

volume-protection-group-backups

Operations

volume-protection-group-snapshots

Operations