API Reference

Katapult Core API

Resources & Endpoints

List virtual machine disks

Return a list of all disks for a given virtual machine.

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

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 find disks for

 VirtualMachine Lookup 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

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
    }
    disks: [ VirtualMachineDisk {
        disk: Disk {
            id: String
            name: String
            size_in_gb: Integer
            state: DiskStateEnum
            created_at: Unix Timestamp
        }
        attach_on_boot: Boolean
        boot: Boolean
        state: VirtualMachineDiskAttachmentStateEnum
    } ]
}