Skip to main content

Update a GCP protection group​

Updates an existing GCP protection group.

Path Parameters
  • protection_group_id string required

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

Request Body required

The protection group update data

  • add_bucket_uuids string[]

    A list of bucket UUIDs to add to this protection group.

  • bucket_rule object
  • gcp_label object

    At most one include and one exclude operator may be set.

  • $all object[]
  • key string
  • value string
  • $contains object
  • key string
  • value string
  • $eq object
  • key string
  • value string
  • $in object[]
  • key string
  • value string
  • $not_all object[]
  • key string
  • value string
  • $not_contains object
  • key string
  • value string
  • $not_eq object
  • key string
  • value string
  • $not_in object[]
  • key string
  • value string
  • gcp_location object
  • $eq string
  • $in string[]
  • $not_eq string
  • $not_in string[]
  • gcp_project_id object
  • $eq string
  • $in string[]
  • $not_eq string
  • $not_in string[]
  • clear_bucket_rule boolean

    Set to true to remove an existing bucket rule from this protection group. Mutually exclusive with bucket_rule.

  • exclude_prefixes string[]

    A list of prefixes to exclude from the backup. If multiple prefixes are specified, then any object whose path matches one of the prefixes will be excluded from the backup. Part of the PUT-style filter trio (see model docs); a non-nil empty list clears existing excludes, while omitting the field leaves the filter unchanged unless another trio field is present.

  • include_prefixes string[]

    A list of prefixes to include in the backup. If multiple prefixes are specified, then any object whose path matches one of the prefixes will be included in the backup. Part of the PUT-style filter trio (see model docs); a non-nil empty list clears existing includes, while omitting the field leaves the filter unchanged unless another trio field is present.

  • latest_version_only boolean

    Whether to back up only the latest object version. Part of the PUT-style filter trio (see model docs); when any trio field is present, an absent latest_version_only defaults to true.

  • name string

    The user-assigned name of the protection group.

  • remove_bucket_uuids string[]

    A list of bucket UUIDs to remove from this protection group.

Responses

Success

Schema
  • _etag string
  • 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.

  • bucket_count int64

    The total number of unique buckets in this protection group (manual + rule-matched, deduplicated).

  • bucket_rule object
  • gcp_label object

    At most one include and one exclude operator may be set.

  • $all object[]
  • key string
  • value string
  • $contains object
  • key string
  • value string
  • $eq object
  • key string
  • value string
  • $in object[]
  • key string
  • value string
  • $not_all object[]
  • key string
  • value string
  • $not_contains object
  • key string
  • value string
  • $not_eq object
  • key string
  • value string
  • $not_in object[]
  • key string
  • value string
  • gcp_location object
  • $eq string
  • $in string[]
  • $not_eq string
  • $not_in string[]
  • gcp_project_id object
  • $eq string
  • $in string[]
  • $not_eq string
  • $not_in string[]
  • bucket_rule_matched_bucket_count int64

    The number of buckets auto-included by the bucket rule.

  • bucket_rule_matched_bucket_uuids string[]

    The set of bucket UUIDs auto-included by the bucket rule. NOTE: A bucket that is both directly assigned and rule-matched will appear in both bucket_uuids and this field. Deduplicate before computing totals. Always returned on read/create/update. On the list endpoint, only returned when bucket_uuid_detail is "all" or "bucket_rule".

  • bucket_uuids string[]

    The set of bucket UUIDs directly assigned to this protection group (via manual membership). Does not include buckets auto-included by a bucket rule; see bucket_rule_matched_bucket_uuids for those. Always returned on read/create/update. On the list endpoint, only returned when bucket_uuid_detail is "all" or "manual".

  • created_timestamp string

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

  • filter object
  • exclude_object_name_prefix_regexes string[]

    A list of prefixes to exclude from the backup. If multiple prefixes are specified, then any object whose path matches one of the prefixes will be excluded from the backup.

  • include_object_name_prefix_regexes string[]

    A list of prefixes to include in the backup. If multiple prefixes are specified, then any object whose path matches one of the prefixes will be included in the backup.

  • latest_version boolean

    Specifies that the protection group is configured with the latest version of the filter.

  • updated_after string

    Only backup objects that were created or last modified after this timestamp (in RFC-3339 format).

  • id string

    The Clumio-assigned ID of the protection group.

  • is_deleted boolean

    Determines whether the protection group is active or has been deleted.

  • labels object[]

    GCP labels (key-value pairs) associated with the protection group.

  • key string

    The GCP-assigned label key.

  • value string

    The GCP-assigned label value.

  • last_backup_timestamp string

    Time of the last backup in RFC-3339 format.

  • location string

    The location of the protection group (e.g., "us-central1", "us", "us-west1").

  • location_type string

    The location type of the protection group (e.g., "Region", "Dual-region", "Multi-region").

  • manual_added_bucket_count int64

    The number of buckets directly assigned to this protection group (via manual membership). Does not include buckets auto-included by a bucket rule; see bucket_rule_matched_bucket_count for those.

  • modified_timestamp string

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

  • name string

    The user-assigned name of the protection group.

  • organizational_unit_id string

    The Clumio-assigned ID of the organizational unit associated with the Protection Group.

  • protection_info object
  • policy_id string

    The Clumio-assigned ID of the policy protecting this resource.

  • protection_status string

    The protection status of this resource. Possible values include "protected", "unprotected".

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

Loading...