List S3 assets contained within protection groups.

Returns a list of protection group S3 assets.

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:

Field	Filter Condition	Description
account_native_id	$eq	The AWS-assigned ID of the AWS account. For example, `?filter={"account_native_id":{"$eq":"789901323485"}}`
aws_region	$eq	The AWS region of a given account to which this resource belongs. For example, `?filter={"account_native_id":{"$eq":"789901323485"}, "aws_region":{"$eq":"us-east-1"}}` retrieves DynamoDB tables in region us-east-1 in account 789901323485.
bucket_id	$eq	The Clumio-assigned ID of the AWS S3 bucket. Retrieves the protection group s3 assets within this S3 bucket.
bucket_name	$eq,$contains	The AWS-assigned ID or name of the bucket. Retrieves the protection group s3 assets within this S3 bucket.
environment_id	$eq	The Clumio-assigned ID of the AWS environment.
is_deleted	$eq,$in	The deletion status of this resource. If not specified, retrieves only active protection group buckets. `?filter={"is_deleted":{"$in":["true","false"]}}`
protection_group_id	$eq	The Clumio-assigned ID of the protection group of this resource. Retrieves the protection group s3 assets within this protection group.
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`, and `unsupported`.
deactivated	$eq	Filter assets protected by a deactivated policy.
backup_status	$in	The backup status of this resource. Possible values include `success`, `partial_success`, `failure` and `no_backup`.
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"]}}`
added_by	$in	The method of addition used to create a protection group s3 asset. Possible values include `user` and `bucket_rule`.
is_supported	$eq	The Clumio supported status for the S3 bucket. For example, `?filter={"is_supported":{"$eq":true}}`

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

200
default

Success

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

Schema
Example (from schema)

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.
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-group-s3-assets 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.
account_native_id string
The AWS-assigned ID of the account associated with the DynamoDB table.
added_by_bucket_rule boolean
Whether this bucket was added to this protection group by the bucket rule
added_by_user boolean
Whether this bucket was added to this protection group by the user
aws_region string
The AWS region associated with the DynamoDB table.
backup_status_info object
The backup status information applied to this resource.
backup_status string
BackupStatus is the status of the backup. Possible values are success, partial_success, failure, no_backup, and unknown. This value depends on lookback_days. If not specified, then this field has a value of unknown.
last_failed_policy_start_timestamp string
The last failed policy start time. Represented in RFC-3339 format.
last_successful_policy_start_timestamp string
The last successful policy start time. Represented in RFC-3339 format.
operation_info_list object[]
The policy operation information of the backups.
backup_status string
BackupStatus is the status of the backup. Possible values are success, partial_success, failure, no_backup, and unknown. This value depends on lookback_days. If not specified, then this field has a value of unknown.
last_failed_policy_start_timestamp string
The last failed policy start time. Represented in RFC-3339 format.
last_successful_policy_start_timestamp string
The last successful policy start time. Represented in RFC-3339 format.
operation string
The policy operation type.
backup_target_aws_region string
The backup target AWS region associated with the protection group S3 asset.
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_id string
The Clumio-assigned ID of the bucket
bucket_name string
The name of the bucket
created_timestamp string
Creation time of the protection group in RFC-3339 format.
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.
environment_id string
The Clumio-assigned ID of the AWS environment associated with the protection group.
group_id string
The Clumio-assigned ID of the protection group
group_name string
The name of the protection group
id string
The Clumio-assigned ID that represents the bucket within the protection group.
is_deleted boolean
Determines whether the protection group bucket has been deleted
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.
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 Type Details
aws_tag AWS tag.
policy_id string
A system-generated ID assigned to the policy protecting this resource.
protection_stats object
A substruct that only includes protected_count and unprotected_count which can be used in common by other structs.
deactivated_count int64
The total number of entities associated with deactivated policies.
protected_count int64
The number of entities with protection applied.
unprotected_count int64
The number of entities without protection applied.
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
unsupported_reason string
The unsupported reason for the S3 bucket.
_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.

Inheriting Entity Type	Details
aws_tag	AWS tag.

{
  "_embedded": {
    "items": [
      {
        "_embedded": {},
        "_links": {
          "_self": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "delete-bucket-protection-group": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "list-backup-protection-group-s3-assets": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "read-organizational-unit": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "read-policy-definition": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "account_native_id": "string",
        "added_by_bucket_rule": true,
        "added_by_user": true,
        "aws_region": "string",
        "backup_status_info": {
          "backup_status": "string",
          "last_failed_policy_start_timestamp": "string",
          "last_successful_policy_start_timestamp": "string",
          "operation_info_list": [
            {
              "backup_status": "string",
              "last_failed_policy_start_timestamp": "string",
              "last_successful_policy_start_timestamp": "string",
              "operation": "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_id": "string",
        "bucket_name": "string",
        "created_timestamp": "string",
        "earliest_available_backup_timestamp": "string",
        "environment_id": "string",
        "group_id": "string",
        "group_name": "string",
        "id": "string",
        "is_deleted": true,
        "last_backup_timestamp": "string",
        "last_continuous_backup_timestamp": "string",
        "organizational_unit_id": "string",
        "protection_info": {
          "inheriting_entity_id": "string",
          "inheriting_entity_type": "string",
          "policy_id": "string"
        },
        "protection_stats": {
          "deactivated_count": 0,
          "protected_count": 0,
          "unprotected_count": 0
        },
        "protection_status": "string",
        "total_backed_up_object_count": 0,
        "total_backed_up_size_bytes": 0,
        "unsupported_reason": "string"
      }
    ]
  },
  "_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[]
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"
    }
  ]
}

GET /datasources/protection-groups/s3-assets

Authorization

Request

Click Edit to configure Base URL

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

Bearer Token

limit — query

start — query

filter — query

lookback_days — query

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/s3-assets' \
-H 'Accept: application/api.clumio.protection-groups-s3-assets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/s3-assets' \
-H 'Accept: application/api.clumio.protection-groups-s3-assets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/s3-assets' \
-H 'Accept: application/api.clumio.protection-groups-s3-assets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/s3-assets' \
-H 'Accept: application/api.clumio.protection-groups-s3-assets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/s3-assets' \
-H 'Accept: application/api.clumio.protection-groups-s3-assets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/s3-assets' \
-H 'Accept: application/api.clumio.protection-groups-s3-assets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/protection-groups/s3-assets' \
-H 'Accept: application/api.clumio.protection-groups-s3-assets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'