Update an assigned Protection Policy.

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

protection-policies

The Protection Policies API allows the creation and management of Protection Policies.

Operations

Get all protection policies.

Request

List all the protection policies.

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-policies?filter=protections/type eq CLOUD_BACKUP

Filters are supported on following attributes:

assigned
name
protections/type
protections/applicationType
protections/protectionStoreInfo/name
protections/protectionStoreInfo/id

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-api/backup-recovery/v1beta1/protection-policies \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

countintegerrequired

The numbers of items to return

Example: 1

itemsArray of objects(DataManagementTemplatesDetail)required

items[].idstring(uuid)required

UUID string uniquely identifying the Protection Policy.

Example: "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4"

items[].typestringread-onlyrequired

The type of resource.

items[].applicationTypestring(ApplicationType)

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

Enum"VMWARE""AWS""HPE_ARRAY_VOLUME"

items[].assignedboolean

Boolean indicating if the Protection Policy has been used to create Protection Jobs

items[].consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

items[].createdAtstring(date-time)

UTC time when the Protection Policy was created.

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

items[].createdByobject

Information about the user who created the Protection Policy.

items[].descriptionstring

A brief description about the Protection Policy.

Example: "Protection Policy protecting Finance department's Virtual Machines or datastores."

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[].namestring

User defined name of the Protection Policy.

Example: "Gold-Protection-Policy"

items[].protectionJobsInfoArray of objects

Details of the Protection Jobs using the Protection Policy

items[].protectionsArray of objects

An array of protection objectives.

items[].resourceUristring

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

items[].updatedAtstring(date-time)

UTC time when the Protection Policy was last updated.

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

offsetintegerrequired

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

Example: 0

totalinteger

Total number of documents matching filter criteria.

Response

application/json

{
  "count": 1,
  "items": [
    { … }
  ],
  "offset": 0,
  "total": 0
}

Create a new Protection Policy.

Request

Create a new Protection Policy.

Security

bearer

Bodyapplication/jsonrequired

namestringrequired

User defined name of the Protection Policy.

applicationTypestring(ApplicationType)required

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

Enum"VMWARE""AWS""HPE_ARRAY_VOLUME"

protectionsArray of objectsrequired

An array of protection objectives

protections[].typestring(ProtectionType)required

Specifies type of protection. It is a mandatory field. 'SNAPSHOT' and 'REPLICATED_SNAPSHOT' types are array level snapshots.

Enum"SNAPSHOT""BACKUP""CLOUD_BACKUP"

protections[].schedulesArray of objectsrequired

An array of protection requirements specifying the frequency of creation, targets, retention and expiry related attributes.

protections[].schedules[].scheduleIdinteger(^[1-9]+$)required

Client provided id for this schedule.

protections[].schedules[].scheduleobjectrequired

This schema defines a schedule.

protections[].schedules[].schedule.recurrencestringrequired

Specifies the recurrence.

Enum"BY_MINUTES""HOURLY""DAILY"

protections[].schedules[].schedule.repeatIntervalobjectrequired

Specifies the repeat interval. The interpretation varies with recurrence type. Examples: - 'BY_MINUTES' every '15' -> Every 15 minutes - 'HOURLY' every '6' on '30' -> Every 6 hours on half past of that hour - 'DAILY' every '1', startTime '06:00' -> Every day at 06:00 - 'WEEKLY' every '2' on '0' -> Every two weeks on the Monday of that week. - 'MONTHLY' every '3' on '7' -> Every three months on the 7th day of the month.

protections[].schedules[].schedule.repeatInterval.everyintegerrequired

Specifies the recurrence interval. 'BY_MINUTES' [1...60], 'HOURLY' [1...24], 'DAILY' [1...n], 'WEEKLY' [1...n], 'MONTHLY' [1...n]

protections[].schedules[].schedule.repeatInterval.onArray of integers

'BY_MINUTES' N/A. 'HOURLY' specific minute [0...59]. 'DAILY' N/A, startTime can be used to specify exact hour and minute of schedule run. 'WEEKLY' specific day of the week [0...6]. This is [mon-sun]. 'MONTHLY' specific day of the month [0...31]. '0' is used to specify last day of the month.

protections[].schedules[].schedule.activeTimeobject

Active time for the schedule. If specified then the schedule will be executed only in this period. Applicable only for 'BY_MINUTES' and 'HOURLY' schedules only.

protections[].schedules[].schedule.startTimestring(HH:MM)

Time when schedule is to be executed. Applicable for 'DAILY', 'WEEKLY' and 'MONTHLY' schedules only.

Example: "16:35"

protections[].schedules[].expireAfterobject(ExpireAfter)

Copy expiration attribute, which specifies the expiration for the artifacts created.

protections[].schedules[].lockForobject(LockFor)

Retention attribute, which specifies the retention period for the artifacts created. Artifacts are locked for deletion for the specified period of time.

protections[].schedules[].namestring[ 1 .. 255 ] characters

User provided name for this schedule

protections[].schedules[].namePatternobject

Format for the snapshot names

protections[].schedules[].postScriptInfoobject(PostScriptInfo)

Details required to run the post-script.

protections[].schedules[].preScriptInfoobject(PreScriptInfo)

Details required to run the pre-script.

protections[].schedules[].sourceProtectionScheduleIdinteger

Id of the source protection schedule. If provided this schedule becomes dependent.

protections[].protectionStoreIdstring(uuid)

UUID string uniquely identifying the protection store.

Example: "2a1172be-4281-44f9-848b-9c3f86378b13"

descriptionstring

A brief description about the Protection Policy.

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/protection-policies \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "applicationType": "VMWARE",
    "name": "Gold-Protection-Policy",
    "protections": [
      {
        "schedules": [
          {
            "schedule": {
              "recurrence": "BY_MINUTES",
              "repeatInterval": {
                "every": 0
              }
            },
            "scheduleId": 0
          }
        ],
        "type": "SNAPSHOT"
      }
    ]
  }'

Responses

Success

Bodyapplication/json

idstring(uuid)required

UUID string uniquely identifying the Protection Policy.

Example: "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4"

typestringread-onlyrequired

The type of resource.

applicationTypestring(ApplicationType)

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

Enum"VMWARE""AWS""HPE_ARRAY_VOLUME"

assignedboolean

Boolean indicating if the Protection Policy has been used to create Protection Jobs

consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

createdAtstring(date-time)

UTC time when the Protection Policy was created.

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

createdByobject

Information about the user who created the Protection Policy.

descriptionstring

A brief description about the Protection Policy.

Example: "Protection Policy protecting Finance department's Virtual Machines or datastores."

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.

namestring

User defined name of the Protection Policy.

Example: "Gold-Protection-Policy"

protectionJobsInfoArray of objects

Details of the Protection Jobs using the Protection Policy

protectionsArray of objects

An array of protection objectives.

resourceUristring

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

updatedAtstring(date-time)

UTC time when the Protection Policy was last updated.

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

Response

application/json

{
  "applicationType": "VMWARE",
  "assigned": true,
  "consoleUri": "string",
  "createdAt": "2019-07-21T17:32:28Z",
  "createdBy": {
    "id": "2a1172be-4281-44f9-848b-9c3f86378b13",
    "name": "Admin"
  },
  "description": "Protection Policy protecting Finance department's Virtual Machines or datastores.",
  "generation": 0,
  "id": "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4",
  "name": "Gold-Protection-Policy",
  "protectionJobsInfo": [
    { … }
  ],
  "protections": [
    { … }
  ],
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-07-21T17:32:28Z"
}

Delete a Protection Policy.

Request

Delete the Protection Policy.

Security

bearer

Path

idstring(uuid)required

UUID string uniquely identifying the Protection Policy.

Example: c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4

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/protection-policies/c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

No content

Response

No content

Get a Protection Policy identified by {id}.

Request

Get detailed information of a Protection Policy qualified by id.

Security

bearer

Path

idstring(uuid)required

UUID string uniquely identifying the Protection Policy.

Example: c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4

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/protection-policies/c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

idstring(uuid)required

UUID string uniquely identifying the Protection Policy.

Example: "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4"

typestringread-onlyrequired

The type of resource.

applicationTypestring(ApplicationType)

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

Enum"VMWARE""AWS""HPE_ARRAY_VOLUME"

assignedboolean

Boolean indicating if the Protection Policy has been used to create Protection Jobs

consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

createdAtstring(date-time)

UTC time when the Protection Policy was created.

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

createdByobject

Information about the user who created the Protection Policy.

descriptionstring

A brief description about the Protection Policy.

Example: "Protection Policy protecting Finance department's Virtual Machines or datastores."

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.

namestring

User defined name of the Protection Policy.

Example: "Gold-Protection-Policy"

protectionJobsInfoArray of objects

Details of the Protection Jobs using the Protection Policy

protectionsArray of objects

An array of protection objectives.

resourceUristring

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

updatedAtstring(date-time)

UTC time when the Protection Policy was last updated.

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

Response

application/json

{
  "applicationType": "VMWARE",
  "assigned": true,
  "consoleUri": "string",
  "createdAt": "2019-07-21T17:32:28Z",
  "createdBy": {
    "id": "2a1172be-4281-44f9-848b-9c3f86378b13",
    "name": "Admin"
  },
  "description": "Protection Policy protecting Finance department's Virtual Machines or datastores.",
  "generation": 0,
  "id": "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4",
  "name": "Gold-Protection-Policy",
  "protectionJobsInfo": [
    { … }
  ],
  "protections": [
    { … }
  ],
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-07-21T17:32:28Z"
}