Retrieve a protection group S3 asset backup

Returns a representation of the specified protection group S3 asset backup.

Path Parameters

backup_id string required
Performs the operation on the backup with the specified ID.

Responses

200
default

Success

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

Schema
Example (from schema)

Schema

_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.
aws_region string
The AWS region in which the instance backup resides. For example, us-west-2.
backed_up_object_count uint64
The number of objects in the protection group S3 asset that were successfully backed up.
backed_up_size_bytes uint64
The total size in bytes of objects in the protection group S3 asset that were successfully backed up.
bucket_id string
The Clumio-assigned ID of the bucket.
bucket_name string
The name of the bucket.
expiration_timestamp string
The timestamp of when this backup expires. Represented in RFC-3339 format.
failed_object_count uint64
The number of objects in the protection group S3 asset that failed to be backed up.
failed_size_bytes uint64
The total size in bytes of objects in the protection group S3 asset that failed to be backed up.
id string
The Clumio-assigned ID of the protection group S3 asset backup.
protection_group_id string
The Clumio-assigned ID of the protection group.
protection_group_s3_asset_id string
The Clumio-assigned ID of the protection group S3 asset.
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_s3_asset_backup.

{
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "aws_region": "string",
  "backed_up_object_count": 0,
  "backed_up_size_bytes": 0,
  "bucket_id": "string",
  "bucket_name": "string",
  "expiration_timestamp": "string",
  "failed_object_count": 0,
  "failed_size_bytes": 0,
  "id": "string",
  "protection_group_id": "string",
  "protection_group_s3_asset_id": "string",
  "protection_group_version": 0,
  "start_timestamp": "string",
  "type": "string"
}

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/s3-assets/:backup_id

Authorization

Request

Click Edit to configure Base URL

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

Bearer Token

backup_id — path required

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

Retrieve a protection group S3 asset backup​

Authorization

Request

Retrieve a protection group S3 asset backup