From 08ea3bef25bbe12614861218ad8c090b169cc1b3 Mon Sep 17 00:00:00 2001 From: Matthew Jones Date: Tue, 25 Nov 2014 16:22:48 -0500 Subject: [PATCH] Add system job template launch documentation --- awx/api/templates/api/system_job_template_launch.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 awx/api/templates/api/system_job_template_launch.md diff --git a/awx/api/templates/api/system_job_template_launch.md b/awx/api/templates/api/system_job_template_launch.md new file mode 100644 index 0000000000..228b8887d0 --- /dev/null +++ b/awx/api/templates/api/system_job_template_launch.md @@ -0,0 +1,10 @@ +Launch a Job Template: + +Make a POST request to this resource to launch the system job template. + +An extra parameter `extra_vars` is suggested in order to pass extra parameters +to the system job task. For example: `{"days": 30}` to perform the action on +items older than 30 days. + +If successful, the response status code will be 202. If the job cannot be +launched, a 405 status code will be returned.