List Microsoft SQL Server database backups

get deprecatedhttps://{region}.api.clumio.com/backups/mssql/databases

Retrieve a list of Microsoft SQL Server database backups.

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

limit

int64

Limits the size of the response on each page to the specified number of items.

start

string

Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

sort

string

Returns the list of backups in the order specified. Set sort to the name of the sort field by which to sort in ascending order. To sort the list in reverse order, prefix the field name with a minus sign (-). Only one field may be sorted at a time. The following table lists the supported sort fields for this resource:

Sort Field	Description
start_timestamp	Sorts the backups in ascending timestamp order (oldest first). For example, `?sort=start_timestamp`

If a sort order is not specified, the individual rules are sorted by "start_timestamp" in descending timestamp order (newest first).

filter

string

Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

Field	Filter Condition	Description
database_id	$eq	Filter database backups whose database ID equal the specified string.
start_timestamp	$lte, $gt	Filter database backups whose start timestamp is "less than or equal to" or "greater than" a given timestamp.
type	$in	Filter a particular type of database backups. Possible values include `mssql_database_backup`, `mssql_log_backup_full_recovery_model` and `mssql_log_backup_bulk_logged_model`.

For more information about filtering, refer to the Filtering section of this guide.

embed

string

Embeds the details of an associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

Embeddable Link	Description
read-management-group	Embeds the associated management group details in the response. For example, `?embed=read-management-group`
read-management-subgroup	Embeds the associated management subgroup details in the response. For example, `?embed=read-management-subgroup`

For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.

Responses

Response body

object

_embedded

object

Embedded responses related to the resource.

items

array of objects

A collection of requested items.

items

object

_embedded

object

Embedded responses related to the resource.

_links

object

URLs to pages related to the resource.

database_files

array of objects

List of database files at the time of backup.

database_files

object

name

string

The name of the database file.

type

string

The type of the database file. Possible values include sql_row_file and sql_log_file.

database_id

string

The Clumio-assigned ID of the database associated with this backup.

engine

string

The Microsoft SQL database engine at the time of backup.

engine_version

string

The Microsoft SQL database engine version at the time of backup.

expiration_timestamp

string

The timestamp of when this backup expires. Represented in RFC-3339 format.

group_id

string

The Clumio-assigned ID of the management group associated with the database at the time of backup.

host_endpoint

string

The user-provided endpoint of the host containing the given database at the time of backup.

host_id

string

The Clumio-assigned ID of the host associated with the database at the time of backup.

string

required

The Clumio-assigned ID of the backup.

instance_id

string

The Clumio-assigned instance id at the time of backup.

instance_name

string

The instance name at the time of backup.

start_timestamp

string

The timestamp of when this backup started. Represented in RFC-3339 format.

subgroup_id

string

The Clumio-assigned ID of the management subgroup associated with the database at the time of backup.

type

string

The type of backup.

mssql_database_backup mssql_log_backup_full_recovery_model mssql_log_backup_bulk_logged_model

_links

object

URLs to pages related to the resource.

_first

object

The HATEOAS link to the first page of results.

_last

object

The HATEOAS link to the last page of results.

_next

object

The HATEOAS link to the next page of results.

_prev

object

The HATEOAS link to the previous page of results.

_self

object

The HATEOAS link to this resource.

current_count

int64

The number of items listed on the current page.

filter_applied

string

The filter used in the request. The filter includes both manually-specified and system-generated filters.

limit

int64

The maximum number of items displayed per page in the response.

start

string

The page number used to get this response.
Pages are indexed starting from 1 (i.e., "start": "1").

total_count

int64

The total number of items, summed across all pages.

total_pages_count

int64

The total number of pages of results.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-west-2.api.clumio.com/backups/mssql/databases \
3
     --header 'accept: application/api.clumio.backup-mssql-databases=v1+json'


xxxxxxxxxx
83
}
1
{
2
  "_embedded": {
3
    "items": [
4
      {
5
        "_embedded": {},
6
        "_links": {
7
          "_self": {
8
            "href": "string",
9
            "templated": true,
10
            "type": "string"
11
          },
12
          "read-management-group": {
13
            "href": "string",
14
            "templated": true,
15
            "type": "string"
16
          },
17
          "read-management-subgroup": {
18
            "href": "string",
19
            "templated": true,
20
            "type": "string"
21
          },
22
          "restore-mssql-database": {
23
            "href": "string",
24
            "templated": true,
25
            "type": "string"

200200 HTTP success response

defaultError