Skip to main content

Add bucket to protection group

Adds a bucket to protection group and creates a child protection group S3 asset. Appearance in /datasources/protection-groups/s3-assets read/listing is asynchronous and may take a few seconds to minutes at most. Must be in the same OU context as the creator of this protection group. Bucket ID in body can be found in datasources/aws/s3.

Path Parameters
  • group_id string required

    ID of the protection group

Request Body required
  • bucket_id string
Responses

Success


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

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

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

POST /protection-groups/:group_id/buckets    

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
group_id — path required
Body required
{
"bucket_id": "string"
}
curl -L -X POST 'https://us-west-2.api.clumio.com/protection-groups/:group_id/buckets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"bucket_id": "string"
}'