Get disk backup policy

Returns information about a specific disk backup policy.


If successful, this endpoint will return a 200 OK status.


One of the following scopes are required to use this endpoint.


The following arguments are supported for this endpoint.

Name Type Default Value

disk_backup_policy Required

The disk backup policy to get information for

Disk Backup Policy Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status


No disk backup policy was found matching any of the criteria provided in the arguments

404 Not Found


The object found is in the trash and therefore cannot be manipulated through the API. It should be restored in order to run this operation.

406 Not Acceptable

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

    disk_backup_policy: DiskBackupPolicy {
        id: String
        retention: Integer
        total_size: Decimal
        target: DiskBackupPolicyTarget
        schedule: Schedule {
            frequency: Integer
            interval: ScheduleIntervalTypeEnum
            minute: Integer
            next_invocation_at: Unix Timestamp
            time: Integer
        auto_move_to_trash_at: Unix Timestamp?