GET /api/job_templates
List job templates

GET /api/locations/:location_id/job_templates
List job templates per location

GET /api/organizations/:organization_id/job_templates
List job templates per organization

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


POST /api/job_templates/import
Import a job template from ERB

Params

Param name Description
template
required

Template ERB

Validations:

  • Must be String

overwrite
optional

Overwrite template if it already exists

Validations:

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


GET /api/job_templates/:id/export
Export a job template to ERB

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/job_templates/:id
Show job 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/job_templates
Create a job template

Params

Param name Description
job_template
required

Validations:

  • Must be a Hash

job_template[name]
required

Template name

Validations:

  • Must be String

job_template[job_category]
required

Job category

Validations:

  • Must be String

job_template[description_format]
optional , nil allowed

This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.

Validations:

  • Must be String

job_template[template]
required

Validations:

  • Must be String

job_template[provider_type]
required

Provider type

Validations:

  • Must be one of: SSH.

job_template[snippet]
optional , nil allowed

Validations:

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

job_template[audit_comment]
optional , nil allowed

Validations:

  • Must be String

job_template[locked]
optional , nil allowed

Whether or not the template is locked for editing

Validations:

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

job_template[ssh]
optional , nil allowed

SSH provider specific options

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
optional , nil allowed

Effective user options

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
optional , nil allowed

What user should be used to run the script (using sudo-like mechanisms)

Validations:

  • Must be String

job_template[ssh][effective_user][overridable]
optional , nil allowed

Whether it should be allowed to override the effective user from the invocation form.

Validations:

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

job_template[ssh][effective_user][current_user]
optional , nil allowed

Whether the current user login should be used as the effective user

Validations:

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


PUT /api/job_templates/:id
Update a job 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.

job_template
required

Validations:

  • Must be a Hash

job_template[name]
optional

Template name

Validations:

  • Must be String

job_template[job_category]
optional

Job category

Validations:

  • Must be String

job_template[description_format]
optional , nil allowed

This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.

Validations:

  • Must be String

job_template[template]
optional

Validations:

  • Must be String

job_template[provider_type]
optional

Provider type

Validations:

  • Must be one of: SSH.

job_template[snippet]
optional , nil allowed

Validations:

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

job_template[audit_comment]
optional , nil allowed

Validations:

  • Must be String

job_template[locked]
optional , nil allowed

Whether or not the template is locked for editing

Validations:

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

job_template[ssh]
optional , nil allowed

SSH provider specific options

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
optional , nil allowed

Effective user options

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
optional , nil allowed

What user should be used to run the script (using sudo-like mechanisms)

Validations:

  • Must be String

job_template[ssh][effective_user][overridable]
optional , nil allowed

Whether it should be allowed to override the effective user from the invocation form.

Validations:

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

job_template[ssh][effective_user][current_user]
optional , nil allowed

Whether the current user login should be used as the effective user

Validations:

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


GET /api/job_templates/revision

Params

Param name Description
version
optional

Template version

Validations:

  • Must be String


DELETE /api/job_templates/:id
Delete a job 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.


POST /api/job_templates/:id/clone
Clone a provision 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.

job_template
required

Validations:

  • Must be a Hash

job_template[name]
required

Template name

Validations:

  • Must be String