API Reference

Katapult Core API

Resources & Endpoints

List disk template versions

Return a list of all disk template versions for a specific disk template.

GET
https://api.katapult.io/core/v1/disk_templates/{disk_template}/versions

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

The disk template to return the versions for

 Disk Template Lookup None

page

Integer 1

per_page

Integer 30

Potential Errors

The following errors may occur during this request.

Details HTTP status

disk_template_not_found

No disk template 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.

{
    disk_template: DiskTemplate {
        id: String
        name: String
        permalink: String
    }
    pagination: Pagination Details {
        current_page: Integer
        total_pages: Integer?
        total: Integer?
        per_page: Integer
        large_set: Boolean
    }
    disk_template_versions: [ DiskTemplateVersion {
        id: String
        number: Integer
        stable: Boolean
        size_in_gb: Integer
    } ]
}