Skip to content
Internal API Catalog
/
Backup and Recovery API
/
API reference
/
v1beta1
/
mssql-database-snapshots

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

mssql-database-snapshots

The MSSQL database snapshots API allows the creation and management of MSSQL database snapshots.

Operations

Get information about all MSSQL database snapshots.

Request

Get information about all MSSQL database snapshots.

Security
bearer
Path
db-idstringrequired

UUID string uniquely identifying the MSSQL Database

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
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 comparision 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-databases/{db-id}/snapshots?filter="consistency eq APPLICATION"

Filters are supported on the following attributes:

  • snapshotType
  • state
  • status
  • createdByInfo/id
  • createdByInfo/name
  • storageSystemInfo/id
  • storageSystemInfo/type
  • storageSystemInfo/name
  • verified
  • consistency
  • pointInTime
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-databases/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/snapshots \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

MSSQL database snapshots list

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

UUID string uniquely identifying the snapshot.

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

The type of resource.

items[].​associatedDatabasesArray of objects

Details of the databases whose backup is also part of this snapshot object. On deleting this snapshot object the backed up data of the associated databases which is part of this snapshot is also deleted

items[].​createdByInfoobject

Information about the user who initiated the workflow that created this snapshot or template.

items[].​customerIdstring

The customer application identifier.

items[].​descriptionstring

Brief description about the application snapshot.

items[].​expiresAtstring(date-time)

Absolute value of time in UTC at which the snapshot expires.

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[].​lockedUntilstring(date-time)

Absolute value of time in UTC until which the application snapshot is locked.

Example: "2020-04-03T05:03:08.900Z"
items[].​logBackupInfoobject
items[].​namestring

Name of the application snapshot.

Example: "Nimble-DB1-snap"
items[].​pointInTimestring(date-time)

Time in UTC at which the application snapshot was created on the device.

Example: "2020-03-03T05:03:08.902Z"
items[].​resourceUristring

The 'self' reference for this resource.

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

Details about the schedule which created this snapshot.

items[].​snapshotTypestring
Value"SNAPSHOT"
items[].​statestring

The current state of the application snapshot.

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

Brief reason for the current state of the application snapshot.

items[].​statusstring

Current status of the application snapshot.

Enum"OK""ERROR""WARNING"
items[].​storageSystemsInfoArray of objects(StorageSysInfo)

Storage info details of this MSSQL Database

items[].​updatedAtstring(date-time)

Time in UTC at which the object was last updated.

items[].​volumesSnapshotInfoArray of objects(VolumeSnapshotInfo)

Details of the associated snapshot volumes

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
}

Delete an MSSQL database snapshot.

Request

Remove an MSSQL database snapshot.

Security
bearer
Path
db-idstringrequired

UUID string uniquely identifying the MSSQL Database

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
snapshot-idstringrequired

UUID string uniquely identifying the snapshot.

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

Responses

Accepted

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

Get details of a MSSQL database snapshot.

Request

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

Security
bearer
Path
db-idstringrequired

UUID string uniquely identifying the MSSQL Database

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
snapshot-idstringrequired

UUID string uniquely identifying the snapshot.

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

Responses

Detailed information of a MSSQL database snapshot

Bodyapplication/json
idstringrequired

UUID string uniquely identifying the snapshot.

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

The type of resource.

associatedDatabasesArray of objects

Details of the databases whose backup is also part of this snapshot object. On deleting this snapshot object the backed up data of the associated databases which is part of this snapshot is also deleted

createdByInfoobject

Information about the user who initiated the workflow that created this snapshot or template.

customerIdstring

The customer application identifier.

descriptionstring

Brief description about the application snapshot.

expiresAtstring(date-time)

Absolute value of time in UTC at which the snapshot expires.

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.

lockedUntilstring(date-time)

Absolute value of time in UTC until which the application snapshot is locked.

Example: "2020-04-03T05:03:08.900Z"
logBackupInfoobject
namestring

Name of the application snapshot.

Example: "Nimble-DB1-snap"
pointInTimestring(date-time)

Time in UTC at which the application snapshot was created on the device.

Example: "2020-03-03T05:03:08.902Z"
resourceUristring

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/mssql-databases/{db-id}/snapshots/{snapshot-id}"
scheduleInfoobject

Details about the schedule which created this snapshot.

snapshotTypestring
Value"SNAPSHOT"
statestring

The current state of the application snapshot.

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

Brief reason for the current state of the application snapshot.

statusstring

Current status of the application snapshot.

Enum"OK""ERROR""WARNING"
storageSystemsInfoArray of objects(StorageSysInfo)

Storage info details of this MSSQL Database

updatedAtstring(date-time)

Time in UTC at which the object was last updated.

volumesSnapshotInfoArray of objects(VolumeSnapshotInfo)

Details of the associated snapshot volumes

Response
application/json
{
  "associatedDatabases": [
    { … }
  ],
  "createdByInfo": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "customerId": "string",
  "description": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "generation": 0,
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "lockedUntil": "2020-04-03T05:03:08.900Z",
  "logBackupInfo": {
    "lastLogBackupTime": "2020-03-03T06:03:08.902Z",
    "protectionStoreInfo": { … },
    "storageSystemInfo": { … }
  },
  "name": "Nimble-DB1-snap",
  "pointInTime": "2020-03-03T05:03:08.902Z",
  "resourceUri": "/backup-recovery/v1beta1/mssql-databases/{db-id}/snapshots/{snapshot-id}",
  "scheduleInfo": {
    "id": "string",
    "name": "Hourly snapshot schedule",
    "recurrence": "BY_MINUTES"
  },
  "snapshotType": "SNAPSHOT",
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "storageSystemsInfo": [
    { … }
  ],
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "volumesSnapshotInfo": [
    { … }
  ]
}

Update a MSSQL database snapshot.

Request

Update attributes for a MSSQL database snapshot.

Security
bearer
Path
db-idstringrequired

UUID string uniquely identifying the MSSQL Database

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
snapshot-idstringrequired

UUID string uniquely identifying the snapshot.

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

Brief description about the application snapshot.

expiresAtstring(date-time)

Absolute value of time in UTC at which the snapshot expires.

lockedUntilstring(date-time)

Absolute value of time in UTC until which the application snapshot is locked.

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-databases/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/snapshots/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-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