Skip to content
Internal API Catalog
/
Backup and Recovery API
/
datastores

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

Restore a datastore from snapshot or a backup.

Request

Restores a datastore from selected snapshot or backup.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the datastore

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/jsonrequired
restoreTypestringrequired

Specifies the type of restore that needs to be performed.

Enum"PARENT""ALTERNATE"
snapshotIdstringrequired

UUID string uniquely identifying the snapshot.

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

UUID string uniquely identifying the backup.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
targetDatastoreInfoobject(alternateDSRestoreRequestParams)

Provides the details about the target datastore location and other inputs to create a new datastore in case of an alternate restore. These inputs are required only if the restore type is 'ALTERNATE'. Parameters are optional and values default to parent datastore details.

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/datastores/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/restore \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "backupId": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "restoreType": "PARENT",
    "snapshotId": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
  }'

Responses

Accepted

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

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