Skip to content
Internal API Catalog
/
Backup and Recovery API
/
API reference
/
v1beta1
/
mssql-database-protection-groups
/
Get all MSSQL database protection groups.

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

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

Get all MSSQL database protection groups.

Request

List all the MSSQL database protection groups.

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 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/mssql-database-protection-groups?filter="name eq my-mssql-pg1"

Filters are supported on the following attributes:

  • createdAt
  • name
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/mssql-database-protection-groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

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

UUID string uniquely identifying the MSSQL databse protection group

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

The type of resource.

items[].​createdAtstring(date-time)

Time in UTC at which the object was created.

items[].​customerIdstring

The customer application identifier.

items[].​descriptionstring<= 255 characters

A brief description of the MSSQL database protection group.

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[].​membersArray of objects

Captures the list of databases that are part of the protection group.

items[].​namestring

A user-friendly name to identify the MSSQL database protection group.

Example: "My-Test-PG"
items[].​nativeAppInfoobject
items[].​protectionGroupTypestring

The type of the protection group. This can be 'NATIVE' for MSSQL application specific constructs such as an Availability Group, or 'CUSTOM' if its just a user provided collection of databases.

Enum"NATIVE""CUSTOM"
items[].​protectionJobInfoobject(DataManagementJobInfo)

Information about the assigned Protection Policy and the Protection Job.

items[].​resourceUristring

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/mssql-database-protection-groups/{protection-group-id}"
items[].​statestring

The current state of the MSSQL databse protection group

Enum"OK""ERROR""CREATING"
Example: "OK"
items[].​stateReasonstring<= 255 characters

Brief reason for the current state of the MSSQL databse protection group

items[].​statusstring

The current status of the MSSQL databse protection group.

Enum"OK""ERROR""WARNING"
items[].​updatedAtstring(date-time)

Time in UTC at which the object was last updated.

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
}

Create a new MSSQL Database Protection Group.

Request

Create an MSSQL Database Protection Group for data management.

Security
bearer
Bodyapplication/jsonrequired
One of:

Captures the list of databases that will be part of the protection group.

Array [
resourceUristring

The uri of member database

]
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/mssql-database-protection-groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My-Test-PG",
    "protectionGroupType": "NATIVE"
  }'

Responses

Accepted

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

Remove an MSSQL database protection group.

Request

Remove an MSSQL database protection group.

Security
bearer
Path
group-idstringrequired

UUID string uniquely identifying the MSSQL databse protection group

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-api/backup-recovery/v1beta1/mssql-database-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

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

Get an MSSQL database protection group resource identified by {group-id}.

Request

Get detailed information for an MSSQL database protection group qualified by group-id.

Security
bearer
Path
group-idstringrequired

UUID string uniquely identifying the MSSQL databse protection group

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

Responses

Success

Bodyapplication/json
idstringrequired

UUID string uniquely identifying the MSSQL databse protection group

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

The type of resource.

createdAtstring(date-time)

Time in UTC at which the object was created.

customerIdstring

The customer application identifier.

descriptionstring<= 255 characters

A brief description of the MSSQL database protection group.

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.

membersArray of objects

Captures the list of databases that are part of the protection group.

namestring

A user-friendly name to identify the MSSQL database protection group.

Example: "My-Test-PG"
nativeAppInfoobject
protectionGroupTypestring

The type of the protection group. This can be 'NATIVE' for MSSQL application specific constructs such as an Availability Group, or 'CUSTOM' if its just a user provided collection of databases.

Enum"NATIVE""CUSTOM"
protectionJobInfoobject(DataManagementJobInfo)

Information about the assigned Protection Policy and the Protection Job.

resourceUristring

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/mssql-database-protection-groups/{protection-group-id}"
statestring

The current state of the MSSQL databse protection group

Enum"OK""ERROR""CREATING"
Example: "OK"
stateReasonstring<= 255 characters

Brief reason for the current state of the MSSQL databse protection group

statusstring

The current status of the MSSQL databse protection group.

Enum"OK""ERROR""WARNING"
updatedAtstring(date-time)

Time in UTC at which the object was last updated.

virtualizationInfoobject
Response
application/json
{
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "description": "string",
  "generation": 0,
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "members": [
    { … }
  ],
  "name": "My-Test-PG",
  "nativeAppInfo": {
    "availabilityGroupReplicas": [ … ],
    "excludeSystemDatabases": true,
    "id": "9ce540e3-b552-4ca6-a407-eb0dd3d263b1",
    "instanceInfo": { … },
    "name": "string",
    "type": "MSSQL_INSTANCE",
    "uid": "7D0563C3-8627-4B33-96C7"
  },
  "protectionGroupType": "NATIVE",
  "protectionJobInfo": {
    "id": "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4",
    "name": "string",
    "protectionPolicyInfo": { … },
    "resourceUri": "string",
    "type": "string"
  },
  "resourceUri": "/backup-recovery/v1beta1/mssql-database-protection-groups/{protection-group-id}",
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "virtualizationInfo": {
    "hypervisorManagerInfo": { … }
  }
}

Update an MSSQL database protection group.

Request

Update attributes for an MSSQL database protection group.

Security
bearer
Path
group-idstringrequired

UUID string uniquely identifying the MSSQL databse protection group

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/merge-patch+jsonrequired
descriptionstring<= 255 characters

A brief description of the MSSQL database protection group.

membersArray of objects

Captures the list of databases that will be part of the protection group.

namestring

A user-friendly name to identify the MSSQL database protection group.

nativeAppInfoobject
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/mssql-database-protection-groups/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
{}

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