Skip to content
Internal API Catalog
/
Backup and Recovery API
/
API reference
/
v1beta1
/
StoreOnce

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

Get the list of available StoreOnces.

Request

Get the list of all available and registered StoreOnce machines.

Security
bearer
Query
limitinteger[ 0 .. 1000 ]

Number of items to return at a time

Default 20
Example: limit=10
offsetinteger>= 0

The offset of the first item in the collection to return

Default 0
Example: offset=5
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/storeonces \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
itemsArray of objects(StoreOnce)required
items[].​idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

items[].​typestringread-onlyrequired

The type of resource.

items[].​generationinteger(int64)read-onlyrequired

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[].​createdAtstring(date-time)required
items[].​updatedAtstring(date-time)required
items[].​resourceUristringread-onlyrequired

The self reference for this resource.

items[].​customerIdstringread-onlyrequired

The customer application identifier

items[].​namestring

A system specified name for the resource.

items[].​dataOrchestratorsArray of objects(StoreOnceDataOrchestrator)
items[].​dateTimeobject

Datetime of StoreOnce.

items[].​descriptionstring<= 255 characters

More detailed description of the appliance

items[].​fibreChannelobject

Fibre Channel of StoreOnce

items[].​healthobject

Health of StoreOnce.

items[].​iscsiInitiatorNamestring

The IQN of the iSCSI initiator

items[].​networkobject

Network of StoreOnce.

items[].​serialNumberstring

The serial number of this StoreOnce

items[].​softwareVersionstring

softwareVersion of StoreOnce

items[].​storageobject

Storage of StoreOnce.

totalinteger(int64)required

Total number of StoreOnces

Example: 1
countinteger(int64)required

Number of items in the response

Example: 1
offsetinteger(int64)required

Offset of the current result set

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

Create a StoreOnce.

Request

Register and create a new StoreOnce machine.

Security
bearer
Bodyapplication/jsonrequired
serialNumberstringrequired

Unique identifier

networkAddressstringrequired

An IP address or hostname or FQDN to address StoreOnce

credentialsobject

Credentials for connecting StoreOnce

descriptionstring<= 255 characters

More detailed description of the appliance

namestring<= 255 characters

Friendly human-readable name

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/storeonces \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "networkAddress": "string",
    "serialNumber": "string"
  }'

Responses

Accepted

Headers
Locationstring

The async-operation uri that can be used to monitor progress of the operation

Bodyapplication/json
object
Response
application/json
{}

Delete the StoreOnce.

Request

Unregister and delete the StoreOnce.

Security
bearer
Path
idstring(uuid)required

The UUID of the object

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

Forceful delete option in case connectivity with StoreOnce is lost.

Example: force=true
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/storeonces/c1a0eb78-41a0-4151-93b2-f057ffeca3f3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring

The async-operation uri that can be used to monitor progress of the operation

Bodyapplication/json
object
Response
application/json
{}

Get details of a StoreOnce.

Request

Get all the details and information of registered StoreOnce.

Security
bearer
Path
idstring(uuid)required

The UUID of the object

Example: c1a0eb78-41a0-4151-93b2-f057ffeca3f3
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/storeonces/c1a0eb78-41a0-4151-93b2-f057ffeca3f3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

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.

createdAtstring(date-time)required
updatedAtstring(date-time)required
resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

namestring

A system specified name for the resource.

dataOrchestratorsArray of objects(StoreOnceDataOrchestrator)
dateTimeobject

Datetime of StoreOnce.

descriptionstring<= 255 characters

More detailed description of the appliance

fibreChannelobject

Fibre Channel of StoreOnce

healthobject

Health of StoreOnce.

iscsiInitiatorNamestring

The IQN of the iSCSI initiator

networkobject

Network of StoreOnce.

serialNumberstring

The serial number of this StoreOnce

softwareVersionstring

softwareVersion of StoreOnce

storageobject

Storage of StoreOnce.

Response
application/json
{
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "dataOrchestrators": [
    { … }
  ],
  "dateTime": {
    "methodDateTimeSet": "NTP",
    "timezone": "string",
    "utcDateTime": "2019-08-24T14:15:22Z"
  },
  "description": "string",
  "fibreChannel": {
    "initiators": [ … ]
  },
  "health": {
    "state": "SO_HEALTH_STATE_UNKNOWN",
    "stateReason": {},
    "status": "SO_HEALTH_STATUS_CONNECTED",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "iscsiInitiatorName": "string",
  "network": {
    "dns": [ … ],
    "hostname": "string",
    "nics": [ … ],
    "ntp": [ … ]
  },
  "serialNumber": "string",
  "softwareVersion": "string",
  "storage": {
    "capacityLicensedBytes": 0,
    "capacityUnlicensedBytes": 0,
    "configuredStorageBytes": 0,
    "freeBytes": 0,
    "state": "OK",
    "unconfiguredStorageBytes": 0,
    "usedBytes": 0
  }
}

Update the StoreOnce.

Request

Update already registered StoreOnce.

Security
bearer
Path
idstring(uuid)required

The UUID of the object

Example: c1a0eb78-41a0-4151-93b2-f057ffeca3f3
Bodyapplication/merge-patch+jsonrequired
networkAddressstring<= 255 charactersrequired

An IP address or hostname or FQDN to address StoreOnce

descriptionstring<= 255 characters

More detailed description of the appliance

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/storeonces/c1a0eb78-41a0-4151-93b2-f057ffeca3f3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "networkAddress": "string"
  }'

Responses

Accepted

Headers
Locationstring

The async-operation uri that can be used to monitor progress of the operation

Bodyapplication/json
object
Response
application/json
{}

Refresh the StoreOnce.

Request

Retrieve and update the latest information about the StoreOnce.

Security
bearer
Path
idstring(uuid)required

The UUID of the object

Example: c1a0eb78-41a0-4151-93b2-f057ffeca3f3
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/storeonces/c1a0eb78-41a0-4151-93b2-f057ffeca3f3/refresh \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring

The async-operation uri that can be used to monitor progress of the operation

Bodyapplication/json
object
Response
application/json
{}

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