API Reference

Katapult Core API

Resources & Endpoints

Get disk template version spec

Return details provided by this template's specification.

GET
https://api.katapult.io/core/v1/disk_template_versions/{disk_template_version}/spec

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

The disk template version to return

 Disk Template Version Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

disk_template_version_not_found

No disk template version 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_version: DiskTemplateVersion {
        id: String
        number: Integer
        stable: Boolean
        size_in_gb: Integer
        disk_template: DiskTemplate {
            id: String
            name: String
            permalink: String
        }
    }
    spec: TemplateSpec {
        fields: [ TemplateSpecField {
            name: String
            type: Template spec field type
            label: String
            description: String?
            required: Boolean
            placeholder: String?
            prefill: String?
        } ]
    }
}