Update a Workflow Job Template

patch

/api/v2/workflow_job_templates/{id}/

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

  • name: Name of this workflow job template. (string, required)
  • description: Optional description of this workflow job template. (string, default="")

  • extra_vars: (json, default=``)

  • organization: The organization used to determine access to this template. (id, default=``)
  • survey_enabled: (boolean, default=False)
  • allow_simultaneous: (boolean, default=False)
  • ask_variables_on_launch: (boolean, default=False)
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
  • limit: (string, default="")
  • scm_branch: (string, default="")
  • ask_inventory_on_launch: (boolean, default=False)
  • ask_scm_branch_on_launch: (boolean, default=False)
  • ask_limit_on_launch: (boolean, default=False)
  • 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=``)
  • ask_labels_on_launch: (boolean, default=False)
  • ask_skip_tags_on_launch: (boolean, default=False)
  • ask_tags_on_launch: (boolean, default=False)
  • skip_tags: (string, default="")
  • job_tags: (string, default="")

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

Request

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

Response

Supported Media Types

200 Response

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