Skip to content
Internal API Catalog
/
Backup and Recovery API
/
mssql-databases

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

Get all discovered MSSQL databases.

Request

List all the discovered MSSQL databases.

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/mssql-databases?filter="name eq billing-db-1"
  • GET /backup-recovery/v1beta1/mssql-databases?filter="applicationHostInfo/name eq myhost1 and status eq Error"

Filters are supported on the following attributes:

  • state
  • status
  • applicationHostInfo/id
  • applicationHostInfo/name
  • mssqlDatabaseProtectionGroupInfo/id
  • mssqlDatabaseProtectionGroupInfo/name
  • virtualizationInfo/hypervisorManagerInfo/id
  • 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/v1beta1/mssql-databases \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

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

UUID string uniquely identifying the MSSQL Database

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

The type of resource.

items[].​applicationHostInfoobject

The application host on which the database exists. In case of cluster this will be the active host

items[].​availabilityGroupInfoobject(MSSQLAvailabilityGroupInfo)

Details of the availability group this resource is associated to.

items[].​clusterInfoobject

Cluster related information for the database

items[].​createdAtstring(date-time)

Time in UTC at which the object was created.

items[].​customerIdstring

The customer application identifier.

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[].​instanceInfoobject

The mssql instance under which the database exists

items[].​mssqlDatabaseProtectionGroupInfoobject

Information of the mssql database protection group.

items[].​namestring<= 80 charactersread-only

Name of the MSSQL Database as configured in the application host

Example: "billing-db1"
items[].​protectionJobInfoobject(DataManagementJobInfo)

Information about the assigned Protection Policy and the Protection Job.

items[].​protectionStatusstring

Provides the current protection status of this resource. - UNPROTECTED - No policy assigned, No recovery points exists - LAPSED - No policy assigned, at least one recovery points exists - PENDING - Policy assigned, No recovery points exists - PARTIAL - Policy assigned, At least one recovery point exists - PROTECTED - Policy assigned, most recent run of every configured schedule is successful - PAUSED - Policy assigned, one or more of the schedules are paused - UNSUPPORTED - No policy can be assigned

Enum"UNPROTECTED""LAPSED""PENDING"
Example: "PROTECTED"
items[].​recoveryPointsExistboolean

Indicates at least one valid recovery point exists for this resource.

Example: true
items[].​resourceUristring

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/mssql-databases/{db-id}"
items[].​sizeInBytesinteger

size of the database in bytes.

Example: 2407653459860
items[].​statestring

The current state of the MSSQL Database

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

Brief reason for the current state of the MSSQL Database

items[].​statusstring

The current status of the MSSQL Database.

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
}

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

Request

Get detailed information for a discovered MSSQL database qualified by db-id.

Security
bearer
Path
db-idstringrequired

UUID string uniquely identifying the MSSQL Database

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

Responses

Success

Bodyapplication/json
idstringrequired

UUID string uniquely identifying the MSSQL Database

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

The type of resource.

applicationHostInfoobject

The application host on which the database exists. In case of cluster this will be the active host

availabilityGroupInfoobject(MSSQLAvailabilityGroupInfo)

Details of the availability group this resource is associated to.

clusterInfoobject

Cluster related information for the database

createdAtstring(date-time)

Time in UTC at which the object was created.

customerIdstring

The customer application identifier.

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.

instanceInfoobject

The mssql instance under which the database exists

mssqlDatabaseProtectionGroupInfoobject

Information of the mssql database protection group.

namestring<= 80 charactersread-only

Name of the MSSQL Database as configured in the application host

Example: "billing-db1"
protectionJobInfoobject(DataManagementJobInfo)

Information about the assigned Protection Policy and the Protection Job.

protectionStatusstring

Provides the current protection status of this resource. - UNPROTECTED - No policy assigned, No recovery points exists - LAPSED - No policy assigned, at least one recovery points exists - PENDING - Policy assigned, No recovery points exists - PARTIAL - Policy assigned, At least one recovery point exists - PROTECTED - Policy assigned, most recent run of every configured schedule is successful - PAUSED - Policy assigned, one or more of the schedules are paused - UNSUPPORTED - No policy can be assigned

Enum"UNPROTECTED""LAPSED""PENDING"
Example: "PROTECTED"
recoveryPointsExistboolean

Indicates at least one valid recovery point exists for this resource.

Example: true
resourceUristring

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/mssql-databases/{db-id}"
sizeInBytesinteger

size of the database in bytes.

Example: 2407653459860
statestring

The current state of the MSSQL Database

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

Brief reason for the current state of the MSSQL Database

statusstring

The current status of the MSSQL Database.

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

Time in UTC at which the object was last updated.

virtualizationInfoobject
Response
application/json
{
  "applicationHostInfo": {
    "displayName": "My-Test-WindowsHost",
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "host123.hpe.com",
    "resourceUri": "/backup-recovery/v1beta1/application-hosts/{host-id}",
    "type": "string"
  },
  "availabilityGroupInfo": {
    "name": "string",
    "role": "PRIMARY",
    "uid": "7D0563C3-8627-4B33-96C7"
  },
  "clusterInfo": {
    "clustered": false,
    "role": "PRIMARY"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "instanceInfo": {
    "id": "1b738651-da9f-4c85-88c1-70dbfe1976681",
    "name": "string",
    "resourceUri": "/backup-recovery/v1beta1/mssql-instances/{instance-id}",
    "type": "string"
  },
  "mssqlDatabaseProtectionGroupInfo": {
    "id": "1b738651-da9f-4c85-88c1-70dbfe1976681",
    "name": "my-protection-group",
    "resourceUri": "/backup-recovery/v1beta1/mssql-database-protection-groups/{protection-group-id}",
    "type": "string"
  },
  "name": "billing-db1",
  "protectionJobInfo": {
    "id": "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4",
    "name": "string",
    "protectionPolicyInfo": { … },
    "resourceUri": "string",
    "type": "string"
  },
  "protectionStatus": "PROTECTED",
  "recoveryPointsExist": true,
  "resourceUri": "/backup-recovery/v1beta1/mssql-databases/{db-id}",
  "sizeInBytes": 2407653459860,
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "virtualizationInfo": {
    "hypervisorManagerInfo": { … },
    "virtualMachineInfo": { … }
  }
}

Refresh an MSSQL database and its sub-resources.

Request

Refresh an MSSQL database and its sub-resources.

Security
bearer
Path
db-idstringrequired

UUID string uniquely identifying the MSSQL Database

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

Responses

Accepted

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

Restore an MSSQL database from snapshot or backup.

Request

Restores a virtual machine from selected snapshot.

Security
bearer
Path
db-idstringrequired

UUID string uniquely identifying the MSSQL Database

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

Specifies the type of restore needs to be performed.

Enum"PARENT""ALTERNATE"
backupIdstring

UUID string uniquely identifying the backup.

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

The recovery mode the database will be in at the end of restore operation

Enum"WITH_RECOVERY""NO_RECOVERY"
restoreUntilstring(date-time)

Time in UTC upto which the recovery needs to be done. This attribute is required only if restore from log backup is intended.

Example: "2020-03-03T06:03:08.902Z"
restoreWithTailLogboolean

Flag to indicate if the backup operation should backup the tail log

Example: false
snapshotIdstring

UUID string uniquely identifying the snapshot.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
targetDatabaseInfoobject(AlternateMSSQLDatabaseRestoreRequestParams)

Provides the details about target VM location, compute, etc These inputs are required only if the restore type is 'ALTERNATE'.

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/mssql-databases/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/restore \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "restoreType": "PARENT"
  }'

Responses

Accepted

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

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