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. |
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:
For more information about filtering, refer to the Filtering section of this guide.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"}}
- 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.
For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.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
Responses
- 200
- default
Success
- application/api.clumio.policy-definitions=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
_links object
- 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[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
GET /policies/definitions
Authorization
Request
Request
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/definitions' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>'