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

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

Get all discovered MSSQL instances.

Request

List all the discovered MSSQL instances.

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-instances?filter="productName eq Microsoft+SQL+Server+2012+R2"
  • GET /backup-recovery/v1beta1/mssql-instances?filter="applicationHostInfo/name eq my-host-1 and status eq Error"

Filters are supported on the following attributes:

  • state
  • status
  • createdAt
  • name
  • productName
  • productVersion
  • applicationHostInfo/id
  • applicationHostInfo/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-instances \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

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

UUID string uniquely identifying the MSSQL Instance

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

The type of resource.

items[].​applicationHostInfoobject

The application host on which the instance exists.

items[].​availabilityGroupsInfoArray of objects(MSSQLAvailabilityGroup)

The list of availability groups that are part of the instance.

items[].​clusteredboolean

Indicates if the mssql instance is part of a cluster

Example: false
items[].​createdAtstring(date-time)

Time in UTC at which the object was created.

items[].​credentialsobject

MSSQL instance credentials info

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[].​namestring<= 80 charactersread-only

Name of the MSSQL instance as configured in the application host

Example: "mssql-instance-1"
items[].​productNamestring

A name identifying the MSSQL database software product.

Example: "Microsoft SQL Server 2012 R2"
items[].​productVersionstring

Version of the MSSQL databse software.

Example: "10.3.2"
items[].​resourceUristring

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/mssql-instances/{instance-id}"
items[].​statestring

The current state of the MSSQL instance

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

Brief reason for the current state of the MSSQL instance

items[].​statusstring

The current status of the MSSQL instance.

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 instance resource identified by {instance-id}.

Request

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

Security
bearer
Path
instance-idstringrequired

UUID string uniquely identifying the MSSQL Instance

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

Responses

Success

Bodyapplication/json
idstringrequired

UUID string uniquely identifying the MSSQL Instance

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

The type of resource.

applicationHostInfoobject

The application host on which the instance exists.

availabilityGroupsInfoArray of objects(MSSQLAvailabilityGroup)

The list of availability groups that are part of the instance.

clusteredboolean

Indicates if the mssql instance is part of a cluster

Example: false
createdAtstring(date-time)

Time in UTC at which the object was created.

credentialsobject

MSSQL instance credentials info

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.

namestring<= 80 charactersread-only

Name of the MSSQL instance as configured in the application host

Example: "mssql-instance-1"
productNamestring

A name identifying the MSSQL database software product.

Example: "Microsoft SQL Server 2012 R2"
productVersionstring

Version of the MSSQL databse software.

Example: "10.3.2"
resourceUristring

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/mssql-instances/{instance-id}"
statestring

The current state of the MSSQL instance

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

Brief reason for the current state of the MSSQL instance

statusstring

The current status of the MSSQL instance.

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"
  },
  "availabilityGroupsInfo": [
    { … }
  ],
  "clustered": false,
  "createdAt": "2019-08-24T14:15:22Z",
  "credentials": {
    "mode": "WINDOWS",
    "username": "string"
  },
  "customerId": "string",
  "generation": 0,
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "name": "mssql-instance-1",
  "productName": "Microsoft SQL Server 2012 R2",
  "productVersion": "10.3.2",
  "resourceUri": "/backup-recovery/v1beta1/mssql-instances/{instance-id}",
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "virtualizationInfo": {
    "hypervisorManagerInfo": { … },
    "virtualMachineInfo": { … }
  }
}

Update an MSSQL instance.

Request

Update attributes of an MSSQL instance.

Security
bearer
Path
instance-idstringrequired

UUID string uniquely identifying the MSSQL Instance

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

MSSQL instance credentials.

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/v1beta1/mssql-instances/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
{}

Refresh an MSSQL Instance.

Request

Refresh the specified mssql-instance.

Security
bearer
Path
instance-idstringrequired

UUID string uniquely identifying the MSSQL Instance

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

Responses

Accepted

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

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