Retrieve an protection group
Returns a representation of the specified protection group.
Path Parameters
- group_id string required
Performs the operation on the ProtectionGroup with the specified ID.
Query Parameters
- lookback_days int64
Calculate backup status for the last
lookback_days
days.
- 200
- default
Success
- application/api.clumio.protection-groups=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
_links object
backup_status_stats object
- backup_target_aws_region string
The backup target AWS region associated with the protection group, empty if in-region or not configured.
backup_tier_stats object[]
- bucket_count int64
Number of buckets
- bucket_rule string
The following table describes the possible conditions for a bucket to be automatically added to a protection group.
Denotes the properties to conditionalize on. For
$eq
,$not_eq
,$contains
and$not_contains
a single element is provided:{'$eq':{'key':'Environment', 'value':'Prod'}}
. For all other other operations, a list is provided:{'$in':[{'key':'Environment','value':'Prod'}, {'key':'Hello', 'value':'World'}]}
.Field Rule Condition Description aws_tag $eq, $not_eq, $contains, $not_contains, $all, $not_all, $in, $not_in Denotes the AWS tag(s) to be exactly equal to the specified value. {"aws_tag":{"$eq":{"key":"Environment", "value":"Prod"}}}
aws_account_native_id $eq, $in Denotes the AWS account to be exactly equal to the specified value. {"aws_account_native_id":{"$eq":"111111111111"}}
account_native_id
Deprecated$eq, $in This field will be deprecated. Use aws_account_native_id instead.
Denotes the AWS account to be exactly equal to the specified value.
{"account_native_id":{"$eq":"111111111111"}}
aws_region $eq, $in Denotes the AWS region to be exactly equal to the specified value. {"aws_region":{"$eq":"us-west-2"}}
- created_timestamp string
Creation time of the protection group in RFC-3339 format.
- description string
The user-assigned description of the protection group.
- 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.
- id string
The Clumio-assigned ID of the protection group.
- is_backup_target_region_configured boolean
Whether the protection group already has a backup target configured by a policy, or is open to be protected by an in-region or out-of-region S3 policy.
- is_deleted boolean
Determines whether the protection group is active or has been deleted. Deleted protection groups may be purged after some time once there are no active backups associated with it.
- 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.
- modified_timestamp string
Modified time of the protection group in RFC-3339 format.
- name string
The user-assigned name of the protection group.
object_filter object
- organizational_unit_id string
The Clumio-assigned ID of the organizational unit associated with the Protection Group.
protection_info object
- 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
. - regions string[]
The list of AWS regions that this protection group is linked to
- 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
- version int64
Version of the protection group. The version number is incremented every time a change is made to the protection group.
{
"_embedded": {},
"_links": {
"_self": {
"href": "string",
"templated": true,
"type": "string"
},
"add-bucket-protection-group": {
"href": "string",
"templated": true,
"type": "string"
},
"delete-bucket-protection-group": {
"href": "string",
"templated": true,
"type": "string"
},
"list-backup-protection-groups": {
"href": "string",
"templated": true,
"type": "string"
},
"read-organizational-unit": {
"href": "string",
"templated": true,
"type": "string"
},
"read-policy-definition": {
"href": "string",
"templated": true,
"type": "string"
},
"update-protection-group": {
"href": "string",
"templated": true,
"type": "string"
}
},
"backup_status_stats": {
"failure_count": 0,
"no_backup_count": 0,
"partial_success_count": 0,
"success_count": 0
},
"backup_target_aws_region": "string",
"backup_tier_stats": [
{
"backup_tier": "string",
"total_backed_up_object_count": 0,
"total_backed_up_size_bytes": 0
}
],
"bucket_count": 0,
"bucket_rule": "string",
"created_timestamp": "string",
"description": "string",
"earliest_available_backup_timestamp": "string",
"id": "string",
"is_backup_target_region_configured": true,
"is_deleted": true,
"last_backup_timestamp": "string",
"last_continuous_backup_timestamp": "string",
"modified_timestamp": "string",
"name": "string",
"object_filter": {
"earliest_last_modified_timestamp": "string",
"latest_version_only": true,
"prefix_filters": [
{
"excluded_sub_prefixes": [
"string"
],
"prefix": "string"
}
],
"storage_classes": [
"string"
]
},
"organizational_unit_id": "string",
"protection_info": {
"inheriting_entity_id": "string",
"inheriting_entity_type": "string",
"policy_id": "string"
},
"protection_status": "string",
"regions": [
"string"
],
"total_backed_up_object_count": 0,
"total_backed_up_size_bytes": 0,
"version": 0
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
GET /datasources/protection-groups/:group_id
Authorization
Request
Request
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/:group_id' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/:group_id' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/:group_id' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/:group_id' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/:group_id' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/:group_id' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/:group_id' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'