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
Path Parameters
Body ()
Root Schema : JobLaunch
Type: object
Show Source
Nested Schema : credentials
Type: array
Unique Items Required: true
Show Source
Nested Schema : Extra vars
Type: object
Title: Extra vars
Nested Schema : instance_groups
Type: array
Unique Items Required: true
Show Source
Nested Schema : labels
Type: array
Unique Items Required: true
Show Source
Back to Top

Response

Supported Media Types

201 Response

Body ()
Root Schema : JobLaunch
Type: object
Show Source
Nested Schema : credentials
Type: array
Unique Items Required: true
Show Source
Nested Schema : Extra vars
Type: object
Title: Extra vars
Nested Schema : instance_groups
Type: array
Unique Items Required: true
Show Source
Nested Schema : labels
Type: array
Unique Items Required: true
Show Source
Back to Top