API Reference

Katapult Core API

Resources & Endpoints

Schedule delete disk backup policy

Schedules a disk backup policy to be moved to the trash at a specific time. The backup policy will continue to function as normal until this time is reached.

DELETE
https://api.katapult.io/core/v1/disk_backup_policies/{disk_backup_policy}/schedule

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_backup_policy Required

The disk backup policy to move to the trash

 Disk Backup Policy Lookup None

timestamp Required

The time the disk backup policy will be moved to the trash automatically.

 Unix Timestamp None

Potential Errors

The following errors may occur during this request.

Details HTTP status

disk_backup_policy_not_found

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

 404 Not Found

invalid_timestamp

Timestamp must be at least 5 minutes in the future. If you want to delete something immediately, you use can use the delete endpoint.

 400 Bad Request

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

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
        target: DiskBackupPolicyTarget
        auto_move_to_trash_at: Unix Timestamp?
    }
}