{"id":24250,"date":"2023-03-31T16:20:28","date_gmt":"2023-03-31T14:20:28","guid":{"rendered":"https:\/\/www.dbi-services.com\/blog\/?p=24250"},"modified":"2025-01-24T10:42:46","modified_gmt":"2025-01-24T09:42:46","slug":"how-to-use-awx-rest-api-to-execute-jobs","status":"publish","type":"post","link":"https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/","title":{"rendered":"How to use AWX REST API to execute jobs"},"content":{"rendered":"\n

by Alexandre Nestor<\/p>\n\n\n\n

Introduction<\/h2>\n\n\n\n

AWX provides a REST API which allows to do pretty all commands that can be executed through the web interface, using http requests. <\/p>\n\n\n\n

Sometimes is more easy to restart, or start jobs for instance through API, instead of going through the graphical interface. <\/p>\n\n\n\n

First access of REST API <\/h2>\n\n\n\n

For instance, suppose the AWX server IP is 127.0.0.1<\/code>.<\/p>\n\n\n\n

Get some basic AWX server informations: <\/p>\n\n\n

\nawxtest> curl -X GET -k https:\/\/127.0.0.1\/api\/ | jq .\n\n{\n  "description": "AWX REST API",\n  "current_version": "\/api\/v2\/",\n  "available_versions": {\n    "v2": "\/api\/v2\/"\n  },\n  "oauth2": "\/api\/o\/",\n  "custom_logo": "",\n  "custom_login_info": "",\n  "login_redirect_override": ""\n}\n<\/pre><\/div>\n\n\n
So the path to the API is \/api\/v2\/<\/code> (checkout \"v2\": \"\/api\/v2\/\"<\/code> line) <\/p>\n\n\n\n
Let’s get the list of all endpoints available: <\/p>\n\n\n
\nawxtest> curl -X GET -k https:\/\/127.0.0.1\/api\/v2\/ | jq .\n\n{\n  "ping": "\/api\/v2\/ping\/",\n  "instances": "\/api\/v2\/instances\/",\n  "instance_groups": "\/api\/v2\/instance_groups\/",\n  "config": "\/api\/v2\/config\/",\n  "settings": "\/api\/v2\/settings\/",\n  ....\n}\n\n<\/pre><\/div>\n\n\n
NOTE<\/strong>: I used jq<\/a><\/code> to have a pretty print the JSON in a terminal. But is not necessary. Just nice to have.<\/p>\n\n\n\n
How to list all jobs:<\/p>\n\n\n
\nawxtest> curl -X GET --user admin:myadminpassword -k https:\/\/127.0.0.1\/api\/v2\/job_templates\/  | jq .\n\u00a8\n{\n  "id": 7,\n  "type": "job_template",\n  "url": "\/api\/v2\/job_templates\/7\/",\n  "related": {\n    "named_url": "\/api\/v2\/job_templates\/Demo Job Template++Default\/",\n    "created_by": "\/api\/v2\/users\/1\/",\n    "modified_by": "\/api\/v2\/users\/1\/",\n    "labels": "\/api\/v2\/job_templates\/7\/labels\/",\n    "inventory": "\/api\/v2\/inventories\/1\/",\n    "project": "\/api\/v2\/projects\/6\/",\n    "organization": "\/api\/v2\/organizations\/1\/",\n    "credentials": "\/api\/v2\/job_templates\/7\/credentials\/",\n    "last_job": "\/api\/v2\/jobs\/2\/",\n    "jobs": "\/api\/v2\/job_templates\/7\/jobs\/",\n    "schedules": "\/api\/v2\/job_templates\/7\/schedules\/",\n    "activity_stream": "\/api\/v2\/job_templates\/7\/activity_stream\/",\n\t"launch": "\/api\/v2\/job_templates\/7\/launch\/",                                    \n    "webhook_key": "\/api\/v2\/job_templates\/7\/webhook_key\/",\n    "webhook_receiver": "",\n    "notification_templates_started": "\/api\/v2\/job_templates\/7\/notification_templates_started\/",\n    "notification_templates_success": "\/api\/v2\/job_templates\/7\/notification_templates_success\/",\n    "notification_templates_error": "\/api\/v2\/job_templates\/7\/notification_templates_error\/",\n    "access_list": "\/api\/v2\/job_templates\/7\/access_list\/",\n    "survey_spec": "\/api\/v2\/job_templates\/7\/survey_spec\/",\n    "object_roles": "\/api\/v2\/job_templates\/7\/object_roles\/",\n    "instance_groups": "\/api\/v2\/job_templates\/7\/instance_groups\/",\n    "slice_workflow_jobs": "\/api\/v2\/job_templates\/7\/slice_workflow_jobs\/",\n    "copy": "\/api\/v2\/job_templates\/7\/copy\/"\n<\/pre><\/div>\n\n\n
There are pretty a lot of information here about the jobs, and also the endpoints to access these tasks. <\/p>\n\n\n\n
In order to launch a job use the launch<\/code> key:  \"launch\": \"\/api\/v2\/job_templates\/7\/launch\/\"<\/code> which gives you the URI to use to launch the job number 7. <\/p>\n\n\n\n
Let’s get the job id to start the job.<\/p>\n\n\n
\nawxtest>  curl -X POST --user admin:myadminpassword -k https:\/\/127.0.0.1\/api\/v2\/job_templates\/7\/launch\/ | jq .\n...\n"verbosity" : 0,  \n"extra_vars" : "{}",  \n"job" : 72,                                                                \n"created" : "2018-11-20T11:09:49.813893Z", "force_handlers" : false,\n... \n<\/pre><\/div>\n\n\n
 Here the job id is 72. <\/p>\n\n\n\n
Start the job: <\/p>\n\n\n
\nawxtest> curl -X GET --user admin:myadminpassword https:\/\/127.0.0.1\/api\/v2\/jobs\/72\/ -k -s | jq .\n<\/pre><\/div>\n\n\n
Putting all together <\/h2>\n\n\n\n
Lets create an Ansible playbook to do all these steps in one. <\/p>\n\n\n
\n---\n- name: Tower API\n  hosts: localhost\n  become: false\n  vars:\n\t  tower_user: admin\n\t  tower_pass: myadminpassword\n\t  tower_host: 127.0.0.1\n\t  tower_job_id: 7\n\ttasks:\n  - name: Launch a new Job\n    uri:\n      url: https:\/\/{{ tower_host }}\/api\/v2\/job_templates\/{{ tower_job_id }}\/launch\/\n      method: POST\n      validate_certs: no\n      return_content: yes\n      user: "{{ tower_user }}"\n      password: "{{ tower_pass }}"\n      force_basic_auth: yes\n      status_code: 201\n<\/pre><\/div>\n\n\n
Same  playbook using a token for registration: <\/p>\n\n\n
\n--\n- name: Tower API\n\n  hosts: localhost\n  gather_facts: false\n\n  vars:\n    tower_user: admin\n    tower_pass: myadminpassword\n    tower_host: 127.0.0.1\n    template_name: DEV template\n\n  tasks:\n    - name: Get the token\n      uri:\n        url: "https:\/\/{{ tower_host }}\/api\/v2\/users\/1\/personal_tokens\/"\n        method: POST\n        validate_certs: false\n        return_content: true\n        user: "{{ tower_user }}"\n        password: "{{ tower_pass }}"\n        force_basic_auth: true\n        status_code: 201\n      register: response\n\n    - name: Use the token\n      uri:\n        url: "https:\/\/{{ tower_host }}\/api\/v2\/job_templates\/{{ template_name | urlencode }}\/launch\/"\n        method: POST\n        validate_certs: false\n        return_content: true\n        status_code: 201\n        headers:\n          Authorization: "Bearer {{ response['json']['token'] }}"\n          Content-Type: "application\/json"\n      register: launch\n<\/pre><\/div>\n\n\n
Conclusion<\/h2>\n\n\n\n
AWX REST API is well designed and let you do almost all operation from command line. It is easy to create scripts to manage these operations. In the next blog I will explain how to get out all logs between two dates from AWX, and put them on the disk for an easy troubleshooting. <\/p>\n","protected":false},"excerpt":{"rendered":"
by Alexandre Nestor Introduction AWX provides a REST API which allows to do pretty all commands that can be executed through the web interface, using http requests. Sometimes is more easy to restart, or start jobs for instance through API, instead of going through the graphical interface. First access of REST API For instance, suppose […]<\/p>\n","protected":false},"author":27,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1321,1320],"tags":[2600,2894,2432,2667,1324],"type_dbi":[],"class_list":["post-24250","post","type-post","status-publish","format-standard","hentry","category-ansible","category-devops","tag-ansible-2","tag-automation-platform","tag-awx","tag-devops-2","tag-redhat"],"acf":[],"yoast_head":"\nHow to use AWX REST API to execute jobs - dbi Blog<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to use AWX REST API to execute jobs\" \/>\n<meta property=\"og:description\" content=\"by Alexandre Nestor Introduction AWX provides a REST API which allows to do pretty all commands that can be executed through the web interface, using http requests. Sometimes is more easy to restart, or start jobs for instance through API, instead of going through the graphical interface. First access of REST API For instance, suppose […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/\" \/>\n<meta property=\"og:site_name\" content=\"dbi Blog\" \/>\n<meta property=\"article:published_time\" content=\"2023-03-31T14:20:28+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-01-24T09:42:46+00:00\" \/>\n<meta name=\"author\" content=\"Oracle Team\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Oracle Team\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/how-to-use-awx-rest-api-to-execute-jobs\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/how-to-use-awx-rest-api-to-execute-jobs\\\/\"},\"author\":{\"name\":\"Oracle Team\",\"@id\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/#\\\/schema\\\/person\\\/66ab87129f2d357f09971bc7936a77ee\"},\"headline\":\"How to use AWX REST API to execute jobs\",\"datePublished\":\"2023-03-31T14:20:28+00:00\",\"dateModified\":\"2025-01-24T09:42:46+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/how-to-use-awx-rest-api-to-execute-jobs\\\/\"},\"wordCount\":254,\"commentCount\":1,\"keywords\":[\"Ansible\",\"Automation Platform\",\"awx\",\"devops\",\"redhat\"],\"articleSection\":[\"Ansible\",\"DevOps\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/how-to-use-awx-rest-api-to-execute-jobs\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/how-to-use-awx-rest-api-to-execute-jobs\\\/\",\"url\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/how-to-use-awx-rest-api-to-execute-jobs\\\/\",\"name\":\"How to use AWX REST API to execute jobs - dbi Blog\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/#website\"},\"datePublished\":\"2023-03-31T14:20:28+00:00\",\"dateModified\":\"2025-01-24T09:42:46+00:00\",\"author\":{\"@id\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/#\\\/schema\\\/person\\\/66ab87129f2d357f09971bc7936a77ee\"},\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/how-to-use-awx-rest-api-to-execute-jobs\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/how-to-use-awx-rest-api-to-execute-jobs\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/how-to-use-awx-rest-api-to-execute-jobs\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to use AWX REST API to execute jobs\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/\",\"name\":\"dbi Blog\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/#\\\/schema\\\/person\\\/66ab87129f2d357f09971bc7936a77ee\",\"name\":\"Oracle Team\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/f711f7cd2c9b09bf2627133755b569fb5be0694810cfd33033bdd095fedba86d?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/f711f7cd2c9b09bf2627133755b569fb5be0694810cfd33033bdd095fedba86d?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/f711f7cd2c9b09bf2627133755b569fb5be0694810cfd33033bdd095fedba86d?s=96&d=mm&r=g\",\"caption\":\"Oracle Team\"},\"url\":\"https:\\\/\\\/www.dbi-services.com\\\/blog\\\/author\\\/oracle-team\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"How to use AWX REST API to execute jobs - dbi Blog","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/","og_locale":"en_US","og_type":"article","og_title":"How to use AWX REST API to execute jobs","og_description":"by Alexandre Nestor Introduction AWX provides a REST API which allows to do pretty all commands that can be executed through the web interface, using http requests. Sometimes is more easy to restart, or start jobs for instance through API, instead of going through the graphical interface. First access of REST API For instance, suppose […]","og_url":"https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/","og_site_name":"dbi Blog","article_published_time":"2023-03-31T14:20:28+00:00","article_modified_time":"2025-01-24T09:42:46+00:00","author":"Oracle Team","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Oracle Team","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/#article","isPartOf":{"@id":"https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/"},"author":{"name":"Oracle Team","@id":"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/66ab87129f2d357f09971bc7936a77ee"},"headline":"How to use AWX REST API to execute jobs","datePublished":"2023-03-31T14:20:28+00:00","dateModified":"2025-01-24T09:42:46+00:00","mainEntityOfPage":{"@id":"https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/"},"wordCount":254,"commentCount":1,"keywords":["Ansible","Automation Platform","awx","devops","redhat"],"articleSection":["Ansible","DevOps"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/","url":"https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/","name":"How to use AWX REST API to execute jobs - dbi Blog","isPartOf":{"@id":"https:\/\/www.dbi-services.com\/blog\/#website"},"datePublished":"2023-03-31T14:20:28+00:00","dateModified":"2025-01-24T09:42:46+00:00","author":{"@id":"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/66ab87129f2d357f09971bc7936a77ee"},"breadcrumb":{"@id":"https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.dbi-services.com\/blog\/how-to-use-awx-rest-api-to-execute-jobs\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/www.dbi-services.com\/blog\/"},{"@type":"ListItem","position":2,"name":"How to use AWX REST API to execute jobs"}]},{"@type":"WebSite","@id":"https:\/\/www.dbi-services.com\/blog\/#website","url":"https:\/\/www.dbi-services.com\/blog\/","name":"dbi Blog","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.dbi-services.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/66ab87129f2d357f09971bc7936a77ee","name":"Oracle Team","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/f711f7cd2c9b09bf2627133755b569fb5be0694810cfd33033bdd095fedba86d?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/f711f7cd2c9b09bf2627133755b569fb5be0694810cfd33033bdd095fedba86d?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/f711f7cd2c9b09bf2627133755b569fb5be0694810cfd33033bdd095fedba86d?s=96&d=mm&r=g","caption":"Oracle Team"},"url":"https:\/\/www.dbi-services.com\/blog\/author\/oracle-team\/"}]}},"_links":{"self":[{"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/posts\/24250","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/users\/27"}],"replies":[{"embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/comments?post=24250"}],"version-history":[{"count":11,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/posts\/24250\/revisions"}],"predecessor-version":[{"id":36874,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/posts\/24250\/revisions\/36874"}],"wp:attachment":[{"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/media?parent=24250"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/categories?post=24250"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/tags?post=24250"},{"taxonomy":"type","embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/type_dbi?post=24250"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}