Create disk backup policy for Virtual Machine

Creates a new disk backup policy for a virtual machine.


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

virtual_machine Required

The virtual machine to create the disk backup policy for

VirtualMachine Lookup None

properties Required

Details for the new disk backup policy

DiskBackupPolicyArguments None

Potential Errors

The following errors may occur during this request.

Details HTTP status


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


The authenticated identity is not permitted to perform this action

403 Forbidden


A validation error occurred with the object that was being created/updated/deleted

422 Unprocessable Entity


No virtual machine was found matching any of the criteria provided in the arguments

404 Not Found

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?