Skip to main content

Retrieve an S3 asset within a protection group.

Returns a representation of the specified protection group S3 asset.

Path Parameters
  • protection_group_s3_asset_id string required

    Performs the operation on the protection group S3 asset with the specified ID.

Query Parameters
  • lookback_days int64

    Calculate backup status for the last lookback_days days.

Responses

Success


Schema
  • _embedded object

    Embedded responses related to the resource.

  • read-organizational-unit

    This embed is for internal use only since an embed results in additional HTTP calls. "embeds" can affect the performance of "list" API calls as an embed is processed once per item in the result list.

  • read-policy-definition Embeds the associated policy of a protected resource in the response if requested using the `embed` query parameter. Unprotected resources will not have an associated policy.

    Embeds the associated policy of a protected resource in the response if requested using the embed query parameter. Unprotected resources will not have an associated policy.

  • _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.

  • delete-bucket-protection-group object

    A resource-specific HATEOAS link.

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

  • list-backup-protection-group-s3-assets object

    A resource-specific HATEOAS link.

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

  • read-organizational-unit object

    A resource-specific HATEOAS link.

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

  • read-policy-definition object

    A HATEOAS link to the policy protecting this resource. Will be omitted for unprotected entities.

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

  • account_native_id string

    The AWS-assigned ID of the account associated with the DynamoDB table.

  • added_by_bucket_rule boolean

    Whether this bucket was added to this protection group by the bucket rule

  • added_by_user boolean

    Whether this bucket was added to this protection group by the user

  • aws_region string

    The AWS region associated with the DynamoDB table.

  • backup_status_info object

    The backup status information applied to this resource.

  • backup_status string

    BackupStatus is the status of the backup. Possible values are success, partial_success, failure, no_backup, and unknown. This value depends on lookback_days. If not specified, then this field has a value of unknown.

  • last_failed_policy_start_timestamp string

    The last failed policy start time. Represented in RFC-3339 format.

  • last_successful_policy_start_timestamp string

    The last successful policy start time. Represented in RFC-3339 format.

  • operation_info_list object[]

    The policy operation information of the backups.

  • backup_status string

    BackupStatus is the status of the backup. Possible values are success, partial_success, failure, no_backup, and unknown. This value depends on lookback_days. If not specified, then this field has a value of unknown.

  • last_failed_policy_start_timestamp string

    The last failed policy start time. Represented in RFC-3339 format.

  • last_successful_policy_start_timestamp string

    The last successful policy start time. Represented in RFC-3339 format.

  • operation string

    The policy operation type.

  • backup_target_aws_region string

    The backup target AWS region associated with the protection group S3 asset.

  • backup_tier_stats object[]

    TotalBackedUpSizeBytes, TotalBackedUpObjectCount for each backup tier

  • backup_tier string

    The backup tier name.

  • total_backed_up_object_count int64

    Cumulative count of all unexpired objects in each backup (any new or updated since the last backup) that have been backed up as part of this protection group

  • total_backed_up_size_bytes int64

    Cumulative size of all unexpired objects in each backup (any new or updated since the last backup) that have been backed up as part of this protection group

  • bucket_id string

    The Clumio-assigned ID of the bucket

  • bucket_name string

    The name of the bucket

  • created_timestamp string

    Creation time of the protection group in RFC-3339 format.

  • earliest_available_backup_timestamp string

    Timestamp of the earliest protection group backup which has not expired yet. Represented in RFC-3339 format. Only available for Read API.

  • environment_id string

    The Clumio-assigned ID of the AWS environment associated with the protection group.

  • group_id string

    The Clumio-assigned ID of the protection group

  • group_name string

    The name of the protection group

  • id string

    The Clumio-assigned ID that represents the bucket within the protection group.

  • is_deleted boolean

    Determines whether the protection group bucket has been deleted

  • last_backup_timestamp string

    Time of the last backup in RFC-3339 format.

  • last_continuous_backup_timestamp string

    Time of the last successful continuous backup in RFC-3339 format.

  • organizational_unit_id string

    The Clumio-assigned ID of the organizational unit associated with the protection group.

  • protection_info object

    The protection policy applied to this resource. If the resource is not protected, then this field has a value of null.

  • inheriting_entity_id string

    The ID of the entity from which protection was inherited. If protection was not inherited, then this field has a value of null.

  • inheriting_entity_type string

    The type of entity from which protection was inherited. If protection was not inherited, then this field has a value of null.
    Entities from which protection can be inherited include the following:

    Inheriting Entity TypeDetails
    aws_tagAWS tag.
  • policy_id string

    A system-generated ID assigned to the policy protecting this resource.

  • protection_stats object

    A substruct that only includes protected_count and unprotected_count which can be used in common by other structs.

  • deactivated_count int64

    The total number of entities associated with deactivated policies.

  • protected_count int64

    The number of entities with protection applied.

  • unprotected_count int64

    The number of entities without protection applied.

  • protection_status string

    The protection status of the protection group. Possible values include "protected", "unprotected", and "unsupported". If the protection group does not support backups, then this field has a value of unsupported.

  • total_backed_up_object_count int64

    Cumulative count of all unexpired objects in each backup (any new or updated since the last backup) that have been backed up as part of this protection group

  • total_backed_up_size_bytes int64

    Cumulative size of all unexpired objects in each backup (any new or updated since the last backup) that have been backed up as part of this protection group

  • unsupported_reason string

    The unsupported reason for the S3 bucket.

GET /datasources/protection-groups/s3-assets/:protection_group_s3_asset_id    

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
protection_group_s3_asset_id — path required
lookback_days — query
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/s3-assets/:protection_group_s3_asset_id' \
-H 'Accept: application/api.clumio.protection-groups-s3-assets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'