Skip to content
Internal API Catalog
/
Backup and Recovery API
/
protection-stores

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

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

Get details of all the Protection Stores

Request

List all the Protection Stores.

Security
bearer
Query
offsetinteger

The number of items to skip before starting to collect the result set

limitinteger<= 2000

The numbers of items to return

Default 10
filterstring

The filter query parameter is used to filter the set of resources returned in the response.

The returned set of resources will match the criteria in the filter query parameter.

A comparison compares a property name to a literal. The comparisons supported are the following:

  • “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 following attributes:

  • protectionStoreType
  • storageSystemInfo/id
  • storageSystemInfo/displayName

Example:

GET ./protection-stores?filter=storageSystemInfo/displayName eq 'SOD5057LHR'

sortstring

Comma separated list of properties defining the sort order

selectstring

The select query parameter is used to limit the properties returned in the GET response.

Multiple properties can be specified to be returned. The server will only return the set of properties requested by the client.

Example:

GET ./protection-stores?select=storageSystemInfo/displayName,status'

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/v1beta1/protection-stores \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Total number of records returned.

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

UUID string uniquely identifying the Protection Store.

Example: "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4"
items[].​typestringread-onlyrequired

The type of resource.

items[].​createdAtstring(date-time)required

UTC time when the Protection Store was created.

Example: "2019-07-21T17:32:28Z"
items[].​updatedAtstring(date-time)required

UTC time when the Protection Store was last updated.

Example: "2019-07-21T17:32:28Z"
items[].​cloudStoreAddressArray of strings

List of URLs for the storage provisioned for the Cloud Protection Store.

Example: ["https://cosm-9d7ab727-38c2-43ac-938d-99b9bf6d2e08.s3.us-east-1.amazonaws.com"]
items[].​connectedStatestring

The connected state of the Protection Store. The store is DISCONNECTED if its no longer associated with a Storage System.

Enum"CONNECTED""DISCONNECTED"
items[].​consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

items[].​customerIdstring(uuid)

The customer application identifier.

Example: "9b4c14a63cd5490797c4cf44c5b641e4"
items[].​dataOrchestratorInfoArray of objects(DataOrchestrator)
items[].​displayNamestring

The user-defined name for the Protection Store.

Example: "cloud_store_SOD5057LHR"
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[].​maxCapacityInBytesinteger(int64)

Maximum capacity of the Protection Store in bytes. This is applicable only for On-premises Protection Stores.

Example: 2407653459860
items[].​namestring

The system-defined name for the Protection Store. This will be the name of the Catalyst store on the Storage System.

items[].​protectionStoreTypestring

Type of the Protection Store.

Enum"ON_PREMISES""CLOUD"
items[].​resourceUristring

The 'self' reference resource URI for the Protection Store.

Example: "/backup-recovery/v1beta1/protection-stores/{id}"
items[].​sizeOnDiskInBytesinteger(int64)

Consumed capacity in bytes of the recovery points in Protection Store.

Example: 2407653459860
items[].​statestring

The current state of the Protection Store.

Enum"OFFLINE""ONLINE""READ_ONLY"
items[].​stateReasonstring<= 255 characters

Summary reason for the current state of the Protection Store.

items[].​statusstring

The current status of the Protection Store.

Enum"OK""ERROR""WARNING"
items[].​storageLocationInfoobject(StorageLocation)

Details of the Storage Location for Cloud Protection Store

items[].​storageSystemInfoobject

Describes the Storage System hosting the Protection Store.

items[].​userDataStoredInBytesinteger(int64)

Total size of the recovery points in bytes stored in the Protection Store.

Example: 2407653459860
items[].​regionstringDeprecated

The region in which the Cloud Protection Store is created.

offsetinteger

The number of items to skip before starting to collect the result set

Example: 0
totalinteger

Total number of documents matching filter criteria.

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

Create a Protection Store

Request

Create a Protection Store.

Security
bearer
Bodyapplication/jsonrequired
displayNamestring

The user-defined name for the Protection Store.

protectionStoreTypestring

Type of the Protection Store.

Enum"ON_PREMISES""CLOUD"
storageLocationIdstring

The storage location identifier for creating the cloud protection store.

storageSystemIdstring(uuid)= 36 characters

id of the Storage System (Protection Store Gateway or StoreOnce).

Example: "2a1172be-4281-44f9-848b-9c3f86378b13"
storageSystemTypestring

Type of the Storage System

Enum"PROTECTION_STORE_GATEWAY""STOREONCE"
regionstringDeprecated

The region in which the cloud protection store should be created. Deprecated - use storageLocationId instead

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/protection-stores \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

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

Bodyapplication/json
object
Response
application/json
{}

Delete a Protection Store

Request

Delete a Protection Store.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the Protection Store.

Example: c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4
Query
forceboolean

The force query parameter can be used to forcefully delete a Protection Store that contains user data.

Default false
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/v1beta1/protection-stores/c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4 \
  -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 the details of the Protection Store specified by id

Request

Details of a Protection Store.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the Protection Store.

Example: c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4
Query
selectstring

The select query parameter is used to limit the properties returned in the GET response.

Multiple properties can be specified to be returned. The server will only return the set of properties requested by the client.

Example:

GET ./protection-stores/b09cba1d-0e9f-4b01-98c3-da621acd37cc?select=storageSystemInfo/displayName,status'

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/v1beta1/protection-stores/c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

UUID string uniquely identifying the Protection Store.

Example: "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4"
typestringread-onlyrequired

The type of resource.

createdAtstring(date-time)required

UTC time when the Protection Store was created.

Example: "2019-07-21T17:32:28Z"
updatedAtstring(date-time)required

UTC time when the Protection Store was last updated.

Example: "2019-07-21T17:32:28Z"
cloudStoreAddressArray of strings

List of URLs for the storage provisioned for the Cloud Protection Store.

Example: ["https://cosm-9d7ab727-38c2-43ac-938d-99b9bf6d2e08.s3.us-east-1.amazonaws.com"]
connectedStatestring

The connected state of the Protection Store. The store is DISCONNECTED if its no longer associated with a Storage System.

Enum"CONNECTED""DISCONNECTED"
consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

customerIdstring(uuid)

The customer application identifier.

Example: "9b4c14a63cd5490797c4cf44c5b641e4"
dataOrchestratorInfoArray of objects(DataOrchestrator)
displayNamestring

The user-defined name for the Protection Store.

Example: "cloud_store_SOD5057LHR"
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.

maxCapacityInBytesinteger(int64)

Maximum capacity of the Protection Store in bytes. This is applicable only for On-premises Protection Stores.

Example: 2407653459860
namestring

The system-defined name for the Protection Store. This will be the name of the Catalyst store on the Storage System.

protectionStoreTypestring

Type of the Protection Store.

Enum"ON_PREMISES""CLOUD"
resourceUristring

The 'self' reference resource URI for the Protection Store.

Example: "/backup-recovery/v1beta1/protection-stores/{id}"
sizeOnDiskInBytesinteger(int64)

Consumed capacity in bytes of the recovery points in Protection Store.

Example: 2407653459860
statestring

The current state of the Protection Store.

Enum"OFFLINE""ONLINE""READ_ONLY"
stateReasonstring<= 255 characters

Summary reason for the current state of the Protection Store.

statusstring

The current status of the Protection Store.

Enum"OK""ERROR""WARNING"
storageLocationInfoobject(StorageLocation)

Details of the Storage Location for Cloud Protection Store

storageSystemInfoobject

Describes the Storage System hosting the Protection Store.

userDataStoredInBytesinteger(int64)

Total size of the recovery points in bytes stored in the Protection Store.

Example: 2407653459860
regionstringDeprecated

The region in which the Cloud Protection Store is created.

Response
application/json
{
  "cloudStoreAddress": [
    "https://cosm-9d7ab727-38c2-43ac-938d-99b9bf6d2e08.s3.us-east-1.amazonaws.com"
  ],
  "connectedState": "CONNECTED",
  "consoleUri": "string",
  "createdAt": "2019-07-21T17:32:28Z",
  "customerId": "9b4c14a63cd5490797c4cf44c5b641e4",
  "dataOrchestratorInfo": [
    { … }
  ],
  "displayName": "cloud_store_SOD5057LHR",
  "generation": 0,
  "id": "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4",
  "maxCapacityInBytes": 2407653459860,
  "name": "string",
  "protectionStoreType": "ON_PREMISES",
  "region": "string",
  "resourceUri": "/backup-recovery/v1beta1/protection-stores/{id}",
  "sizeOnDiskInBytes": 2407653459860,
  "state": "OFFLINE",
  "stateReason": "string",
  "status": "OK",
  "storageLocationInfo": {
    "id": "aws:ap-southeast-3",
    "name": "Jakarta - AWS",
    "resourceUri": "string",
    "type": "string"
  },
  "storageSystemInfo": {
    "displayName": "SOD5057LHR",
    "id": "19Z1HYVZD5057LHR",
    "resourceUri": "string",
    "type": "PROTECTION_STORE_GATEWAY"
  },
  "type": "string",
  "updatedAt": "2019-07-21T17:32:28Z",
  "userDataStoredInBytes": 2407653459860
}

Modify a Protection Store

Request

Modify a Protection Store.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the Protection Store.

Example: c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4
Bodyapplication/merge-patch+jsonrequired
displayNamestring

The user-defined name for the Protection Store.

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/v1beta1/protection-stores/c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Success

Bodyapplication/json
idstringrequired

UUID string uniquely identifying the Protection Store.

Example: "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4"
typestringread-onlyrequired

The type of resource.

createdAtstring(date-time)required

UTC time when the Protection Store was created.

Example: "2019-07-21T17:32:28Z"
updatedAtstring(date-time)required

UTC time when the Protection Store was last updated.

Example: "2019-07-21T17:32:28Z"
cloudStoreAddressArray of strings

List of URLs for the storage provisioned for the Cloud Protection Store.

Example: ["https://cosm-9d7ab727-38c2-43ac-938d-99b9bf6d2e08.s3.us-east-1.amazonaws.com"]
connectedStatestring

The connected state of the Protection Store. The store is DISCONNECTED if its no longer associated with a Storage System.

Enum"CONNECTED""DISCONNECTED"
consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

customerIdstring(uuid)

The customer application identifier.

Example: "9b4c14a63cd5490797c4cf44c5b641e4"
dataOrchestratorInfoArray of objects(DataOrchestrator)
displayNamestring

The user-defined name for the Protection Store.

Example: "cloud_store_SOD5057LHR"
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.

maxCapacityInBytesinteger(int64)

Maximum capacity of the Protection Store in bytes. This is applicable only for On-premises Protection Stores.

Example: 2407653459860
namestring

The system-defined name for the Protection Store. This will be the name of the Catalyst store on the Storage System.

protectionStoreTypestring

Type of the Protection Store.

Enum"ON_PREMISES""CLOUD"
resourceUristring

The 'self' reference resource URI for the Protection Store.

Example: "/backup-recovery/v1beta1/protection-stores/{id}"
sizeOnDiskInBytesinteger(int64)

Consumed capacity in bytes of the recovery points in Protection Store.

Example: 2407653459860
statestring

The current state of the Protection Store.

Enum"OFFLINE""ONLINE""READ_ONLY"
stateReasonstring<= 255 characters

Summary reason for the current state of the Protection Store.

statusstring

The current status of the Protection Store.

Enum"OK""ERROR""WARNING"
storageLocationInfoobject(StorageLocation)

Details of the Storage Location for Cloud Protection Store

storageSystemInfoobject

Describes the Storage System hosting the Protection Store.

userDataStoredInBytesinteger(int64)

Total size of the recovery points in bytes stored in the Protection Store.

Example: 2407653459860
regionstringDeprecated

The region in which the Cloud Protection Store is created.

Response
application/json
{
  "cloudStoreAddress": [
    "https://cosm-9d7ab727-38c2-43ac-938d-99b9bf6d2e08.s3.us-east-1.amazonaws.com"
  ],
  "connectedState": "CONNECTED",
  "consoleUri": "string",
  "createdAt": "2019-07-21T17:32:28Z",
  "customerId": "9b4c14a63cd5490797c4cf44c5b641e4",
  "dataOrchestratorInfo": [
    { … }
  ],
  "displayName": "cloud_store_SOD5057LHR",
  "generation": 0,
  "id": "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4",
  "maxCapacityInBytes": 2407653459860,
  "name": "string",
  "protectionStoreType": "ON_PREMISES",
  "region": "string",
  "resourceUri": "/backup-recovery/v1beta1/protection-stores/{id}",
  "sizeOnDiskInBytes": 2407653459860,
  "state": "OFFLINE",
  "stateReason": "string",
  "status": "OK",
  "storageLocationInfo": {
    "id": "aws:ap-southeast-3",
    "name": "Jakarta - AWS",
    "resourceUri": "string",
    "type": "string"
  },
  "storageSystemInfo": {
    "displayName": "SOD5057LHR",
    "id": "19Z1HYVZD5057LHR",
    "resourceUri": "string",
    "type": "PROTECTION_STORE_GATEWAY"
  },
  "type": "string",
  "updatedAt": "2019-07-21T17:32:28Z",
  "userDataStoredInBytes": 2407653459860
}

Reattach a Cloud Protection Store

Request

Reattach a Cloud Protection Store.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the Protection Store.

Example: c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4
Bodyapplication/jsonrequired
storageSystemIdstring(uuid)= 36 characters

id of the Storage System (Protection Store Gateway or StoreOnce).

Example: "2a1172be-4281-44f9-848b-9c3f86378b13"
storageSystemTypestring

Type of the Storage System

Enum"PROTECTION_STORE_GATEWAY""STOREONCE"
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/protection-stores/c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4/reattach \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/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-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