GET /api/config_templates
List templates

Params

Param name Description
search
optional

filter results

Validations:

  • Must be String

order
optional

sort results

Validations:

  • Must be String

page
optional

paginate results

Validations:

  • Must be String

per_page
optional

number of entries per request

Validations:

  • Must be String


GET /api/config_templates/:id
Show template details

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/config_templates
Create a template

Params

Param name Description
config_template
required

Validations:

  • Must be a Hash

config_template[name]
required

template name

Validations:

  • Must be String

config_template[template]
required

Validations:

  • Must be String

config_template[snippet]
optional , nil allowed

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

config_template[audit_comment]
optional , nil allowed

Validations:

  • Must be String

config_template[template_kind_id]
optional , nil allowed

not relevant for snippet

Validations:

  • Must be a number.

config_template[template_combinations_attributes]
optional

Array of template combinations (hostgroup_id, environment_id)

Validations:

  • Must be an array of any type

config_template[operatingsystem_ids]
optional

Array of operating systems ID to associate the template with

Validations:

  • Must be an array of any type


PUT /api/config_templates/:id
Update a template

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

config_template
required

Validations:

  • Must be a Hash

config_template[name]
optional

template name

Validations:

  • Must be String

config_template[template]
optional

Validations:

  • Must be String

config_template[snippet]
optional

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

config_template[audit_comment]
optional , nil allowed

Validations:

  • Must be String

config_template[template_kind_id]
optional , nil allowed

not relevant for snippet

Validations:

  • Must be a number.

config_template[template_combinations_attributes]
optional

Array of template combinations (hostgroup_id, environment_id)

Validations:

  • Must be an array of any type

config_template[operatingsystem_ids]
optional

Array of operating systems ID to associate the template with

Validations:

  • Must be an array of any type


GET /api/config_templates/revision

Params

Param name Description
version
optional

template version

Validations:

  • Must be String


DELETE /api/config_templates/:id
Delete a template

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


GET /api/config_templates/build_pxe_default
Change the default PXE menu on all configured TFTP servers