API Reference

Katapult Core API

Resources & Endpoints

List disk backup policies for virtual machine

Returns a list of all disk backup policies for a given virtual machine.

GET
https://api.katapult.io/core/v1/virtual_machines/{virtual_machine}/disk_backup_policies

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

Scopes

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

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

virtual_machine Required

The virtual machine to return disk backup policies for

 VirtualMachine Lookup None

include_disks

If true, the returned list will include backup policies owned by disks assigned to this virtual machine in addition to those that belong to the whole virtual machine

 Boolean None

page

Integer 1

per_page

Integer 30

Potential Errors

The following errors may occur during this request.

Details HTTP status

object_in_trash

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

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

virtual_machine_not_found

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.

{
    pagination: Pagination Details {
        current_page: Integer
        total_pages: Integer?
        total: Integer?
        per_page: Integer
        large_set: Boolean
    }
    disk_backup_policies: [ DiskBackupPolicy {
        id: String
        retention: Integer
        total_size: Decimal
        target: DiskBackupPolicyTarget
        schedule: Schedule {
            interval: ScheduleIntervalTypeEnum
            next_invocation_at: Unix Timestamp
        }
    } ]
}