Skip to main content

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:

    FieldFilter ConditionDescription
    is_deleted$eq,$inThe 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, $eqThe 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$eqThe Clumio-assigned ID of the policy protecting this resource.
    protection_status$inThe protection status of this resource. Possible values include protected, unprotected, and unsupported.
    deactivated$eqFilter assets protected by a deactivated policy.
    organizational_unit_id$inDenotes 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"]}}
    For more information about filtering, refer to the Filtering section of this guide.
  • lookback_days int64

    Calculate backup status for the last lookback_days days.

Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • items object[]

    A collection of requested items.

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

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

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

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

  • backup_status_stats object

    Represents the aggregated stats for backup status.

  • failure_count int64

    The total number of entities that have a backup status of failure.

  • no_backup_count int64

    The total number of entities that have a backup status of no_backup.

  • partial_success_count int64

    The total number of entities that have a backup status of partial_success.

  • success_count int64

    The total number of entities that have a backup status of success.

  • 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[]

    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_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'}]}.

    FieldRule ConditionDescription
    aws_tag$eq, $not_eq, $contains, $not_contains, $all, $not_all, $in, $not_inDenotes the AWS tag(s) to be exactly equal to the specified value.

    {"aws_tag":{"$eq":{"key":"Environment", "value":"Prod"}}}

    aws_account_native_id$eq, $inDenotes 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, $inDenotes 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

    ObjectFilter defines which objects will be backed up.

  • earliest_last_modified_timestamp string

    The cutoff date for inclusion objects from the backup. Any object with a last modified date after or equal than this value will be included in the backup. This is useful for filtering out old or irrelevant objects based on their modification timestamps. This field supports the RFC-3339 format.

  • latest_version_only boolean

    Whether to back up only the latest object version.

  • prefix_filters object[]

    A list of prefixes to include or exclude in this protection group backups. If not specified, then all objects will be backed up.

  • excluded_sub_prefixes string[]

    List of subprefixes to exclude from the prefix.

  • prefix string

    Prefix to include.

  • storage_classes string[]

    Storage class to include in the backup. If not specified, then all objects across all storage classes will be backed up. Valid values are: S3 Standard, S3 Standard-IA, S3 Intelligent-Tiering, and S3 One Zone-IA.

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

  • version int64

    Version of the protection group. The version number is incremented every time a change is made to the protection group.

  • _links object

    URLs to pages related to the resource.

  • _first object

    The HATEOAS link to the first page of results.

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

  • _last object

    The HATEOAS link to the last page of results.

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

  • _next object

    The HATEOAS link to the next page of results.

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

  • _prev object

    The HATEOAS link to the previous page of results.

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

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

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

Loading...