Create a protection group

Creates a new protection group by specifying object filters. Appearance in datasources/protection-groups read/listing is asynchronous and may take a few seconds to minutes at most. As a result, the protection group won't be protectable via /policies/assignments until it appears in the /datasources/protection-groups endpoint. Additionally, to create a protection group in the context of another Organizational Unit, refer to the Getting Started documentation.

application/json

Request Body required

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"}}`

description string
The user-assigned description of the protection group.
name string required
The user-assigned name of the protection group.
object_filter object required
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[] required
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.

Responses

200
default

Success

application/api.clumio.protection-groups=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
_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.
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.

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.
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.
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"
    }
  },
  "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",
  "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",
  "total_backed_up_object_count": 0,
  "total_backed_up_size_bytes": 0,
  "version": 0
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

POST /protection-groups

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

Body required

{
  "bucket_rule": "string",
  "description": "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"
    ]
  }
}

curl -L -X POST 'https://us-west-2.api.clumio.com/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "bucket_rule": "string",
  "description": "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"
    ]
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "bucket_rule": "string",
  "description": "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"
    ]
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "bucket_rule": "string",
  "description": "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"
    ]
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "bucket_rule": "string",
  "description": "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"
    ]
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "bucket_rule": "string",
  "description": "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"
    ]
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "bucket_rule": "string",
  "description": "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"
    ]
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "bucket_rule": "string",
  "description": "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"
    ]
  }
}'