Skip to content
Internal API Catalog
/
Backup and Recovery API
/
API reference
/
v1beta1
/
data-orchestrators

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

application-hosts

The Application Hosts API allows the registration and management of Application Hosts.

Operations

data-orchestrators

APIs for managing Data Orchestrator operations.

Operations

Get a list of the Data Orchestrators that are registered with DSCC

Request

This API returns a list of all the Data Orchestrators that are registered with the DSCC customer account.

Security
bearer
Query
offsetinteger

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
limitinteger[ 1 .. 1000 ]

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
Default 20
sortstring

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
selectstring

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
filterstring

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
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/data-orchestrators \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of Data Orchestrators registered with DSCC

Bodyapplication/json
itemsArray of objects(DataOrchestratorDetails)required
items[].​idstringread-onlyrequired

UUID identifying a Data Orchestrator.

items[].​typestringread-onlyrequired

backup-recovery/data-orchestrator

items[].​connectionStatestringread-only

Connection state of Data Orchestrator to DSCC.

Default "DISCONNECTED"
Enum"CONNECTED""DISCONNECTED"
items[].​consoleUristringread-only

The 'self' reference for this resource in the console.

items[].​customerIdstringread-only

The customer application identifier

items[].​displayNamestring

User-defined name given to Data Orchestrator.

Example: "Data Orchestrator 1"
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[].​namestringread-only

Name given to Data Orchestrator.

Example: "Data Orchestrator 1"
items[].​resourceUristringread-only

The self reference for this resource.

items[].​serialNumberstringread-only

Data Orchestrator serial number.

items[].​softwareVersionstringread-only

Data Orchestrator software version.

items[].​statestringread-only
Default "UNKNOWN"
Enum"OK""UPGRADING""UPDATING"
items[].​stateReasonstringread-only

Reason for the Data Orchestrator being in the current state. This will be empty when the Data Orchestrator is in an OK state.

items[].​statusstringread-only
Enum"OK""WARNING""ERROR"
items[].​upTimeInSecondsintegerread-only

Returns the number of seconds since Data Orchestrator was powered on. Returns 0 if Data Orchestrator is DISCONNECTED from DSCC.

items[].​createdAtstring(date-time)

UTC time when the Data Orchestrator was activated.

Example: "2019-07-21T17:32:28Z"
items[].​dateTimeobject(DataOrchestratorDateTimeDetail)

This details the current date and time of the Data Orchestrator, how the current date and time is determined, as well as the user specified timezone. The date and time will have either been explicitly set by the user, determined from a configured NTP server or synchronized with the Data Orchestrator VM host.

items[].​interfacesobject(DataOrchestratorInterfacesSummary)
items[].​lastUpdateCheckTimestring(date-time)

UTC time when a software update check was last performed.

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

UTC time when Data Orchestrator catalogue was last protected.

Example: "2019-07-21T17:32:28Z"
items[].​ntpobject(DataOrchestratorNtpDetail)
items[].​platformstringread-only

Hypervisor platform.

Value"VMWARE_ESXI"
items[].​poweredOnAtstring(date-time)

UTC time when Data Orchestrator was last powered on.

Example: "2019-07-21T17:32:28Z"
items[].​totalMemoryInGiBintegerread-only

Total RAM configured for the Data Orchestrator in GiB.

items[].​updatedAtstring(date-time)

UTC time when the Data Orchestrator was last updated.

Example: "2019-07-21T17:32:28Z"
items[].​vCpuintegerread-only

Number of virtual CPUs configured for the Data Orchestrator.

items[].​adminUserCiphertextstringread-only

Ciphertext to allow HPE Support to authenticate with the Data Orchestrator with unrestricted admin privileges.

items[].​infosightEnabledbooleanread-only

The Data Orchestrator is sending telemetry to InfoSight.

items[].​remoteAccessEnabledbooleanread-only

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.

items[].​remoteAccessStationIdstring(uuid)read-only

An identifier that HPE Support can use to remotely access the Data Orchestrator.

items[].​supportUserCiphertextstringread-only

Ciphertext to allow HPE Support to authenticate with the Data Orchestrator with restricted support privileges.

countintegerrequired

Number of items in the response (for paginated responses)

offsetinteger

The offset query parameter specified in the request.

totalinteger

Total items returned.

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

Register a new Data Orchestrator with DSCC

Request

This API is used to register a new Data Orchestrator with the DSCC customer account.

To register the Data Orchestrator, the unique Activation Code that is displayed on the Data Orchestrator must be provided.

Security
bearer
Bodyapplication/jsonrequired
activationCodestring(uuid)required

Enter the Activation Code displayed on the Data Orchestrator.

displayNamestring

User-defined name given to the Data Orchestrator by the customer.

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/data-orchestrators \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "activationCode": "90d8db77-d956-493f-9a13-1a9dd84cd785"
  }'

Responses

Created

Headers
Locationstring

Contains the URI of the Data Orchestrator that has been registered.

Bodyapplication/json
idstringread-onlyrequired

UUID identifying a Data Orchestrator.

typestringread-onlyrequired

backup-recovery/data-orchestrator

connectionStatestringread-only

Connection state of Data Orchestrator to DSCC.

Default "DISCONNECTED"
Enum"CONNECTED""DISCONNECTED"
consoleUristringread-only

The 'self' reference for this resource in the console.

customerIdstringread-only

The customer application identifier

displayNamestring

User-defined name given to Data Orchestrator.

Example: "Data Orchestrator 1"
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.

namestringread-only

Name given to Data Orchestrator.

Example: "Data Orchestrator 1"
resourceUristringread-only

The self reference for this resource.

serialNumberstringread-only

Data Orchestrator serial number.

softwareVersionstringread-only

Data Orchestrator software version.

statestringread-only
Default "UNKNOWN"
Enum"OK""UPGRADING""UPDATING"
stateReasonstringread-only

Reason for the Data Orchestrator being in the current state. This will be empty when the Data Orchestrator is in an OK state.

statusstringread-only
Enum"OK""WARNING""ERROR"
upTimeInSecondsintegerread-only

Returns the number of seconds since Data Orchestrator was powered on. Returns 0 if Data Orchestrator is DISCONNECTED from DSCC.

createdAtstring(date-time)

UTC time when the Data Orchestrator was activated.

Example: "2019-07-21T17:32:28Z"
dateTimeobject(DataOrchestratorDateTimeDetail)

This details the current date and time of the Data Orchestrator, how the current date and time is determined, as well as the user specified timezone. The date and time will have either been explicitly set by the user, determined from a configured NTP server or synchronized with the Data Orchestrator VM host.

interfacesobject(DataOrchestratorInterfacesSummary)
lastUpdateCheckTimestring(date-time)

UTC time when a software update check was last performed.

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

UTC time when Data Orchestrator catalogue was last protected.

Example: "2019-07-21T17:32:28Z"
ntpobject(DataOrchestratorNtpDetail)
platformstringread-only

Hypervisor platform.

Value"VMWARE_ESXI"
poweredOnAtstring(date-time)

UTC time when Data Orchestrator was last powered on.

Example: "2019-07-21T17:32:28Z"
totalMemoryInGiBintegerread-only

Total RAM configured for the Data Orchestrator in GiB.

updatedAtstring(date-time)

UTC time when the Data Orchestrator was last updated.

Example: "2019-07-21T17:32:28Z"
vCpuintegerread-only

Number of virtual CPUs configured for the Data Orchestrator.

adminUserCiphertextstringread-only

Ciphertext to allow HPE Support to authenticate with the Data Orchestrator with unrestricted admin privileges.

infosightEnabledbooleanread-only

The Data Orchestrator is sending telemetry to InfoSight.

remoteAccessEnabledbooleanread-only

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.

remoteAccessStationIdstring(uuid)read-only

An identifier that HPE Support can use to remotely access the Data Orchestrator.

supportUserCiphertextstringread-only

Ciphertext to allow HPE Support to authenticate with the Data Orchestrator with restricted support privileges.

Response
application/json
{
  "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"
}

Unregister the Data Orchestrator from DSCC

Request

This API will unregister the Data Orchestrator from the DSCC customer account.

The unregistered Data Orchestrator will disable any scheduled jobs orchestrated by the Data Orchestrator.

Security
bearer
Path
idstring(uuid)required

id of the Data Orchestrator.

Query
forceboolean

Force option to forcefully unregister the Data Orchestrator when dependent resources cannot first be removed.

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/data-orchestrators/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Unregistered the Data Orchestrator Successfully

Response
No content

Get details of a Data Orchestrator registered with DSCC

Request

This API returns details of the Data Orchestrator specified by id.

Security
bearer
Path
idstring(uuid)required

id of the Data Orchestrator.

Query
selectstring

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
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/data-orchestrators/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Details of a Data Orchestrator

Bodyapplication/json
idstringread-onlyrequired

UUID identifying a Data Orchestrator.

typestringread-onlyrequired

backup-recovery/data-orchestrator

connectionStatestringread-only

Connection state of Data Orchestrator to DSCC.

Default "DISCONNECTED"
Enum"CONNECTED""DISCONNECTED"
consoleUristringread-only

The 'self' reference for this resource in the console.

customerIdstringread-only

The customer application identifier

displayNamestring

User-defined name given to Data Orchestrator.

Example: "Data Orchestrator 1"
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.

namestringread-only

Name given to Data Orchestrator.

Example: "Data Orchestrator 1"
resourceUristringread-only

The self reference for this resource.

serialNumberstringread-only

Data Orchestrator serial number.

softwareVersionstringread-only

Data Orchestrator software version.

statestringread-only
Default "UNKNOWN"
Enum"OK""UPGRADING""UPDATING"
stateReasonstringread-only

Reason for the Data Orchestrator being in the current state. This will be empty when the Data Orchestrator is in an OK state.

statusstringread-only
Enum"OK""WARNING""ERROR"
upTimeInSecondsintegerread-only

Returns the number of seconds since Data Orchestrator was powered on. Returns 0 if Data Orchestrator is DISCONNECTED from DSCC.

createdAtstring(date-time)

UTC time when the Data Orchestrator was activated.

Example: "2019-07-21T17:32:28Z"
dateTimeobject(DataOrchestratorDateTimeDetail)

This details the current date and time of the Data Orchestrator, how the current date and time is determined, as well as the user specified timezone. The date and time will have either been explicitly set by the user, determined from a configured NTP server or synchronized with the Data Orchestrator VM host.

interfacesobject(DataOrchestratorInterfacesSummary)
lastUpdateCheckTimestring(date-time)

UTC time when a software update check was last performed.

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

UTC time when Data Orchestrator catalogue was last protected.

Example: "2019-07-21T17:32:28Z"
ntpobject(DataOrchestratorNtpDetail)
platformstringread-only

Hypervisor platform.

Value"VMWARE_ESXI"
poweredOnAtstring(date-time)

UTC time when Data Orchestrator was last powered on.

Example: "2019-07-21T17:32:28Z"
totalMemoryInGiBintegerread-only

Total RAM configured for the Data Orchestrator in GiB.

updatedAtstring(date-time)

UTC time when the Data Orchestrator was last updated.

Example: "2019-07-21T17:32:28Z"
vCpuintegerread-only

Number of virtual CPUs configured for the Data Orchestrator.

adminUserCiphertextstringread-only

Ciphertext to allow HPE Support to authenticate with the Data Orchestrator with unrestricted admin privileges.

infosightEnabledbooleanread-only

The Data Orchestrator is sending telemetry to InfoSight.

remoteAccessEnabledbooleanread-only

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.

remoteAccessStationIdstring(uuid)read-only

An identifier that HPE Support can use to remotely access the Data Orchestrator.

supportUserCiphertextstringread-only

Ciphertext to allow HPE Support to authenticate with the Data Orchestrator with restricted support privileges.

Response
application/json
{
  "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"
}

Modify the configuration of a Data Orchestrator

Request

This API allows the configuration of the Data Orchestrator to be modified.

This configuration options include:

  • Network
  • Date & Time
Security
bearer
Path
idstring(uuid)required

id of the Data Orchestrator.

Bodyapplication/merge-patch+jsonrequired
dateTimeobject(DataOrchestratorDateTimeUpdate)

These attributes are used to configure the Data Orchestrator date and time.

displayNamestring

User-defined name given to the Data Orchestrator.

Example: "Data Orchestrator 1"
networkobject(DataOrchestratorNetworkUpdate)
ntpobject(DataOrchestratorNtpUpdate)
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/data-orchestrators/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

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

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

Generate a new support-bundle

Request

Generate a new support-bundle.

Security
bearer
Path
idstring(uuid)required

id of the Data Orchestrator.

Bodyapplication/jsonrequired
descriptionstring<= 255 characters

A brief description about the support-bundle.

Example: "This is a support-bundle generated to help investigate a failure."
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/data-orchestrators/{id}/generate-support-bundle' \
  -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(EmptyResponse)
Response
application/json
{}

Generate a time-based one time passcode (TOTP) for Data Orchestrator access

Request

Generate a time-based one time passcode (TOTP) for Data Orchestrator access.

Security
bearer
Path
idstring(uuid)required

id of the Data Orchestrator.

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/data-orchestrators/{id}/generate-totp' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

TOTP Created

Bodyapplication/json
totpstringread-onlyrequired

A time-based one-time passcode (TOTP) that can be used to authenticate with a Data Orchestrator local management interface if the Data Orchestrator cannot be managed through DSCC.

expiresInSecondsstringread-onlyrequired

Expiry time before the TOTP will be invalid.

Response
application/json
{
  "expiresInSeconds": "string",
  "totp": "string"
}

Recover a Data Orchestrator identified by id

Request

Recover a Data Orchestrator identified by id.

Security
bearer
Path
idstring(uuid)required

id of the Data Orchestrator.

Bodyapplication/jsonrequired
sidstring(uuid)required

activation uuid

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/data-orchestrators/{id}/recover' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378"
  }'

Responses

Accepted

Headers
Locationstring

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

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

Restart a Data Orchestrator

Request

This API will stop and restart the Data Orchestrator.

Security
bearer
Path
idstring(uuid)required

id of the Data Orchestrator.

Bodyapplication/jsonrequired
forceboolean

Indicates whether the operation is to be forced.

Default true
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/data-orchestrators/{id}/restart-guest-os' \
  -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(EmptyResponse)
Response
application/json
{}

Modify InfoSight Configuration for a Data Orchestrator

Request

Modify InfoSight Configuration for a Data Orchestrator.

Security
bearer
Path
idstring(uuid)required

id of the Data Orchestrator.

Bodyapplication/jsonrequired
remoteAccessEnabledboolean
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/data-orchestrators/{id}/set-remote-support' \
  -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(EmptyResponse)
Response
application/json
{}

Shutdown a Data Orchestrator

Request

This API will power off the Data Orchestrator to allow for maintenance of the hypervisor.

Security
bearer
Path
idstring(uuid)required

id of the Data Orchestrator.

Bodyapplication/json
forceboolean

Indicates whether the operation is to be forced.

Default true
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/data-orchestrators/{id}/shutdown-guest-os' \
  -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(EmptyResponse)
Response
application/json
{}

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