List protection group backups

Retrieves a list of protection group backups.

Query Parameters

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).

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

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:

protection_group_id	$eq	The ID of the protection group. For example, `?filter={"protection_group_id":{"$eq":"d0ba78cc-582b-11ea-9bdc-82f798bd42fe"}}`
start_timestamp	$lte, $gt	The timestamp value of when the backup started. Represented in RFC-3339 format. For example, `?filter={"start_timestamp":{"$lte":"1985-04-12T23:20:50Z"}}`

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

Responses

200
default

Success

application/api.clumio.backup-protection-groups=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
_links object
URLs to pages related to the resource.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
backed_up_object_count int64
The number of objects in the protection group that were successfully backed up.
backed_up_size_bytes int64
The total size in bytes of objects in the protection group that were successfully backed up.
expiration_timestamp string
The timestamp of when this backup expires. Represented in RFC-3339 format.
failed_object_count int64
The number of objects in the protection group that failed to be backed up.
failed_size_bytes int64
The total size in bytes of objects in the protection group that failed to be backed up.
id string
The Clumio-assigned ID of the protection group backup.
protection_group_id string
The Clumio-assigned ID of the protection group.
protection_group_name string
The user-assigned name of the protection group.
protection_group_version int64
The version of the protection group at the time the backup was taken.
start_timestamp string
The timestamp of when this backup started. Represented in RFC-3339 format.
type string
The type of backup. Possible values include protection_group_backup.
_links object
URLs to pages related to the resource.
_first object
The HATEOAS link to the first page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_last object
The HATEOAS link to the last page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_next object
The HATEOAS link to the next page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_prev object
The HATEOAS link to the previous page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
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.

{
  "_embedded": {
    "items": [
      {
        "_links": {
          "_self": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "backed_up_object_count": 0,
        "backed_up_size_bytes": 0,
        "expiration_timestamp": "string",
        "failed_object_count": 0,
        "failed_size_bytes": 0,
        "id": "string",
        "protection_group_id": "string",
        "protection_group_name": "string",
        "protection_group_version": 0,
        "start_timestamp": "string",
        "type": "string"
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_last": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_prev": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "filter_applied": "string",
  "limit": 0,
  "start": "string",
  "total_count": 0,
  "total_pages_count": 0
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

GET /backups/protection-groups

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

limit — query

start — query

sort — query

filter — query

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/protection-groups' \
-H 'Accept: application/api.clumio.backup-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/protection-groups' \
-H 'Accept: application/api.clumio.backup-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/protection-groups' \
-H 'Accept: application/api.clumio.backup-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/protection-groups' \
-H 'Accept: application/api.clumio.backup-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/protection-groups' \
-H 'Accept: application/api.clumio.backup-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/protection-groups' \
-H 'Accept: application/api.clumio.backup-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/protection-groups' \
-H 'Accept: application/api.clumio.backup-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'