GET /api/provisioning_templates
List provisioning templates

GET /api/operatingsystems/:operatingsystem_id/provisioning_templates
List provisioning templates per operating system

GET /api/locations/:location_id/provisioning_templates
List provisioning templates per location

GET /api/organizations/:organization_id/provisioning_templates
List provisioning templates per organization

Examples

GET /api/provisioning_templates
200
{
  "total": 15,
  "subtotal": 15,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 1007981701,
      "name": "centos5_3_pxelinux",
      "template_kind_id": 452984334,
      "template_kind_name": "PXELinux"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 560244479,
      "name": "Global Registration",
      "template_kind_id": 581478312,
      "template_kind_name": "registration"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 698706415,
      "name": "iPXE Dummy Menu",
      "template_kind_id": 698706415,
      "template_kind_name": "iPXE"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 718456980,
      "name": "Locked Template",
      "template_kind_id": 983253650,
      "template_kind_name": "provision"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 104314179,
      "name": "MyFinish",
      "template_kind_id": 550103832,
      "template_kind_name": "finish"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 981457253,
      "name": "MyScript",
      "template_kind_id": 478250810,
      "template_kind_name": "script"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 943779058,
      "name": "MyString",
      "template_kind_id": 698706415,
      "template_kind_name": "iPXE"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 269958254,
      "name": "MyString2",
      "template_kind_id": 983253650,
      "template_kind_name": "provision"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 684651467,
      "name": "PXE Default Menu",
      "template_kind_id": 452984334,
      "template_kind_name": "PXELinux"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 554905648,
      "name": "PXEGrub2 global default",
      "template_kind_id": 701398793,
      "template_kind_name": "PXEGrub2"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 131565194,
      "name": "PXEGrub Dummy Menu",
      "template_kind_id": 131565194,
      "template_kind_name": "PXEGrub"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 824224502,
      "name": "PXEGrub global default",
      "template_kind_id": 131565194,
      "template_kind_name": "PXEGrub"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 821548108,
      "name": "PXELinux default local boot",
      "template_kind_id": 452984334,
      "template_kind_name": "PXELinux"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 352050261,
      "name": "PXELinux global default",
      "template_kind_id": 452984334,
      "template_kind_name": "PXELinux"
    },
    {
      "snippet": false,
      "description": null,
      "created_at": "2020-11-04 14:05:08 UTC",
      "updated_at": "2020-11-04 14:05:08 UTC",
      "id": 56083308,
      "name": "suse_pxelinux",
      "template_kind_id": 452984334,
      "template_kind_name": "PXELinux"
    }
  ]
}

Params

Param name Description
operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a String
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
default_template true, false
environment string
hostgroup string
kind string
location string
location_id integer
locked true, false
name string
operatingsystem string
organization string
organization_id integer
snippet true, false
template text
vendor string