Skip to content
Internal API Catalog
/
Backup and Recovery API
/
API reference
/
v1beta1
/
application-hosts

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

Get all registered Application Hosts.

Request

List all the registered Application Hosts.

Security
bearer
Query
offsetinteger

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

limitinteger[ 1 .. 1000 ]

The numbers of items to return

Default 20
filterstring

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

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

  • “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/application-hosts?filter="osInfo/name eq Windows+Server+2012"
  • GET /backup-recovery/v1beta1/application-hosts?filter="osInfo/name eq Windows+Server+2012 and status eq Error"

Filters are supported on the following attributes:

  • osInfo/name
  • state
  • status
  • osInfo/releaseVersion
  • createdAt
  • name
  • dataOrchestratorInfo/id
sortstring

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc"). If no direction indicator is specified, the default order is ascending.

selectstring

The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas.

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

Responses

Success

Bodyapplication/json
itemsArray of objects(ApplicationHost)required
items[].​idstringrequired

UUID string uniquely identifying the application host

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
items[].​typestringread-onlyrequired

The type of resource.

items[].​clusterInfoobject

Information about the cluster that the host is part of.

items[].​computeInfoobject

Compute info about the host

items[].​createdAtstring(date-time)

Time in UTC at which the object was created

items[].​customerIdstring

The customer application identifier.

items[].​dataOrchestratorInfoobject

Data Orchestrator specific information.

items[].​descriptionstring<= 255 characters

A brief description of the application host as provided by the user during registration.

items[].​displayNamestring

A user-friendly name to identify the application host

Example: "My-Test-WindowsHost"
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[].​manufacturerstring

The virtual or physical hardware manufacturer

Example: "VMware, Inc."
items[].​namestring(hostname)<= 255 characters

The host name as reported by the host.

Example: "host123.hpe.com"
items[].​networkAddressstring<= 255 characters

An IP address or hostname or FQDN to address the host

Example: "192.168.0.1"
items[].​networkInterfacesArray of objects

Information of all network interfaces of the application host

items[].​osInfoobject

Operating system info of the application host

items[].​resourceUristring

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/application-hosts/{host-id}"
items[].​statestring

The current state of the application host resource

Enum"OK""ERROR""INITIALIZING"
items[].​stateReasonstring<= 255 characters

Brief reason for the current state of the application host

items[].​statusstring

The current status of the application host resource.

Enum"OK""ERROR""WARNING"
items[].​storageInitiatorsobject

Details of the application host's storage initiators

items[].​updatedAtstring(date-time)

Time in UTC at which the object was last updated

items[].​usernamestring

The name of the user to be used to connect to the host

Example: "Administrator"
items[].​virtualboolean

This is set to true for hosts on virtual machines and set to false for physical hosts

Example: true
items[].​virtualizationInfoobject
countintegerrequired

Number of items in this response.

pageLimitinteger

The numbers of items to return

pageOffsetinteger

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

totalinteger

Total number of documents matching filter criteria.

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

Register a new Application Host.

Request

Register the Application Host for data management.

Security
bearer
Bodyapplication/jsonrequired
networkAddressstring<= 255 charactersrequired

An IP address or hostname or FQDN to address the host

credentialsobjectrequired

Application host credentials.

credentials.​passwordstring

Password used to access the application host

credentials.​usernamestring

Name of the user used to access the application host

descriptionstring<= 255 characters

A brief description of the application host as provided by the user during registration.

namestring(hostname)<= 255 characters

The host name as reported by the host.

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

Responses

Accepted

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

Unregister an Application Host.

Request

Unregister an Application Host.

Security
bearer
Path
host-idstringrequired

UUID string uniquely identifying the application host

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Query
forceboolean

Force option to forcefully remove Application Host during unregister operation when underlying resources cannot 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/application-hosts/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

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

Get an Application Host resource identified by {host-id}.

Request

Get detailed information for a registered Application Host qualified by host-id.

Security
bearer
Path
host-idstringrequired

UUID string uniquely identifying the application host

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
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/application-hosts/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

UUID string uniquely identifying the application host

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
typestringread-onlyrequired

The type of resource.

clusterInfoobject

Information about the cluster that the host is part of.

computeInfoobject

Compute info about the host

createdAtstring(date-time)

Time in UTC at which the object was created

customerIdstring

The customer application identifier.

dataOrchestratorInfoobject

Data Orchestrator specific information.

descriptionstring<= 255 characters

A brief description of the application host as provided by the user during registration.

displayNamestring

A user-friendly name to identify the application host

Example: "My-Test-WindowsHost"
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.

manufacturerstring

The virtual or physical hardware manufacturer

Example: "VMware, Inc."
namestring(hostname)<= 255 characters

The host name as reported by the host.

Example: "host123.hpe.com"
networkAddressstring<= 255 characters

An IP address or hostname or FQDN to address the host

Example: "192.168.0.1"
networkInterfacesArray of objects

Information of all network interfaces of the application host

osInfoobject

Operating system info of the application host

resourceUristring

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/application-hosts/{host-id}"
statestring

The current state of the application host resource

Enum"OK""ERROR""INITIALIZING"
stateReasonstring<= 255 characters

Brief reason for the current state of the application host

statusstring

The current status of the application host resource.

Enum"OK""ERROR""WARNING"
storageInitiatorsobject

Details of the application host's storage initiators

updatedAtstring(date-time)

Time in UTC at which the object was last updated

usernamestring

The name of the user to be used to connect to the host

Example: "Administrator"
virtualboolean

This is set to true for hosts on virtual machines and set to false for physical hosts

Example: true
virtualizationInfoobject
Response
application/json
{
  "clusterInfo": {
    "clusterIp": "192.168.0.1",
    "members": [ … ],
    "name": "cluster-1"
  },
  "computeInfo": {
    "memorySizeInMiB": 4096,
    "numCpuCores": 8,
    "numCpuThreads": 16
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "dataOrchestratorInfo": {
    "id": "8b4c14a6-3cd5-4907-97c4-cf44c5b642e5",
    "resourceUri": "string",
    "type": "string"
  },
  "description": "string",
  "displayName": "My-Test-WindowsHost",
  "generation": 0,
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "manufacturer": "VMware, Inc.",
  "name": "host123.hpe.com",
  "networkAddress": "192.168.0.1",
  "networkInterfaces": [
    { … }
  ],
  "osInfo": {
    "buildVersion": "6.7.0 build-9030300 NT 6.3, 3.8.13-44.1.1.el6uek.x86_6",
    "name": "Windows Server 2012, Oracle Enterprise Linux",
    "releaseVersion": "6.7.0 build-9030300, R2, 7.2"
  },
  "resourceUri": "/backup-recovery/v1beta1/application-hosts/{host-id}",
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "storageInitiators": {
    "fcHba": [ … ],
    "iscsi": [ … ]
  },
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "username": "Administrator",
  "virtual": true,
  "virtualizationInfo": {
    "hypervisorManagerInfo": { … },
    "virtualMachineInfo": { … }
  }
}

Update an Application Host.

Request

Update attributes for an Application Host.

Security
bearer
Path
host-idstringrequired

UUID string uniquely identifying the application host

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/merge-patch+jsonrequired
credentialsobject

Application host credentials.

descriptionstring<= 255 characters

A brief description of the application host as provided by the user during registration.

namestring(hostname)<= 255 characters

The host name as reported by the host.

networkAddressstring<= 255 characters

An IP address or hostname or FQDN to address the host

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/application-hosts/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Accepted

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

Refresh an Application Host and its sub-resources.

Request

Refresh an Application Host and its sub-resources.

Security
bearer
Path
host-idstringrequired

UUID string uniquely identifying the application host

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
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/application-hosts/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/refresh \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

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

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