API Reference

Katapult Core API

Resources & Endpoints

List disk templates

Return a list of all disk templates owned by an organization.

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

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

organization Required

The organization to find disk templates for

 Organization Lookup None

include_universal

Whether or not to include universal templates

 Boolean false

operating_system

An operating system to use to filter disk templates

 Operating System Lookup None

page

Integer 1

per_page

Integer 30

Potential Errors

The following errors may occur during this request.

Details HTTP status

operating_system_not_found

No operating system was found matching any of the criteria provided in the arguments

 404 Not Found

organization_not_activated

An organization was found from the arguments provided but it wasn't activated yet

 403 Forbidden

organization_not_found

No organization was found matching any of the criteria provided in the arguments

 404 Not Found

organization_suspended

An organization was found from the arguments provided but it was suspended

 403 Forbidden

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
    }
    disk_templates: [ DiskTemplate {
        id: String
        name: String
        description: String?
        permalink: String
        universal: Boolean
        latest_version: DiskTemplateVersion? {
            id: String
            number: Integer
        }
        operating_system: OperatingSystem? {
            id: String
            name: String
        }
    } ]
}