Update a Job Template

patch

/api/v2/job_templates/{id}/

Make a PUT or PATCH request to this resource to update this job template. The following fields may be modified:

  • name: Name of this job template. (string, required)
  • description: Optional description of this job template. (string, default="")
  • job_type: (choice)
    • run: Run (default)
    • check: Check
  • inventory: (id, default=``)
  • project: (id, default=``)
  • playbook: (string, default="")
  • scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default="")
  • forks: (integer, default=0)
  • limit: (string, default="")
  • verbosity: (choice)
    • 0: 0 (Normal) (default)
    • 1: 1 (Verbose)
    • 2: 2 (More Verbose)
    • 3: 3 (Debug)
    • 4: 4 (Connection Debug)
    • 5: 5 (WinRM Debug)
  • extra_vars: (json, default=``)
  • job_tags: (string, default="")
  • force_handlers: (boolean, default=False)
  • skip_tags: (string, default="")
  • start_at_task: (string, default="")
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)
  • use_fact_cache: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=False)

  • execution_environment: The container image to be used for execution. (id, default=``)

  • host_config_key: (string, default="")
  • ask_scm_branch_on_launch: (boolean, default=False)
  • ask_diff_mode_on_launch: (boolean, default=False)
  • ask_variables_on_launch: (boolean, default=False)
  • ask_limit_on_launch: (boolean, default=False)
  • ask_tags_on_launch: (boolean, default=False)
  • ask_skip_tags_on_launch: (boolean, default=False)
  • ask_job_type_on_launch: (boolean, default=False)
  • ask_verbosity_on_launch: (boolean, default=False)
  • ask_inventory_on_launch: (boolean, default=False)
  • ask_credential_on_launch: (boolean, default=False)
  • ask_execution_environment_on_launch: (boolean, default=False)
  • ask_labels_on_launch: (boolean, default=False)
  • ask_forks_on_launch: (boolean, default=False)
  • ask_job_slice_count_on_launch: (boolean, default=False)
  • ask_timeout_on_launch: (boolean, default=False)
  • ask_instance_groups_on_launch: (boolean, default=False)
  • survey_enabled: (boolean, default=False)
  • become_enabled: (boolean, default=False)
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=False)
  • allow_simultaneous: (boolean, default=False)

  • job_slice_count: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=1)

  • webhook_service: Service that webhook requests will be accepted from (choice)
    • "": ---------
    • github: GitHub
    • gitlab: GitLab
    • bitbucket_dc: BitBucket DataCenter
  • webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)
  • prevent_instance_group_fallback: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)

For a PATCH request, include only the fields that are being modified.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : JobTemplate
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : JobTemplate
Type: object
Show Source
Back to Top