Retrieve a policy
Returns a representation of the specified policy.
Path Parameters
- policy_id string required
Performs the operation on the policy with the specified ID.
Query Parameters
- 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-statsread-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-statsread-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-statsread-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-statsread-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
- 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"
}
]
}
GET /policies/definitions/:policy_id
Authorization
Request
Request
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/definitions/:policy_id' \
-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/:policy_id' \
-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/:policy_id' \
-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/:policy_id' \
-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/:policy_id' \
-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/:policy_id' \
-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/:policy_id' \
-H 'Accept: application/api.clumio.policy-definitions=v1+json' \
-H 'Authorization: Bearer <TOKEN>'