Skip to content
Internal API Catalog
/
Backup and Recovery API
/
API reference
/
v1beta1
/
Protection Store Gateway
/
Returns the resource requirements that would be needed to resize an existing Protection Store Gateway.

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

Shuts down the Protection Store Gateway

Request

Shutdown the Protection Store Gateway

Security
bearer
Path
idstring(uuid)required

The UUID of the object

Example: c1a0eb78-41a0-4151-93b2-f057ffeca3f3
Query
forceboolean

Force option to forcefully shutdown

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-api/backup-recovery/v1beta1/protection-store-gateways/c1a0eb78-41a0-4151-93b2-f057ffeca3f3/shutdown-guest-os \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Shutdown Protection Store Gateway accepted

Headers
Locationstring

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

Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Returns the resource requirements that would be needed to resize an existing Protection Store Gateway.

Request

Returns the resource requirements that would be needed to resize an existing Protection Store Gateway. This API doesn't perform any modifications to the Protection Store Gateway. To implement the modifications a call to POST /backup-recovery/v1beta1/protection-store-gateways/{id}/resize should be made.

Security
bearer
Path
idstring(uuid)required

The UUID of the object

Example: c1a0eb78-41a0-4151-93b2-f057ffeca3f3
Bodyapplication/jsonrequired
maxInCloudDailyProtectedDataInTiBnumber

The maximum total size of the assets that is expected to be protected each day in the Cloud Protection Stores.

Example: 2
maxInCloudRetentionDaysnumber

The maximum retention period for cloud backups in days.

Example: 2
maxOnPremDailyProtectedDataInTiBnumber

The maximum total size of the assets that is expected to be protected each day in the On-Prem Protection Store.

Example: 2
maxOnPremRetentionDaysnumber

The maximum retention period for local backups in days.

Example: 2
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-api/backup-recovery/v1beta1/protection-store-gateways/c1a0eb78-41a0-4151-93b2-f057ffeca3f3/sizer \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
iopsnumber

IOPs that the underlying storage system must support to achieve the desired throughput.

Example: 2
ramInGiBnumber

Amount of RAM in GiB required.

Example: 2
storageInTiBnumber

Total size (TiB) of datastores that the Protection Store Gateway requires.

Example: 2
vCpunumber

Number of vCPU cores required.

Example: 2
Response
application/json
{
  "iops": 2,
  "ramInGiB": 2,
  "storageInTiB": 2,
  "vCpu": 2
}

Traceroute from the Protection Store Gateway

Request

Traceroute from the Protection Store Gateway

Security
bearer
Path
idstring(uuid)required

The UUID of the object

Example: c1a0eb78-41a0-4151-93b2-f057ffeca3f3
Bodyapplication/jsonrequired
addressstring

IP address or FQDN of the target device

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-api/backup-recovery/v1beta1/protection-store-gateways/c1a0eb78-41a0-4151-93b2-f057ffeca3f3/traceroute \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Traceroute from Protection Store Gateway accepted

Headers
Locationstring

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

Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

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