PUT /api/job_templates/:id
Update a job template

Examples

PUT /api/job_templates/1007982139-Job%20template%20193
{
  "job_template": {
    "name": ""
  }
}
422
{
  "error": {
    "id": 1007982139,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
job_template
required

Validations:

  • Hash
job_template[name]
optional

Template name

Validations:

  • String
job_template[description]
optional , nil allowed

Validations:

  • String
job_template[job_category]
optional

Job category

Validations:

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

  • String
job_template[template]
optional

Validations:

  • String
job_template[provider_type]
optional

Provider type

Validations:

  • Must be one of: SSH, script, Ansible.
job_template[snippet]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
job_template[audit_comment]
optional , nil allowed

Validations:

  • String
job_template[locked]
optional , nil allowed

Whether or not the template is locked for editing

Validations:

  • Must be one of: true, false, 1, 0.
job_template[effective_user_attributes]
optional , nil allowed

Effective user options

Validations:

  • Hash
job_template[effective_user_attributes][value]
optional , nil allowed

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

Validations:

  • String
job_template[effective_user_attributes][overridable]
optional , nil allowed

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

Validations:

  • Must be one of: true, false, 1, 0.
job_template[effective_user_attributes][current_user]
optional , nil allowed

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

Validations:

  • Must be one of: true, false, 1, 0.
job_template[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
job_template[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
job_template[ansible_callback_enabled]
optional

Enable the callback plugin for this template

Validations:

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