GET /api/config_templates
List provisioning templates

GET /api/operatingsystem/: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


Value: Must be String
search
optional

filter results


Value: Must be String
order
optional

sort results


Value: Must be String
page
optional

paginate results


Value: Must be String
per_page
optional

number of entries per request


Value: Must be String

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

Params

Param name Description
id
required

Value: 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 provisioning template

Params

Param name Description
config_template
required

Value: Must be a Hash
config_template[name]
required

template name


Value: Must be String
config_template[template]
required

Value: Must be String
config_template[snippet]
optional , nil allowed

Value: Must be 'true' or 'false'
config_template[audit_comment]
optional , nil allowed

Value: Must be String
config_template[template_kind_id]
optional , nil allowed

not relevant for snippet


Value: Must be a number.
config_template[template_combinations_attributes]
optional , nil allowed

Array of template combinations (hostgroup_id, environment_id)


Value: Must be an array of any type
config_template[operatingsystem_ids]
optional , nil allowed

Array of operating system IDs to associate with the template


Value: Must be an array of any type
config_template[locked]
optional , nil allowed

Whether or not the template is locked for editing


Value: Must be 'true' or 'false'

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

Params

Param name Description
id
required

Value: 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

Value: Must be a Hash
config_template[name]
optional

template name


Value: Must be String
config_template[template]
optional

Value: Must be String
config_template[snippet]
optional , nil allowed

Value: Must be 'true' or 'false'
config_template[audit_comment]
optional , nil allowed

Value: Must be String
config_template[template_kind_id]
optional , nil allowed

not relevant for snippet


Value: Must be a number.
config_template[template_combinations_attributes]
optional , nil allowed

Array of template combinations (hostgroup_id, environment_id)


Value: Must be an array of any type
config_template[operatingsystem_ids]
optional , nil allowed

Array of operating system IDs to associate with the template


Value: Must be an array of any type
config_template[locked]
optional , nil allowed

Whether or not the template is locked for editing


Value: Must be 'true' or 'false'

GET /api/config_templates/revision

Params

Param name Description
version
optional

template version


Value: Must be String

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

Params

Param name Description
id
required

Value: 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/build_pxe_default
Update the default PXE menu on all configured TFTP servers


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

Params

Param name Description
id
required

Value: 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

Value: Must be a Hash
config_template[name]
required

template name


Value: Must be String