GET /api/config_templates
List provisioning templates

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

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

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

Params

Param name Description
operatingsystem_id
optional

ID of operating system

Validations:

  • String

location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

search
optional

filter results

Validations:

  • String

order
optional

sort results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String

Search fields

Field name Type Possible values
default 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

GET /api/config_templates/:id
Show provisioning template details

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


POST /api/config_templates
Create a provisioning template

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

config_template
required

Validations:

  • Hash

config_template[name]
required

template name

Validations:

  • String

config_template[template]
required

Validations:

  • String

config_template[snippet]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0

config_template[audit_comment]
optional , nil allowed

Validations:

  • String

config_template[template_kind_id]
optional , nil allowed

not relevant for snippet

Validations:

  • Must be a number.

config_template[template_combinations_attributes]
optional , nil allowed

Array of template combinations (hostgroup_id, environment_id)

Validations:

  • Must be an array of any type

config_template[operatingsystem_ids]
optional , nil allowed

Array of operating system IDs to associate with the template

Validations:

  • Must be an array of any type

config_template[locked]
optional , nil allowed

Whether or not the template is locked for editing

Validations:

  • Must be one of: true, false, 1, 0

config_template[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

config_template[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


PUT /api/config_templates/:id
Update a provisioning template

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

config_template
required

Validations:

  • Hash

config_template[name]
optional

template name

Validations:

  • String

config_template[template]
optional

Validations:

  • String

config_template[snippet]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0

config_template[audit_comment]
optional , nil allowed

Validations:

  • String

config_template[template_kind_id]
optional , nil allowed

not relevant for snippet

Validations:

  • Must be a number.

config_template[template_combinations_attributes]
optional , nil allowed

Array of template combinations (hostgroup_id, environment_id)

Validations:

  • Must be an array of any type

config_template[operatingsystem_ids]
optional , nil allowed

Array of operating system IDs to associate with the template

Validations:

  • Must be an array of any type

config_template[locked]
optional , nil allowed

Whether or not the template is locked for editing

Validations:

  • Must be one of: true, false, 1, 0

config_template[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

config_template[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


GET /api/config_templates/revision

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

version
optional

template version

Validations:

  • String


DELETE /api/config_templates/:id
Delete a provisioning template

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


POST /api/config_templates/build_pxe_default
Update the default PXE menu on all configured TFTP servers

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer


POST /api/config_templates/:id/clone
Clone a provision template

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

config_template
required

Validations:

  • Hash

config_template[name]
required

template name

Validations:

  • String