Create a policy

Creates a new policy. Creating a new policy involves configuring the backup seed settings, backup service level agreement (SLA), and backup window.

application/json

Request Body

activation_status string
The status of the policy. Refer to the Policy Activation Status table for a complete list of policy statuses.
name string required
The user-provided name of the policy.
operations object[] 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.
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 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.
slas object[] 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.
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.
unit string required
Possible values: [hours, days, weeks, months, years]
The measurement unit of the SLA parameter.
value int64 required
The measurement value of the SLA parameter.
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.
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 required
Possible values: [hours, days, weeks, months, years]
The measurement unit of the SLA parameter.
value int64 required
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 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 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

Responses

200
default

Success

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

Schema
Example (from schema)

Schema

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

{
  "_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
}

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

Create a policy​

Create a policy