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
- 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
- 200
- default
Success
- application/api.clumio.policy-definitions=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
_links object
- 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[]
- 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[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
POST /policies/definitions
Authorization
Request
Request
curl -L -X POST 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"activation_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"
},
"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"
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"activation_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"
},
"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"
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"activation_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"
},
"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"
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"activation_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"
},
"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"
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"activation_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"
},
"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"
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"activation_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"
},
"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"
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"activation_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"
},
"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"
}'