Jump to

• Request
• Response

Update a Workflow Job Template

put

/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
• webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)

For a PUT request, include all fields in the request.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Query Parameters

• search: string
  A search term.

Body ()

Root Schema : schema

Type: object

Show Source

• allow_simultaneous: boolean
• ask_inventory_on_launch: boolean
• ask_limit_on_launch: boolean
• ask_scm_branch_on_launch: boolean
• ask_variables_on_launch: boolean
• description: string
• extra_vars: string
• inventory: integer
  Inventory applied as a prompt, assuming job template prompts for inventory
• limit: string
• name(required): string
• organization: integer
  The organization used to determine access to this template.
• scm_branch: string
• survey_enabled: boolean
• webhook_credential: integer
  Personal Access Token for posting back the status to the service API
• webhook_service: string
  Service that webhook requests will be accepted from

{
    "properties":{
        "allow_simultaneous":{
            "description":"",
            "type":"boolean"
        },
        "ask_inventory_on_launch":{
            "description":"",
            "type":"boolean"
        },
        "ask_limit_on_launch":{
            "description":"",
            "type":"boolean"
        },
        "ask_scm_branch_on_launch":{
            "description":"",
            "type":"boolean"
        },
        "ask_variables_on_launch":{
            "description":"",
            "type":"boolean"
        },
        "description":{
            "description":"",
            "type":"string"
        },
        "extra_vars":{
            "description":"",
            "type":"string"
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "type":"integer"
        },
        "limit":{
            "description":"",
            "type":"string"
        },
        "name":{
            "description":"",
            "type":"string"
        },
        "organization":{
            "description":"The organization used to determine access to this template.",
            "type":"integer"
        },
        "scm_branch":{
            "description":"",
            "type":"string"
        },
        "survey_enabled":{
            "description":"",
            "type":"boolean"
        },
        "webhook_credential":{
            "description":"Personal Access Token for posting back the status to the service API",
            "type":"integer"
        },
        "webhook_service":{
            "description":"Service that webhook requests will be accepted from",
            "type":"string"
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

Back to Top

Response

200 Response

Back to Top