Skip to main content

List disk templates

GET 

/organizations/organization/disk_templates

Return a list of all disk templates owned by an organization

Scopes

  • disk_templates
  • disk_templates:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

    organization[id] string

    The organization to find disk templates for.

    All 'organization[]' params are mutually exclusive, only one can be provided.

    organization[sub_domain] string

    The organization to find disk templates for.

    All 'organization[]' params are mutually exclusive, only one can be provided.

    include_universal boolean

    Whether or not to include universal templates

    operating_system[id] string

    An operating system to use to filter disk templates.

    All 'operating_system[]' params are mutually exclusive, only one can be provided.

    page integer

    Possible values: >= 1

    Default value: 1

    The page number to request. If not provided, the first page will be returned.

    per_page integer

    Possible values: >= 1

    Default value: 30

    The number of items to return per page. If not provided, the default value will be used.

Responses

Return a list of all disk templates owned by an organization

Schema

    pagination

    object

    required

    current_page integer

    The current page

    total_pages integernullable

    The total number of pages

    total integernullable

    The total number of items across all pages

    per_page integer

    The number of items per page

    large_set boolean

    Is this a large set and therefore the total number of records cannot be returned?

    disk_templates

    object[]

    required

    The list of disk templates

  • Array [

  • id string
    name string
    description stringnullable
    permalink string
    universal boolean
    size_in_gb integernullable

    latest_version

    object

    nullable

    id string
    number integer

    operating_system

    object

    nullable

    id string
    name string
  • ]

Loading...