Launch a Job Template
post
/api/v2/job_templates/{id}/launch/
Make a POST request to this resource to launch the job_template. If any
passwords, inventory, or extra variables (extra_vars) are required, they must
be passed via POST data, with extra_vars given as a YAML or JSON string and
escaped parentheses. If the inventory_needed_to_start
is True
then the
inventory
is required.
If successful, the response status code will be 201. If any required passwords are not provided, a 400 status code will be returned. If the job cannot be launched, a 405 status code will be returned. If the provided credential or inventory are not allowed to be used by the user, then a 403 status code will be returned.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : JobLaunch
Type:
Show Source
object
-
ask_credential_on_launch:
boolean
Title:
Ask credential on launch
Read Only:true
-
ask_diff_mode_on_launch:
boolean
Title:
Ask diff mode on launch
Read Only:true
-
ask_execution_environment_on_launch:
boolean
Title:
Ask execution environment on launch
Read Only:true
-
ask_forks_on_launch:
boolean
Title:
Ask forks on launch
Read Only:true
-
ask_instance_groups_on_launch:
boolean
Title:
Ask instance groups on launch
Read Only:true
-
ask_inventory_on_launch:
boolean
Title:
Ask inventory on launch
Read Only:true
-
ask_job_slice_count_on_launch:
boolean
Title:
Ask job slice count on launch
Read Only:true
-
ask_job_type_on_launch:
boolean
Title:
Ask job type on launch
Read Only:true
-
ask_labels_on_launch:
boolean
Title:
Ask labels on launch
Read Only:true
-
ask_limit_on_launch:
boolean
Title:
Ask limit on launch
Read Only:true
-
ask_scm_branch_on_launch:
boolean
Title:
Ask scm branch on launch
Read Only:true
-
ask_skip_tags_on_launch:
boolean
Title:
Ask skip tags on launch
Read Only:true
-
ask_tags_on_launch:
boolean
Title:
Ask tags on launch
Read Only:true
-
ask_timeout_on_launch:
boolean
Title:
Ask timeout on launch
Read Only:true
-
ask_variables_on_launch:
boolean
Title:
Ask variables on launch
Read Only:true
-
ask_verbosity_on_launch:
boolean
Title:
Ask verbosity on launch
Read Only:true
-
can_start_without_user_input:
boolean
Title:
Can start without user input
Read Only:true
-
credential_needed_to_start:
string
Title:
Credential needed to start
Read Only:true
-
credential_passwords:
string
Title:
Credential passwords
-
credentials:
array credentials
Unique Items Required:
true
-
defaults:
string
Title:
Defaults
Read Only:true
-
diff_mode:
boolean
Title:
Diff mode
-
execution_environment:
integer
Title:
Execution environment
-
extra_vars:
object Extra vars
Title:
Extra vars
-
forks:
integer
Title:
Forks
Minimum Value:0
-
instance_groups:
array instance_groups
Unique Items Required:
true
-
inventory:
integer
Title:
Inventory
-
inventory_needed_to_start:
string
Title:
Inventory needed to start
Read Only:true
-
job_slice_count:
integer
Title:
Job slice count
Minimum Value:0
-
job_tags:
string
Title:
Job tags
-
job_template_data:
string
Title:
Job template data
Read Only:true
-
job_type:
string
Title:
Job type
Allowed Values:[ "run", "check" ]
-
labels:
array labels
Unique Items Required:
true
-
limit:
string
Title:
Limit
-
passwords_needed_to_start:
string
Title:
Passwords needed to start
Read Only:true
-
scm_branch:
string
Title:
Scm branch
-
skip_tags:
string
Title:
Skip tags
-
survey_enabled:
string
Title:
Survey enabled
Read Only:true
-
timeout:
integer
Title:
Timeout
-
variables_needed_to_start:
string
Title:
Variables needed to start
Read Only:true
-
verbosity:
integer
Title:
Verbosity
Allowed Values:[ "0", "1", "2", "3", "4", "5" ]
Nested Schema : Extra vars
Type:
object
Title:
Extra vars
Response
Supported Media Types
- application/json
201 Response
Root Schema : JobLaunch
Type:
Show Source
object
-
ask_credential_on_launch:
boolean
Title:
Ask credential on launch
Read Only:true
-
ask_diff_mode_on_launch:
boolean
Title:
Ask diff mode on launch
Read Only:true
-
ask_execution_environment_on_launch:
boolean
Title:
Ask execution environment on launch
Read Only:true
-
ask_forks_on_launch:
boolean
Title:
Ask forks on launch
Read Only:true
-
ask_instance_groups_on_launch:
boolean
Title:
Ask instance groups on launch
Read Only:true
-
ask_inventory_on_launch:
boolean
Title:
Ask inventory on launch
Read Only:true
-
ask_job_slice_count_on_launch:
boolean
Title:
Ask job slice count on launch
Read Only:true
-
ask_job_type_on_launch:
boolean
Title:
Ask job type on launch
Read Only:true
-
ask_labels_on_launch:
boolean
Title:
Ask labels on launch
Read Only:true
-
ask_limit_on_launch:
boolean
Title:
Ask limit on launch
Read Only:true
-
ask_scm_branch_on_launch:
boolean
Title:
Ask scm branch on launch
Read Only:true
-
ask_skip_tags_on_launch:
boolean
Title:
Ask skip tags on launch
Read Only:true
-
ask_tags_on_launch:
boolean
Title:
Ask tags on launch
Read Only:true
-
ask_timeout_on_launch:
boolean
Title:
Ask timeout on launch
Read Only:true
-
ask_variables_on_launch:
boolean
Title:
Ask variables on launch
Read Only:true
-
ask_verbosity_on_launch:
boolean
Title:
Ask verbosity on launch
Read Only:true
-
can_start_without_user_input:
boolean
Title:
Can start without user input
Read Only:true
-
credential_needed_to_start:
string
Title:
Credential needed to start
Read Only:true
-
credential_passwords:
string
Title:
Credential passwords
-
credentials:
array credentials
Unique Items Required:
true
-
defaults:
string
Title:
Defaults
Read Only:true
-
diff_mode:
boolean
Title:
Diff mode
-
execution_environment:
integer
Title:
Execution environment
-
extra_vars:
object Extra vars
Title:
Extra vars
-
forks:
integer
Title:
Forks
Minimum Value:0
-
instance_groups:
array instance_groups
Unique Items Required:
true
-
inventory:
integer
Title:
Inventory
-
inventory_needed_to_start:
string
Title:
Inventory needed to start
Read Only:true
-
job_slice_count:
integer
Title:
Job slice count
Minimum Value:0
-
job_tags:
string
Title:
Job tags
-
job_template_data:
string
Title:
Job template data
Read Only:true
-
job_type:
string
Title:
Job type
Allowed Values:[ "run", "check" ]
-
labels:
array labels
Unique Items Required:
true
-
limit:
string
Title:
Limit
-
passwords_needed_to_start:
string
Title:
Passwords needed to start
Read Only:true
-
scm_branch:
string
Title:
Scm branch
-
skip_tags:
string
Title:
Skip tags
-
survey_enabled:
string
Title:
Survey enabled
Read Only:true
-
timeout:
integer
Title:
Timeout
-
variables_needed_to_start:
string
Title:
Variables needed to start
Read Only:true
-
verbosity:
integer
Title:
Verbosity
Allowed Values:[ "0", "1", "2", "3", "4", "5" ]
Nested Schema : Extra vars
Type:
object
Title:
Extra vars