List policies

get https://{region}.api.clumio.com/policies/definitions

Returns a list of policies and their configurations. The following table describes the supported policy operations.

Operation	Description
vmware_vm_backup	VMware VM backup.
aws_ebs_volume_backup	AWS EBS volume backup.
aws_ebs_volume_snapshot	AWS EBS volume snapshot stored in customer's AWS account.
aws_ec2_instance_backup	AWS EC2 instance backup.
aws_ec2_instance_snapshot	AWS EC2 instance snapshot stored in customer's AWS account.
ec2_mssql_database_backup	AWS EC2 MSSQL database backup.
ec2_mssql_log_backup	AWS EC2 MSSQL log backup.
aws_rds_resource_aws_snapshot	AWS RDS snapshot stored in the customer's AWS account.
aws_rds_resource_rolling_backup	AWS RDS backup stored in Clumio.
aws_rds_resource_granular_backup	AWS RDS granular backup stored in Clumio.
aws_dynamodb_table_snapshot	AWS DynamoDB table snapshot stored in customer's AWS account.
aws_dynamodb_table_pitr	AWS DynamoDB table point-in-time recovery.
protection_group_backup	AWS S3 Protection Group backup.
microsoft365_mailbox_backup	Microsoft365 mailbox backup.
microsoft365_onedrive_backup	Microsoft365 onedrive backup.
microsoft365_share_point_backup	Microsoft365 site backup.
mssql_database_backup	VMC MSSQL database backup stored in Clumio.
mssql_log_backup	VMC MSSQL log backup stored in Clumio.

The following table describes the supported policy activation statuses.

Activation Status	Description
activated	Backups will take place regularly according to the policy SLA.
deactivated	Backups will not begin until the policy is reactivated. The assets associated with the policy will have their compliance status set to "deactivated".

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

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
name	$eq, $begins_with	The unique name of the policy. For example, `?filter={"name":{"$eq":"Silver"}}`
operations.type	$in	Set to the desired operations to limit the results to policies who support the specified operations. For example, `?filter={"operations.type":{"$in":["vmware_vm_backup","aws_ebs_volume_backup"]}}`
activation_status	$eq	The activation status of the policy. For example, `?filter={"activation_status":{"$eq":"activated"}}`

For more information about filtering, refer to the Filtering section of this guide.

embed

string

Embeds the details of an associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

Embeddable Link	Description
`[DEPRECATED]` read-policy-aws-ebs-volumes-compliance-stats	Embeds compliance statistics about EBS volumes into the `_embedded` field of each policy in the response. For example, `?embed=read-policy-aws-ebs-volumes-compliance-stats`
`[DEPRECATED]` read-policy-vmware-vms-compliance-stats	Embeds compliance statistics about VMs into the `_embedded` field of each policy in the response. For example, `?embed=read-policy-vmware-vms-compliance-stats`
`[DEPRECATED]` read-policy-aws-dynamodb-tables-compliance-stats	Embeds compliance statistics about DynamoDB tables into the `_embedded` field of each policy in the response. For example, `?embed=read-policy-aws-dynamodb-tables-compliance-stats`
`[DEPRECATED]` read-policy-protection-groups-compliance-stats	Embeds compliance statistics about protection groups into the `_embedded` field of each policy in the response. For example, `?embed=read-policy-protection-groups-compliance-stats`

For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.

Responses

Response body

object

_embedded

object

An array of embedded resources related to this resource.

items

array of objects

A collection of requested items.

items

object

_embedded

object

If the embed query parameter is set, displays the responses of the related resource, as defined by the embeddable link specified.

_links

object

URLs to pages related to the resource.

activation_status

string

The status of the policy. Refer to the Policy Activation Status table in the GET /policies/definitions endpoint for a complete list of policy statuses.

created_time

int64

The created time of the policy in UNIX time.

string

required

The Clumio-assigned ID of the policy.

lock_status

string

The following table describes the possible lock statuses of a policy.

Status	Description
unlocked	Policies are unlocked until an update or deletion task is queued.
updating	During a policy edit, concurrent edits or deletion requests will be rejected.
deleting	During policy deletion, concurrent edits or deletion requests will be rejected.

name

string

required

The user-provided name of the policy.

operations

array of objects

required

A set of service level agreements (SLA) for the policy. A policy can include one or more SLA sets that span across various operations.

operations*

object

action_setting

string

required

Determines whether the protection policy should take action now or during the specified backup window. If set to immediate, Clumio starts the backup process right away. If set to backup_window_tz, Clumio starts the backup process when the backup window (backup_window_tz) opens. If set to backup_window_tz and operation in ("aws_rds_resource_aws_snapshot", "mssql_log_backup", "ec2_mssql_log_backup"), the backup window will not be determined by Clumio's backup window.

advanced_settings

object

Additional operation-specific policy settings. For operation types which do not support additional settings, this field is null.

backup_aws_region

string

The region in which this backup is stored. This might be used for cross-region backup.

backup_window

object

The start and end times of the customized backup window. Use of backup_window is deprecated, use backup_window_tz instead.

backup_window_tz

object

The start and end times of the customized backup window. Use of backup_window is deprecated, use backup_window_tz instead.

next_start_time

int64

The next start time of this operation in unix time.

previous_start_time

int64

The previous start time of this operation in unix time.

slas

array of objects

required

The service level agreement (SLA) for the policy. A policy can include one or more SLAs. For example, a policy can retain daily backups for a month each, and monthly backups for a year each.

slas*

object

retention_duration

object

required

The retention time for this SLA. For example, to retain the backup for 1 month, set unit="months" and value=1.

rpo_frequency

object

required

The minimum frequency between backups for this SLA. Also known as the recovery point objective (RPO) interval. For example, to configure the minimum frequency between backups to be every 2 days, set unit="days" and value=2. To configure the SLA for on-demand backups, set unit="on_demand" and leave the value field empty.

type

string

required

The operation to be performed for this SLA set. Each SLA set corresponds to one and only one operation. Refer to the Policy Operation table for a complete list of policy operations.

organizational_unit_id

string

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

timezone

string

The timezone for the policy. The timezone must be a valid location name from the IANA Time Zone database. For instance, "America/New_York", "US/Central", "UTC".

updated_time

int64

The updated time of the policy in unix time.

_links

object

URLs to pages related to the resource.

_first

object

The HATEOAS link to the first page of results.

_next

object

The HATEOAS link to the next page of results.

_self

object

The HATEOAS link to this resource.

create-policy-definition

object

A resource-specific HATEOAS link.

current_count

int64

The number of items listed on the current page.

filter_applied

string

The filter used in the request. The filter includes both manually-specified and system-generated filters.

limit

int64

The maximum number of items displayed per page in the response.

start

string

The page token used to get this response.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-west-2.api.clumio.com/policies/definitions \
3
     --header 'accept: application/api.clumio.policy-definitions=v1+json'


xxxxxxxxxx
137
}
1
{
2
  "_embedded": {
3
    "items": [
4
      {
5
        "_embedded": {},
6
        "_links": {
7
          "_self": {
8
            "href": "string",
9
            "templated": true,
10
            "type": "string"
11
          },
12
          "delete-policy-definition": {
13
            "href": "string",
14
            "templated": true,
15
            "type": "string"
16
          },
17
          "protect-entities": {
18
            "href": "string",
19
            "templated": true,
20
            "type": "string"
21
          },
22
          "read-policy-aws-ebs-volumes-compliance-stats": {
23
            "href": "string",
24
            "templated": true,
25
            "type": "string"

200200 HTTP success response

defaultError