List policies

Returns a list of policies and their configurations.

The following table describes the supported policy operations.

Operation	Description
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.
microsoft365_teams_backup	Microsoft365 team backup.

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 protection status set to "deactivated".

Query Parameters

• 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":["aws_ec2_instance_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
  read-policy-aws-ebs-volumes-protection-stats	Embeds protection stats about EBS Volumes associated with this tag into the response. For example, ?embed=read-policy-aws-ebs-volumes-protection-stats
  read-policy-aws-ec2-instances-protection-stats	Embeds protection stats about EC2 Instance associated with this tag into the response. For example, ?embed=read-policy-aws-ec2-instances-protection-stats
  read-policy-aws-rds-volumes-protection-stats	Embeds protection stats about RDS Instance associated with this tag into the response. For example, ?embed=read-policy-aws-rds-volumes-protection-stats
  read-policy-aws-dynamodb-tables-protection-stats	Embeds protection stats about DynamoDB tables associated with this tag into the response. For example, ?embed=read-policy-aws-dynamodb-tables-protection-stats
  read-policy-backup-status-stats	Embeds backup statistics for each AWS environment into the response. For example, ?embed=read-policy-backup-status-stats

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

Responses

• 200
• default

---

Success

application/api.clumio.policy-definitions=v1+json

• Schema
• Example (from schema)

---

Schema

• _embedded object

  An array of embedded resources related to this resource.

  items object[]

  A collection of requested items.

  _embedded object

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

  read-policy-aws-ebs-volumes-protection-stats

  Embeds the EBS protection statistics into the response.

  _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-policy-definition 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.

  update-policy-definition 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.

  activation_status string

  The status of the policy. Refer to the Policy Activation Status table for a complete list of policy statuses.

  created_time int64

  The created time of the policy in unix time.

  id string

  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

  The user-provided name of the policy.

  operations object[]

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

  action_setting string

  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 window, Clumio starts the backup process when the backup window (backup_window_tz) opens. If set to window 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.

  aws_ebs_volume_backup object

  Advanced settings for EBS backup.

  backup_tier string

  Possible values: [standard, lite]

  Backup tier to store the backup in. Valid values are: (empty) equivalent to standard, standard, and lite.

  aws_ec2_instance_backup object

  Advanced settings for EC2 backup.

  backup_tier string

  Possible values: [standard, lite]

  Backup tier to store the backup in. Valid values are: (empty) equivalent to standard, standard, and lite.

  aws_rds_config_sync object

  Advanced settings for RDS PITR configuration sync.

  apply string

  Possible values: [immediate, maintenance_window]

  Syncs the configuration of RDS PITR in AWS. Valid values are: immediate, and maintenance_window. Note that applying the setting "immediately" may cause unexpected downtime.

  aws_rds_resource_granular_backup object

  Settings for determining if a RDS policy is created with standard or archive tier.

  backup_tier string

  Possible values: [standard, archive]

  Backup tier to store the backup in. Valid values are: standard, archive

  ec2_mssql_database_backup object

  Additional policy configuration settings for the ec2_mssql_database_backup operation. If this operation is not of type ec2_mssql_database_backup, then this field is omitted from the response.

  alternative_replica string

  Possible values: [primary, sync_secondary, stop]

  The alternative replica for MSSQL database backups. This setting only applies to Availability Group databases. Possible values include "primary", "sync_secondary", and "stop". If "stop" is provided, then backups will not attempt to switch to a different replica when the preferred replica is unavailable. Otherwise, recurring backups will attempt to use either the primary replica or the secondary replica accordingly.

  preferred_replica string

  Possible values: [primary, sync_secondary]

  The primary preferred replica for MSSQL database backups. This setting only applies to Availability Group databases. Possible values include "primary" and "sync_secondary". Recurring backup will first attempt to use either the primary replica or the secondary replica accordingly.

  ec2_mssql_log_backup object

  Additional policy configuration settings for the ec2_mssql_log_backup operation. If this operation is not of type ec2_mssql_log_backup, then this field is omitted from the response.

  alternative_replica string

  Possible values: [primary, sync_secondary, stop]

  The alternative replica for MSSQL log backups. This setting only applies to Availability Group databases. Possible values include "primary", "sync_secondary", and "stop". If "stop" is provided, then backups will not attempt to switch to a different replica when the preferred replica is unavailable. Otherwise, recurring backups will attempt to use either the primary replica or the secondary replica accordingly.

  preferred_replica string

  Possible values: [primary, sync_secondary]

  The primary preferred replica for MSSQL log backups. This setting only applies to Availability Group databases. Possible values include "primary" and "sync_secondary". Recurring backup will first attempt to use either the primary replica or the secondary replica accordingly.

  mssql_database_backup object

  Additional policy configuration settings for the mssql_database_backup operation. If this operation is not of type mssql_database_backup, then this field is omitted from the response.

  alternative_replica string

  Possible values: [primary, sync_secondary, stop]

  The alternative replica for MSSQL database backups. This setting only applies to Availability Group databases. Possible values include "primary", "sync_secondary", and "stop". If "stop" is provided, then backups will not attempt to switch to a different replica when the preferred replica is unavailable. Otherwise, recurring backups will attempt to use either the primary replica or the secondary replica accordingly.

  preferred_replica string

  Possible values: [primary, sync_secondary]

  The primary preferred replica for MSSQL database backups. This setting only applies to Availability Group databases. Possible values include "primary" and "sync_secondary". Recurring backup will first attempt to use either the primary replica or the secondary replica accordingly.

  mssql_log_backup object

  Additional policy configuration settings for the mssql_log_backup operation. If this operation is not of type mssql_log_backup, then this field is omitted from the response.

  alternative_replica string

  Possible values: [primary, sync_secondary, stop]

  The alternative replica for MSSQL log backups. This setting only applies to Availability Group databases. Possible values include "primary", "sync_secondary", and "stop". If "stop" is provided, then backups will not attempt to switch to a different replica when the preferred replica is unavailable. Otherwise, recurring backups will attempt to use either the primary replica or the secondary replica accordingly.

  preferred_replica string

  Possible values: [primary, sync_secondary]

  The primary preferred replica for MSSQL log backups. This setting only applies to Availability Group databases. Possible values include "primary" and "sync_secondary". Recurring backup will first attempt to use either the primary replica or the secondary replica accordingly.

  oracle_database_backup object

  Additional policy configuration settings for the oracle_database_backup operation. If this operation is not of type oracle_database_backup, then this field is omitted from the response.

  alternative_replica string

  Possible values: [primary, standby, stop]

  The alternative replica for Oracle database backups. This setting only applies to Data Guard databases. Valid values are: primary, standby, and stop. If "stop" is provided, then backups will not attempt to switch to a different replica when the preferred replica is unavailable.

  preferred_replica string

  Possible values: [primary, standby]

  The primary preferred replica for Oracle database backups. This setting only applies to Data Guard databases. Valid values are: primary, and standby. Recurring backup will first attempt to use either the primary replica or the secondary replica accordingly.

  oracle_log_backup object

  Additional policy configuration settings for the oracle_log_backup operation. If this operation is not of type oracle_log_backup, then this field is omitted from the response.

  alternative_replica string

  Possible values: [primary, standby, stop]

  The alternative replica for Oracle database backups. This setting only applies to Data Guard databases. Valid values are: primary, standby, and stop. If "stop" is provided, then backups will not attempt to switch to a different replica when the preferred replica is unavailable.

  preferred_replica string

  Possible values: [primary, standby]

  The primary preferred replica for Oracle database backups. This setting only applies to Data Guard databases. Valid values are: primary, and standby. Recurring backup will first attempt to use either the primary replica or the secondary replica accordingly.

  protection_group_backup object

  Additional policy configuration settings for the protection_group_backup operation. If this operation is not of type protection_group_backup, then this field is omitted from the response.

  backup_tier string

  Possible values: [standard, archive]

  Backup tier to store the backup in. Valid values are: standard, archive

  protection_group_continuous_backup object

  Additional policy configuration settings for the protection_group_continuous_backup operation. If this operation is not of type protection_group_continuous_backup, then this field is omitted from the response.

  disable_eventbridge_notification boolean

  Default value: true

  If true, tries to disable EventBridge notification for the given bucket, when continuous backup no longer conducts. It may override the existing bucket notification configuration in the customer's account. This takes effect only when event_bridge_enabled is set to false.

  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.

  end_time string

  The time when the backup window closes. Specify the end time in the format hh:mm, where hh represents the hour of the day and mm represents the minute of the day, based on a 24 hour clock. Leave empty if you do not want to specify an end time. If the backup window closes while a backup is in progress, the entire backup process is aborted. Clumio will perform the next backup when the backup window re-opens.

  start_time string

  The time when the backup window opens. Specify the start time in the format hh:mm, where hh represents the hour of the day and mm represents the minute of the day based on the 24 hour clock.

  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.

  end_time string

  The time when the backup window closes. Specify the end time in the format hh:mm, where hh represents the hour of the day and mm represents the minute of the day, based on a 24 hour clock. Leave empty if you do not want to specify an end time. If the backup window closes while a backup is in progress, the entire backup process is aborted. Clumio will perform the next backup when the backup window re-opens.

  start_time string

  The time when the backup window opens. Specify the start time in the format hh:mm, where hh represents the hour of the day and mm represents the minute of the day based on the 24 hour clock.

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

  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.

  retention_duration object

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

  unit string

  Possible values: [hours, days, weeks, months, years]

  The measurement unit of the SLA parameter.

  value int64

  The measurement value of the SLA parameter.

  rpo_frequency object

  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.

  offsets int64[]

  Possible values: <= 6

  The weekday in decimal of the Weekly SLA parameter. Valid values are integers from 0 to 6, incidates Sunday, Monday, ..., Saturday. For example, to configure backup on every Monday, set unit="weekly", value=1, and offsets={1}.

  unit string

  Possible values: [hours, days, weeks, months, years]

  The measurement unit of the SLA parameter.

  value int64

  The measurement value of the SLA parameter.

  timezone string

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

  type string

  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 policy-level timezone is deprecated, as the operation-level timezone should be used instead. The timezone must be a valid location name from the IANA Time Zone database. For instance, "America/New_York", "US/Central", "UTC". Deprecated: true

  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.

  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.

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

  create-policy-definition 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.

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

{
  "_embedded": {
    "items": [
      {
        "_embedded": {},
        "_links": {
          "_self": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "delete-policy-definition": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "update-policy-definition": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "activation_status": "string",
        "created_time": 0,
        "id": "string",
        "lock_status": "string",
        "name": "string",
        "operations": [
          {
            "action_setting": "string",
            "advanced_settings": {
              "aws_ebs_volume_backup": {
                "backup_tier": "standard"
              },
              "aws_ec2_instance_backup": {
                "backup_tier": "standard"
              },
              "aws_rds_config_sync": {
                "apply": "immediate"
              },
              "aws_rds_resource_granular_backup": {
                "backup_tier": "standard"
              },
              "ec2_mssql_database_backup": {
                "alternative_replica": "primary",
                "preferred_replica": "primary"
              },
              "ec2_mssql_log_backup": {
                "alternative_replica": "primary",
                "preferred_replica": "primary"
              },
              "mssql_database_backup": {
                "alternative_replica": "primary",
                "preferred_replica": "primary"
              },
              "mssql_log_backup": {
                "alternative_replica": "primary",
                "preferred_replica": "primary"
              },
              "oracle_database_backup": {
                "alternative_replica": "primary",
                "preferred_replica": "primary"
              },
              "oracle_log_backup": {
                "alternative_replica": "primary",
                "preferred_replica": "primary"
              },
              "protection_group_backup": {
                "backup_tier": "standard"
              },
              "protection_group_continuous_backup": {
                "disable_eventbridge_notification": true
              }
            },
            "backup_aws_region": "`us-east-1`, `us-west-2`, ...",
            "backup_window": {
              "end_time": "string",
              "start_time": "string"
            },
            "backup_window_tz": {
              "end_time": "string",
              "start_time": "string"
            },
            "next_start_time": 0,
            "previous_start_time": 0,
            "slas": [
              {
                "retention_duration": {
                  "unit": "hours",
                  "value": 0
                },
                "rpo_frequency": {
                  "offsets": [
                    0
                  ],
                  "unit": "hours",
                  "value": 0
                }
              }
            ],
            "timezone": "string",
            "type": "string"
          }
        ],
        "organizational_unit_id": "string",
        "timezone": "string",
        "updated_time": 0
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "create-policy-definition": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "filter_applied": "string",
  "limit": 0,
  "start": "string"
}

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

Loading...