API Reference

Katapult Core API

Resources & Endpoints

List disk backup policies for disk

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

GET
https://api.katapult.io/core/v1/disks/{disk}/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

disk Required

The disk to return disk backup policies for

 Disk Lookup None

page

Integer 1

per_page

Integer 30

Potential Errors

The following errors may occur during this request.

Details HTTP status

disk_not_found

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

 404 Not Found

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

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
        }
    } ]
}