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

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

Get all the Protection Jobs.

Request

List all the Protection Jobs.

Security
bearer
Query
offsetinteger<= 1000

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

Default 0
limitinteger<= 20000

The numbers of items to return

Default 100
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/protection-jobs?filter=assetInfo/type eq 'virtualization/virtual-machine'

Filters are supported on following attributes:

  • assetInfo/name
  • assetInfo/type
  • assetInfo/id
  • assetInfo/resourceUri
  • operational
  • dataOrchestratorId
  • protectionPolicyInfo/id
  • protectionPolicyInfo/name
sortstring

comma separated list of properties defining the sort order

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

Responses

Success

Bodyapplication/json
countintegerrequired

Total number of records returned.

itemsArray of objects(DataManagementJobsDetail)required
items[].​idstring(uuid)required

UUID string uniquely identifying the job.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
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[].​applicationTypestring(ApplicationType)

Specifies type of application that the protection applies to. It is a mandatory field.

Enum"VMWARE""AWS""HPE_ARRAY_VOLUME"
items[].​assetInfoobject(AssetInfo)
items[].​associatedAssetsInfoArray of objects(AssetInfo)

An array of associated assets this job is indirectly protecting

items[].​dataOrchestratorIdstring

UUID string uniquely identifying the Data Orchestrator.

Example: "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4"
items[].​effectiveFromDateTimestring(date-time)

Time in UTC at which the Protection Policy assignment will be effective from.

Example: "2020-03-03T05:03:08.902Z"
items[].​operationalstring
Enum"ACTIVE""SUSPENDED""PARTIALLY_SUSPENDED"
items[].​protectionPolicyInfoobject(DataManagementTemplateInfo)

Information about the Protection Policy that was used to create the job.

items[].​protectionsArray of objects

An array of protection objectives

items[].​resourceUristring

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

offsetintegerrequired

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": [
    { … }
  ],
  "offset": 0,
  "total": 0
}

Create a new Protection Job.

Request

Assign a Protection Policy to an asset.

Security
bearer
Bodyapplication/jsonrequired
protectionPolicyIdstring(uuid)required

UUID string uniquely identifying the Protection Policy.

assetInfoobjectrequired
assetInfo.​idstring(uuid)required

The UUID of either the asset or asset group.

assetInfo.​typestring

Type of asset. Supported types are virtualization/virtual-machine, virtualization/datastore, backup-recovery/virtual-machine-protection-group, virtualization/csp-machine-instance, virtualization/csp-volume, backup-recovery/csp-protection-group, backup-recovery/mssql-database-protection-group, backup-recovery/volume-protection-group, virtualization/csp-rds-instance, virtualization/csp-k8s-application

effectiveFromDateTimestring(date-time)

Time in UTC at which the Protection Policy assignment will be effective from.

overridesobject
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-jobs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assetInfo": {
      "id": "d0e48314-730a-11ea-b496-48452098762c"
    },
    "protectionPolicyId": "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4"
  }'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

Delete a Protection Job.

Request

Delete the specified Protection Job.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the job.

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

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

Get a Protection Job identified by {id}.

Request

Get detailed information of a Protection Job qualified by id.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the job.

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

Responses

Success

Bodyapplication/json
idstring(uuid)required

UUID string uniquely identifying the job.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
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.

applicationTypestring(ApplicationType)

Specifies type of application that the protection applies to. It is a mandatory field.

Enum"VMWARE""AWS""HPE_ARRAY_VOLUME"
assetInfoobject(AssetInfo)
associatedAssetsInfoArray of objects(AssetInfo)

An array of associated assets this job is indirectly protecting

dataOrchestratorIdstring

UUID string uniquely identifying the Data Orchestrator.

Example: "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4"
effectiveFromDateTimestring(date-time)

Time in UTC at which the Protection Policy assignment will be effective from.

Example: "2020-03-03T05:03:08.902Z"
operationalstring
Enum"ACTIVE""SUSPENDED""PARTIALLY_SUSPENDED"
protectionPolicyInfoobject(DataManagementTemplateInfo)

Information about the Protection Policy that was used to create the job.

protectionsArray of objects

An array of protection objectives

resourceUristring

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

Response
application/json
{
  "applicationType": "VMWARE",
  "assetInfo": {
    "displayName": "string",
    "id": "d0e48314-730a-11ea-b496-48452098762c",
    "name": "VM-Finance",
    "resourceUri": "string",
    "type": "virtualization/virtual-machine"
  },
  "associatedAssetsInfo": [
    { … }
  ],
  "dataOrchestratorId": "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4",
  "effectiveFromDateTime": "2020-03-03T05:03:08.902Z",
  "generation": 0,
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "operational": "ACTIVE",
  "protectionPolicyInfo": {
    "id": "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4",
    "name": "Gold-Protection-Policy",
    "resourceUri": "string",
    "type": "string"
  },
  "protections": [
    { … }
  ],
  "resourceUri": "string",
  "type": "string"
}

Resume a Protection Job.

Request

Resume a Protection Job.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the job.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/jsonrequired
scheduleIdsArray of integers(^[1-9]+$)

An array of protection schedule Ids to resume

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

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

Run a Protection Job now.

Request

Run a Protection Job now.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the job.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/jsonrequired
fullBackupboolean

This option is to take explicit full backup.

includeResourcesArray of strings(uuid)

Applicable only for jobs associated with asset group resource. An array of asset group members for which the schedules should be run

Example: ["d0e48314-730a-11ea-b496-48452098762c"]
scheduleIdsArray of integers(^[1-9]+$)

An array of protection schedule Ids to run now.

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

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

Suspend a Protection Job.

Request

Suspend a Protection Job.

Security
bearer
Path
idstring(uuid)required

UUID string uniquely identifying the job.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/jsonrequired
scheduleIdsArray of integers(^[1-9]+$)

An array of protection schedule Ids to suspend

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

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

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