List protection groups
Returns a list of protection groups.
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). - 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:
For more information about filtering, refer to the Filtering section of this guide.Field Filter Condition Description is_deleted $eq,$in The deletion status of the protection group. Set to "true" to retrieve deleted protection group. For example, ?filter={"is_deleted":{"$eq":true}}?filter={"is_deleted":{"$in":["true","false"]}}name $contains, $eq The AWS-assigned name of this resource, can use either the contains or exact equal operator. For example, ?filter={"name":{"$contains":"dev"}}retrieves all protection groups with "dev" in their name.protection_info.policy_id $eq The Clumio-assigned ID of the policy protecting this resource. protection_status $in The protection status of this resource. Possible values include protected,unprotected, andunsupported.deactivated $eq Filter assets protected by a deactivated policy. organizational_unit_id $in Denotes the organizational unit IDs that can own the assets that are returned. For example, ?filter={"organizational_unit_id":{"$in":["c764b152-5819-11ea-bb9f-b2e1c9a040ad","c764abb6-5819-11ea-bb9f-b2e1c9a040ad"]}} - lookback_days int64
Calculate backup status for the last
lookback_daysdays.
Responses
- 200
- default
Success
- application/api.clumio.protection-groups=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
_links object
- current_count int64
The number of items listed on the current page.
- 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": [
{
"_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",
"total_backed_up_object_count": 0,
"total_backed_up_size_bytes": 0,
"version": 0
}
]
},
"_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,
"limit": 0,
"start": "string",
"total_count": 0,
"total_pages_count": 0
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
GET /datasources/protection-groups
Authorization
Request
Request
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups' \
-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' \
-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' \
-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' \
-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' \
-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' \
-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' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'