• Disks
• Get disk

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

Scopes

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

• disks
• disks:read

Arguments

The following arguments are supported for this endpoint.

Potential Errors

The following errors may occur during this request.

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    disk: Disk {
        id: String
        name: String
        size_in_gb: Integer
        state: DiskStateEnum
        created_at: Unix Timestamp
        storage_speed: StorageSpeedEnum
        io_profile: DiskIOProfile? {
            id: String
            name: String
            permalink: String
            speed_in_mb: Integer?
            iops: Integer?
        }
        virtual_machine_disk: VirtualMachineDisk? {
            virtual_machine: VirtualMachine {
                id: String
                fqdn: String
            }
            attach_on_boot: Boolean
            boot: Boolean
            state: VirtualMachineDiskAttachmentStateEnum
        }
        installation: DiskInstallation? {
            id: String
            disk_template_version: DiskTemplateVersion {
                number: Integer
                stable: Boolean
                disk_template: DiskTemplate {
                    id: String
                    name: String
                    permalink: String
                    operating_system: OperatingSystem? {
                        id: String
                        name: String
                    }
                }
            }
            attributes: [ DiskInstallationAttribute {
                key: String
                label: String
                value: String?
                description: String?
                protect: Boolean
            } ]
        }
    }
}