API Reference

Katapult Core API

Resources & Endpoints

Get disk template

Return details for a specific disk template.

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

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

 Disk Template Lookup None

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
        description: String?
        permalink: String
        universal: Boolean
        latest_version: DiskTemplateVersion? {
            id: String
        }
        operating_system: OperatingSystem? {
            id: String
            name: String
            badge: Attachment? {
                url: String
            }
        }
    }
}