Config templates

>>>

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 , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>
Value: Must be 'true' or 'false'
config_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>
Value: Must be String
config_template[template_kind_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

not relevant for snippet


Value: Must be a number.
config_template[template_combinations_attributes]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Array of template combinations (hostgroup_id, environment_id)


Value: Must be an array of any type
config_template[operatingsystem_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Array of operating system IDs to associate with the template


Value: Must be an array of any type
config_template[locked]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>
Value: Must be 'true' or 'false'
config_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>
Value: Must be String
config_template[template_kind_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

not relevant for snippet


Value: Must be a number.
config_template[template_combinations_attributes]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Array of template combinations (hostgroup_id, environment_id)


Value: Must be an array of any type
config_template[operatingsystem_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Array of operating system IDs to associate with the template


Value: Must be an array of any type
config_template[locked]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

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.
>>>

GET /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