Backup and Recovery API
- Generate a new support-bundle
Backup and Recovery API (1.1.0)
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/
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/
When listing a large number of Data Orchestrators, the offset query parameter defines the index of the first Data Orchestrator to include in the response.
Example:
- GET /backup-recovery/v1beta1/data-orchestrators?offset=10
The limit query parameter defines the maximum number of Data Orchestrators to included in the response.
Example:
- GET /backup-recovery/v1beta1/data-orchestrators?limit=10
The sort query is a comma separated list of properties defining the sort order. The direction indicator may only be either “asc” (ascending) or “desc” (descending). If no direction indicator is specified, the default order is ascending.
Sorting is supported on the following properties:
- name
- generation
- connectionState
- serialNumber
- softwareVersion
- status
- state
- stateReason
- id
- platform
- vCpu
- totalMemoryInGiB
- poweredOnAt
- createdAt
- interfaces/network/defaultGateway
- dateTime/methodDateTimeSet
- dateTime/timezone
- ntp/status
- ntp/state
- ntp/stateReason
Example:
- GET /backup-recovery/v1beta1/data-orchestrators?sort=name,generation desc
The select query parameter is used to define a subset of properties to be included in the response. Each property to be included should be passed in a comma-separated list.
Example:
- GET /backup-recovery/v1beta1/data-orchestrators?select=id,name,serialNumber
The filter query parameter is used to filter the list of on-prem engines returned in the response. The returned set of resources will match the criteria in the filter query parameter.
A comparision 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)
Examples:
- GET /backup-recovery/v1beta1/data-orchestrators?filter=connectionState eq 'CONNECTED'
- GET /backup-recovery/v1beta1/data-orchestrators?filter=connectionState eq 'CONNECTED' and status eq 'ERROR'
Filtering is supported with the following attributes:
- id
- name
- interfaces/network/hostname
- serialNumber
- status
- state
- connectionState
- softwareVersion
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators
https://eu-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators
https://eu-central.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators
https://ap-northeast.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/data-orchestrators
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X GET \
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'List of Data Orchestrators registered with DSCC
Connection state of Data Orchestrator to DSCC.
User-defined name given to Data Orchestrator.
Reason for the Data Orchestrator being in the current state. This will be empty when the Data Orchestrator is in an OK state.
Returns the number of seconds since Data Orchestrator was powered on. Returns 0 if Data Orchestrator is DISCONNECTED from DSCC.
UTC time when the Data Orchestrator was activated.
UTC time when a software update check was last performed.
UTC time when Data Orchestrator catalogue was last protected.
UTC time when Data Orchestrator was last powered on.
UTC time when the Data Orchestrator was last updated.
Ciphertext to allow HPE Support to authenticate with the Data Orchestrator with unrestricted admin privileges.
HPE Support can remotely access the Data Orchestrator for the purposes of debug. For HPE Support to authenticate, the ciphertext must be shared by the user.
An identifier that HPE Support can use to remotely access the Data Orchestrator.
{ "count": 0, "items": [ { … } ], "offset": 0, "total": 0 }
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators
https://eu-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators
https://eu-central.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators
https://ap-northeast.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/data-orchestrators
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X POST \
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"activationCode": "90d8db77-d956-493f-9a13-1a9dd84cd785"
}'Created
Connection state of Data Orchestrator to DSCC.
Reason for the Data Orchestrator being in the current state. This will be empty when the Data Orchestrator is in an OK state.
Returns the number of seconds since Data Orchestrator was powered on. Returns 0 if Data Orchestrator is DISCONNECTED from DSCC.
UTC time when the Data Orchestrator was activated.
UTC time when a software update check was last performed.
UTC time when Data Orchestrator catalogue was last protected.
UTC time when Data Orchestrator was last powered on.
UTC time when the Data Orchestrator was last updated.
Ciphertext to allow HPE Support to authenticate with the Data Orchestrator with unrestricted admin privileges.
HPE Support can remotely access the Data Orchestrator for the purposes of debug. For HPE Support to authenticate, the ciphertext must be shared by the user.
An identifier that HPE Support can use to remotely access the Data Orchestrator.
{ "connectionState": "CONNECTED", "consoleUri": "string", "customerId": "string", "displayName": "Data Orchestrator 1", "generation": 0, "id": "string", "name": "Data Orchestrator 1", "resourceUri": "string", "serialNumber": "string", "softwareVersion": "string", "state": "OK", "stateReason": "string", "status": "OK", "type": "string", "upTimeInSeconds": 0, "createdAt": "2019-07-21T17:32:28Z", "dateTime": { "methodDateTimeSet": "NTP", "timezone": "Europe/London, Australia/Sydney, Asia/Tokyo, America/NewYork" }, "interfaces": { "network": { … } }, "lastUpdateCheckTime": "2019-07-21T17:32:28Z", "latestRecoveryPoint": "2019-07-21T17:32:28Z", "ntp": { "ntpServers": [ … ], "state": "OK", "stateReason": "string", "status": "OK" }, "platform": "VMWARE_ESXI", "poweredOnAt": "2019-07-21T17:32:28Z", "totalMemoryInGiB": 0, "updatedAt": "2019-07-21T17:32:28Z", "vCpu": 0, "adminUserCiphertext": "string", "infosightEnabled": true, "remoteAccessEnabled": true, "remoteAccessStationId": "31ea95fd-4bed-454d-a3cd-4c285fc34d8b", "supportUserCiphertext": "string" }
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}
https://eu-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}
https://eu-central.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}
https://ap-northeast.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/data-orchestrators/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X DELETE \
'https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The select query parameter is used to define a subset of properties to be included in the response. Each property to be included should be passed in a comma-separated list.
Example:
- GET /backup-recovery/v1beta1/data-orchestrators/4cf33ce9-3d8a-4c79-8dbb-3a145804bf7d?select=id,name,interfaces/network/hostname
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}
https://eu-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}
https://eu-central.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}
https://ap-northeast.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/data-orchestrators/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X GET \
'https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Details of a Data Orchestrator
Connection state of Data Orchestrator to DSCC.
Reason for the Data Orchestrator being in the current state. This will be empty when the Data Orchestrator is in an OK state.
Returns the number of seconds since Data Orchestrator was powered on. Returns 0 if Data Orchestrator is DISCONNECTED from DSCC.
UTC time when the Data Orchestrator was activated.
UTC time when a software update check was last performed.
UTC time when Data Orchestrator catalogue was last protected.
UTC time when Data Orchestrator was last powered on.
UTC time when the Data Orchestrator was last updated.
Ciphertext to allow HPE Support to authenticate with the Data Orchestrator with unrestricted admin privileges.
HPE Support can remotely access the Data Orchestrator for the purposes of debug. For HPE Support to authenticate, the ciphertext must be shared by the user.
An identifier that HPE Support can use to remotely access the Data Orchestrator.
{ "connectionState": "CONNECTED", "consoleUri": "string", "customerId": "string", "displayName": "Data Orchestrator 1", "generation": 0, "id": "string", "name": "Data Orchestrator 1", "resourceUri": "string", "serialNumber": "string", "softwareVersion": "string", "state": "OK", "stateReason": "string", "status": "OK", "type": "string", "upTimeInSeconds": 0, "createdAt": "2019-07-21T17:32:28Z", "dateTime": { "methodDateTimeSet": "NTP", "timezone": "Europe/London, Australia/Sydney, Asia/Tokyo, America/NewYork" }, "interfaces": { "network": { … } }, "lastUpdateCheckTime": "2019-07-21T17:32:28Z", "latestRecoveryPoint": "2019-07-21T17:32:28Z", "ntp": { "ntpServers": [ … ], "state": "OK", "stateReason": "string", "status": "OK" }, "platform": "VMWARE_ESXI", "poweredOnAt": "2019-07-21T17:32:28Z", "totalMemoryInGiB": 0, "updatedAt": "2019-07-21T17:32:28Z", "vCpu": 0, "adminUserCiphertext": "string", "infosightEnabled": true, "remoteAccessEnabled": true, "remoteAccessStationId": "31ea95fd-4bed-454d-a3cd-4c285fc34d8b", "supportUserCiphertext": "string" }
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}
https://eu-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}
https://eu-central.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}
https://ap-northeast.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/data-orchestrators/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X PATCH \
'https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/merge-patch+json' \
-d '{}'{}
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/generate-support-bundle
https://eu-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/generate-support-bundle
https://eu-central.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/generate-support-bundle
https://ap-northeast.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/generate-support-bundle
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/data-orchestrators/{id}/generate-support-bundle
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X POST \
'https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/generate-support-bundle' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'{}
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/generate-totp
https://eu-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/generate-totp
https://eu-central.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/generate-totp
https://ap-northeast.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/generate-totp
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/data-orchestrators/{id}/generate-totp
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X POST \
'https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/generate-totp' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "expiresInSeconds": "string", "totp": "string" }
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/recover
https://eu-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/recover
https://eu-central.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/recover
https://ap-northeast.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/recover
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/data-orchestrators/{id}/recover
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X POST \
'https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/recover' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"sid": "07f6f342-38f7-4271-ab8f-fab49fd96378"
}'{}
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/restart-guest-os
https://eu-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/restart-guest-os
https://eu-central.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/restart-guest-os
https://ap-northeast.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/restart-guest-os
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/data-orchestrators/{id}/restart-guest-os
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X POST \
'https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/restart-guest-os' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'{}
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/set-remote-support
https://eu-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/set-remote-support
https://eu-central.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/set-remote-support
https://ap-northeast.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/set-remote-support
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/data-orchestrators/{id}/set-remote-support
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X POST \
'https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/set-remote-support' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'{}
https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/shutdown-guest-os
https://eu-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/shutdown-guest-os
https://eu-central.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/shutdown-guest-os
https://ap-northeast.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/shutdown-guest-os
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/data-orchestrators/{id}/shutdown-guest-os
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X POST \
'https://us-west.api.greenlake.hpe.com/backup-recovery/v1beta1/data-orchestrators/{id}/shutdown-guest-os' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'{}