This page lists OAuth 2 utility endpoints used for authorization, token refresh and revoke.\nNote endpoints other than /api/o/authorize/ are not meant to be used in browsers and do not\nsupport HTTP GET. The endpoints here strictly follow\nRFC specs for OAuth2, so please use that for detailed\nreference. Note AWX net location default to http://localhost:8013 in examples:
Given an application \"AuthCodeApp\" of grant type authorization-code, \nfrom the client app, the user makes a GET to the Authorize endpoint with
response_typeclient_idredirect_urisscope AWX will respond with the authorization code and state\nto the redirect_uri specified in the application. The client application will then make a POST to the\napi/o/token/ endpoint on AWX with
codeclient_idclient_secretgrant_typeredirect_uriAWX will respond with the access_token, token_type, refresh_token, and expires_in. For more\ninformation on testing this flow, refer to django-oauth-toolkit.
Log in is not required for password grant type, so a simple curl can be used to acquire a personal access token\nvia /api/o/token/ with
grant_type: Required to be \"password\"usernamepasswordclient_id: Associated application must have grant_type \"password\"client_secretFor example:
\ncurl -X POST \\\n -H "Content-Type: application/x-www-form-urlencoded" \\\n -d "grant_type=password&username=<username>&password=<password>&scope=read" \\\n -u "gwSPoasWSdNkMDtBN3Hu2WYQpPWCO9SwUEsKK22l:fI6ZpfocHYBGfm1tP92r0yIgCyfRdDQt0Tos9L8a4fNsJjQQMwp9569e\nIaUBsaVDgt2eiwOGe0bg5m5vCSstClZmtdy359RVx2rQK5YlIWyPlrolpt2LEpVeKXWaiybo" \\\n http://localhost:8013/api/o/token/ -i\nIn the above post request, parameters username and password are username and password of the related\nAWX user of the underlying application, and the authentication information is of format\n<client_id>:<client_secret>, where client_id and client_secret are the corresponding fields of\nunderlying application.
Upon success, access token, refresh token and other information are given in the response body in JSON
", "operationId":"Authentication_o_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "summary":" Token Handling Using OAuth2", "tags":[ "Authentication" ], "x-internal-id":"api-o--get", "x-filename-id":"api-o-get" } }, "/api/v2/":{ "get":{ "description":"", "operationId":"Versioning_read", "parameters":[ ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "activity_stream":"/api/v2/activity_stream/", "ad_hoc_commands":"/api/v2/ad_hoc_commands/", "applications":"/api/v2/applications/", "config":"/api/v2/config/", "credential_input_sources":"/api/v2/credential_input_sources/", "credential_types":"/api/v2/credential_types/", "credentials":"/api/v2/credentials/", "dashboard":"/api/v2/dashboard/", "groups":"/api/v2/groups/", "hosts":"/api/v2/hosts/", "instance_groups":"/api/v2/instance_groups/", "instances":"/api/v2/instances/", "inventory":"/api/v2/inventories/", "inventory_scripts":"/api/v2/inventory_scripts/", "inventory_sources":"/api/v2/inventory_sources/", "inventory_updates":"/api/v2/inventory_updates/", "job_events":"/api/v2/job_events/", "job_templates":"/api/v2/job_templates/", "jobs":"/api/v2/jobs/", "labels":"/api/v2/labels/", "me":"/api/v2/me/", "metrics":"/api/v2/metrics/", "notification_templates":"/api/v2/notification_templates/", "notifications":"/api/v2/notifications/", "organizations":"/api/v2/organizations/", "ping":"/api/v2/ping/", "project_updates":"/api/v2/project_updates/", "projects":"/api/v2/projects/", "roles":"/api/v2/roles/", "schedules":"/api/v2/schedules/", "settings":"/api/v2/settings/", "system_job_templates":"/api/v2/system_job_templates/", "system_jobs":"/api/v2/system_jobs/", "teams":"/api/v2/teams/", "tokens":"/api/v2/tokens/", "unified_job_templates":"/api/v2/unified_job_templates/", "unified_jobs":"/api/v2/unified_jobs/", "users":"/api/v2/users/", "workflow_approvals":"/api/v2/workflow_approvals/", "workflow_job_nodes":"/api/v2/workflow_job_nodes/", "workflow_job_template_nodes":"/api/v2/workflow_job_template_nodes/", "workflow_job_templates":"/api/v2/workflow_job_templates/", "workflow_jobs":"/api/v2/workflow_jobs/" } } } }, "summary":"List Top Level Resources", "tags":[ "Versioning" ], "x-internal-id":"api-v2--get", "x-filename-id":"api-v2-get" } }, "/api/v2/activity_stream/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nactivity streams.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=\nPrefix the field name with a dash - to sort in reverse:
?order_by=-\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single activity stream\nrecord containing the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)Make a GET request to this resource to retrieve the list of\nad hoc command events.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of ad hoc command events\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more ad hoc command event records.
Each ad hoc command event data structure includes the following fields:
\nid: Database ID for this ad hoc command event. (integer)type: Data type for this ad hoc command event. (choice)url: URL for this ad hoc command event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this ad hoc command event was created. (datetime)modified: Timestamp when this ad hoc command event was last modified. (datetime)ad_hoc_command: (id)event: (choice)runner_on_failed: Host Failedrunner_on_ok: Host OKrunner_on_unreachable: Host Unreachablerunner_on_skipped: Host Skippeddebug: Debugverbose: Verbosedeprecated: Deprecatedwarning: Warningsystem_warning: System Warningerror: Errorcounter: (integer)event_display: (string)event_data: (json)failed: (boolean)changed: (boolean)uuid: (string)host: (id)host_name: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)To specify that ad hoc command events are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single ad hoc command event\nrecord containing the following fields:
\nid: Database ID for this ad hoc command event. (integer)type: Data type for this ad hoc command event. (choice)url: URL for this ad hoc command event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this ad hoc command event was created. (datetime)modified: Timestamp when this ad hoc command event was last modified. (datetime)ad_hoc_command: (id)event: (choice)runner_on_failed: Host Failedrunner_on_ok: Host OKrunner_on_unreachable: Host Unreachablerunner_on_skipped: Host Skippeddebug: Debugverbose: Verbosedeprecated: Deprecatedwarning: Warningsystem_warning: System Warningerror: Errorcounter: (integer)event_display: (string)event_data: (json)failed: (boolean)changed: (boolean)uuid: (string)host: (id)host_name: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)Make a GET request to this resource to retrieve the list of\nad hoc commands.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of ad hoc commands\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more ad hoc command records.
Each ad hoc command data structure includes the following fields:
\nid: Database ID for this ad hoc command. (integer)type: Data type for this ad hoc command. (choice)url: URL for this ad hoc command. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this ad hoc command was created. (datetime)modified: Timestamp when this ad hoc command was last modified. (datetime)name: Name of this ad hoc command. (string)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)controller_node: The instance that managed the isolated execution environment. (string)job_type: (choice)run: Runcheck: Checkinventory: (id)limit: (string)credential: (id)module_name: (choice)commandshellyumaptapt_keyapt_repositoryapt_rpmservicegroupusermountpingselinuxsetupwin_pingwin_servicewin_updateswin_groupwin_usermodule_args: (string)forks: (integer)verbosity: (choice)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (string)become_enabled: (boolean)diff_mode: (boolean)To specify that ad hoc commands are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following ad hoc command\nfields to create a new ad hoc command:
\njob_type: (choice)run: Run (default)check: Checkinventory: (id, default=``)limit: (string, default=\"\")credential: (id, default=``)module_name: (choice)command (default)shellyumaptapt_keyapt_repositoryapt_rpmservicegroupusermountpingselinuxsetupwin_pingwin_servicewin_updateswin_groupwin_usermodule_args: (string, default=\"\")forks: (integer, default=0)verbosity: (choice)0: 0 (Normal) (default)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (string, default=\"\")become_enabled: (boolean, default=False)diff_mode: (boolean, default=False)Make a DELETE request to this resource to delete this ad hoc command.
", "operationId":"Ad Hoc Commands_ad_hoc_commands_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"Cannot delete running job resource." } }, "description":"" } }, "summary":" Delete an Ad Hoc Command", "tags":[ "Ad Hoc Commands" ], "x-internal-id":"api-v2-ad_hoc_commands-{id}--delete", "x-filename-id":"api-v2-ad_hoc_commands-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:
\nid: Database ID for this ad hoc command. (integer)type: Data type for this ad hoc command. (choice)url: URL for this ad hoc command. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this ad hoc command was created. (datetime)modified: Timestamp when this ad hoc command was last modified. (datetime)name: Name of this ad hoc command. (string)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_args: (string)job_cwd: (string)job_env: (json)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)controller_node: The instance that managed the isolated execution environment. (string)result_traceback: (string)event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)job_type: (choice)run: Runcheck: Checkinventory: (id)limit: (string)credential: (id)module_name: (choice)commandshellyumaptapt_keyapt_repositoryapt_rpmservicegroupusermountpingselinuxsetupwin_pingwin_servicewin_updateswin_groupwin_usermodule_args: (string)forks: (integer)verbosity: (choice)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (string)become_enabled: (boolean)diff_mode: (boolean)host_status_counts: A count of hosts uniquely assigned to each status. (field)Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nad hoc command.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:
\ncan_cancel: (boolean)Make GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:
\ncan_cancel: (boolean)Make a GET request to this resource to retrieve a list of\nad hoc command events associated with the selected\nad hoc command.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of ad hoc command events\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more ad hoc command event records.
Each ad hoc command event data structure includes the following fields:
\nid: Database ID for this ad hoc command event. (integer)type: Data type for this ad hoc command event. (choice)url: URL for this ad hoc command event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this ad hoc command event was created. (datetime)modified: Timestamp when this ad hoc command event was last modified. (datetime)ad_hoc_command: (id)event: (choice)runner_on_failed: Host Failedrunner_on_ok: Host OKrunner_on_unreachable: Host Unreachablerunner_on_skipped: Host Skippeddebug: Debugverbose: Verbosedeprecated: Deprecatedwarning: Warningsystem_warning: System Warningerror: Errorcounter: (integer)event_display: (string)event_data: (json)failed: (boolean)changed: (boolean)uuid: (string)host: (id)host_name: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)To specify that ad hoc command events are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nad hoc command.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notifications\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification records.
Each notification data structure includes the following fields:
\nid: Database ID for this notification. (integer)type: Data type for this notification. (choice)url: URL for this notification. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification was created. (datetime)modified: Timestamp when this notification was last modified. (datetime)notification_template: (id)error: (string)status: (choice)pending: Pendingsuccessful: Successfulfailed: Failednotifications_sent: (integer)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhookrecipients: (string)subject: (string)body: Notification body (json)To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.
", "operationId":"Ad Hoc Commands_ad_hoc_commands_relaunch_list", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A page number within the paginated result set.", "in":"query", "name":"page", "required":false, "type":"integer" }, { "description":"Number of results to return per page.", "in":"query", "name":"page_size", "required":false, "type":"integer" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":"Relaunch an Ad Hoc Command", "tags":[ "Ad Hoc Commands" ], "x-internal-id":"api-v2-ad_hoc_commands-{id}-relaunch--get", "x-filename-id":"api-v2-ad_hoc_commands-id-relaunch-get" }, "post":{ "description":"Make a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.
", "operationId":"Ad Hoc Commands_ad_hoc_commands_relaunch_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "responses":{ "201":{ "description":"" } }, "summary":"Relaunch an Ad Hoc Command", "tags":[ "Ad Hoc Commands" ], "x-internal-id":"api-v2-ad_hoc_commands-{id}-relaunch--post", "x-filename-id":"api-v2-ad_hoc_commands-id-relaunch-post" } }, "/api/v2/ad_hoc_commands/{id}/stdout/":{ "get":{ "description":"Make GET request to this resource to retrieve the stdout from running this\nad hoc command.
\nUse the format query string parameter to specify the output format.
?format=api?format=html?format=txt?format=ansi?format=json?format=txt_download?format=ansi_download(New in Ansible Tower 2.0.0) When using the Browsable API, HTML and JSON\nformats, the start_line and end_line query string parameters can be used\nto specify a range of line numbers to retrieve.
Use dark=1 or dark=0 as a query string parameter to force or disable a\ndark background.
Files over 1.0??MB (configurable)\nwill not display in the browser. Use the txt_download or ansi_download\nformats to download the file directly to view it.
Make a GET request to this resource to retrieve the list of\napplications.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of applications\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more application records.
Each application data structure includes the following fields:
\nid: Database ID for this application. (integer)type: Data type for this application. (choice)url: URL for this application. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this application was created. (datetime)modified: Timestamp when this application was last modified. (datetime)name: Name of this application. (string)description: Optional description of this application. (string)client_id: (string)client_secret: Used for more stringent verification of access to an application when creating a token. (string)client_type: Set to Public or Confidential depending on how secure the client device is. (choice)confidential: Confidentialpublic: Publicredirect_uris: Allowed URIs list, space separated (string)authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice)authorization-code: Authorization codepassword: Resource owner password-basedskip_authorization: Set True to skip authorization step for completely trusted applications. (boolean)organization: Organization containing this application. (id)To specify that applications are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following application\nfields to create a new application:
\nname: Name of this application. (string, required)description: Optional description of this application. (string, default=\"\")
client_type: Set to Public or Confidential depending on how secure the client device is. (choice, required)
confidential: Confidentialpublic: Publicredirect_uris: Allowed URIs list, space separated (string, default=\"\")authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice, required)authorization-code: Authorization codepassword: Resource owner password-basedskip_authorization: Set True to skip authorization step for completely trusted applications. (boolean, default=False)organization: Organization containing this application. (id, required)Make a DELETE request to this resource to delete this application.
", "operationId":"Authentication_applications_delete_0", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete an Application", "tags":[ "Authentication" ], "x-internal-id":"api-v2-applications-{id}--delete", "x-filename-id":"api-v2-applications-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single application\nrecord containing the following fields:
\nid: Database ID for this application. (integer)type: Data type for this application. (choice)url: URL for this application. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this application was created. (datetime)modified: Timestamp when this application was last modified. (datetime)name: Name of this application. (string)description: Optional description of this application. (string)client_id: (string)client_secret: Used for more stringent verification of access to an application when creating a token. (string)client_type: Set to Public or Confidential depending on how secure the client device is. (choice)confidential: Confidentialpublic: Publicredirect_uris: Allowed URIs list, space separated (string)authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice)authorization-code: Authorization codepassword: Resource owner password-basedskip_authorization: Set True to skip authorization step for completely trusted applications. (boolean)organization: Organization containing this application. (id)Make a PUT or PATCH request to this resource to update this\napplication. The following fields may be modified:
\nname: Name of this application. (string, required)description: Optional description of this application. (string, default=\"\")
client_type: Set to Public or Confidential depending on how secure the client device is. (choice, required)
confidential: Confidentialpublic: Publicredirect_uris: Allowed URIs list, space separated (string, default=\"\")authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice, required)authorization-code: Authorization codepassword: Resource owner password-basedskip_authorization: Set True to skip authorization step for completely trusted applications. (boolean, default=False)organization: Organization containing this application. (id, required)For a PATCH request, include only the fields that are being modified.
", "operationId":"Authentication_applications_partial_update_0", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "authorization_grant_type":"password", "name":"Test app with immutable grant type and user", "organization":1, "redirect_uris":"http://localhost/api/", "skip_authorization":true } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "authorization_grant_type":"password", "client_id":"xxxx", "client_secret":"************", "client_type":"confidential", "created":"2018-02-01T08:00:00.000000Z", "description":"", "id":1, "modified":"2018-02-01T08:00:00.000000Z", "name":"Test app with immutable grant type and user", "organization":1, "redirect_uris":"http://localhost/api/", "related":{ "activity_stream":"/api/v2/applications/1/activity_stream/", "tokens":"/api/v2/applications/1/tokens/" }, "skip_authorization":true, "summary_fields":{ "organization":{ "description":"test-org-desc", "id":1, "name":"test-org" }, "tokens":{ "count":0, "results":[ ] }, "user":{ "first_name":"", "id":1, "last_name":"", "username":"admin" }, "user_capabilities":{ "delete":true, "edit":true } }, "type":"o_auth2_application", "url":"/api/v2/applications/1/" } } } }, "summary":" Update an Application", "tags":[ "Authentication" ], "x-internal-id":"api-v2-applications-{id}--patch", "x-filename-id":"api-v2-applications-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\napplication. The following fields may be modified:
\nname: Name of this application. (string, required)description: Optional description of this application. (string, default=\"\")
client_type: Set to Public or Confidential depending on how secure the client device is. (choice, required)
confidential: Confidentialpublic: Publicredirect_uris: Allowed URIs list, space separated (string, default=\"\")authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice, required)authorization-code: Authorization codepassword: Resource owner password-basedskip_authorization: Set True to skip authorization step for completely trusted applications. (boolean, default=False)organization: Organization containing this application. (id, required)For a PUT request, include all fields in the request.
", "operationId":"Authentication_applications_update_0", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "authorization_grant_type":{ "description":"The Grant type the user must use for acquire tokens for this application.", "type":"string" }, "client_type":{ "description":"Set to Public or Confidential depending on how secure the client device is.", "type":"string" }, "description":{ "description":"", "type":"string" }, "name":{ "description":"", "type":"string" }, "organization":{ "description":"Organization containing this application.", "type":"integer" }, "redirect_uris":{ "description":"Allowed URIs list, space separated", "type":"string" }, "skip_authorization":{ "description":"Set True to skip authorization step for completely trusted applications.", "type":"boolean" } }, "required":[ "name", "client_type", "authorization_grant_type", "organization" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update an Application", "tags":[ "Authentication" ], "x-internal-id":"api-v2-applications-{id}--put", "x-filename-id":"api-v2-applications-id-put" } }, "/api/v2/applications/{id}/activity_stream/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\napplication.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\napplication.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of access tokens\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more access token records.
Each access token data structure includes the following fields:
\nid: Database ID for this access token. (integer)type: Data type for this access token. (choice)url: URL for this access token. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this access token was created. (datetime)modified: Timestamp when this access token was last modified. (datetime)description: Optional description of this access token. (string)user: The user representing the token owner (id)token: (string)refresh_token: (field)application: (id)expires: (datetime)scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)To specify that access tokens are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following access token\nfields to create a new access token associated with this\napplication.
\ndescription: Optional description of this access token. (string, default=\"\")
scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")
Make a GET request to this resource to retrieve the list of\ncredential input sources.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credential input sources\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential input source records.
Each credential input source data structure includes the following fields:
\nid: Database ID for this credential input source. (integer)type: Data type for this credential input source. (choice)url: URL for this credential input source. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential input source was created. (datetime)modified: Timestamp when this credential input source was last modified. (datetime)description: Optional description of this credential input source. (string)input_field_name: (string)metadata: (json)target_credential: (id)source_credential: (id)To specify that credential input sources are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential input source\nfields to create a new credential input source:
\ndescription: Optional description of this credential input source. (string, default=\"\")input_field_name: (string, required)metadata: (json, default={})target_credential: (id, required)source_credential: (id, required)Make a DELETE request to this resource to delete this credential input source.
", "operationId":"Credential Input Sources_credential_input_sources_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Delete a Credential Input Source", "tags":[ "Credential Input Sources" ], "x-internal-id":"api-v2-credential_input_sources-{id}--delete", "x-filename-id":"api-v2-credential_input_sources-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single credential input source\nrecord containing the following fields:
\nid: Database ID for this credential input source. (integer)type: Data type for this credential input source. (choice)url: URL for this credential input source. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential input source was created. (datetime)modified: Timestamp when this credential input source was last modified. (datetime)description: Optional description of this credential input source. (string)input_field_name: (string)metadata: (json)target_credential: (id)source_credential: (id)Make a PUT or PATCH request to this resource to update this\ncredential input source. The following fields may be modified:
\ndescription: Optional description of this credential input source. (string, default=\"\")input_field_name: (string, required)metadata: (json, default={})target_credential: (id, required)source_credential: (id, required)For a PATCH request, include only the fields that are being modified.
", "operationId":"Credential Input Sources_credential_input_sources_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "metadata":{ "key":"some_other_key" } } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "created":"2018-02-01T08:00:00.000000Z", "description":"", "id":1, "input_field_name":"password", "metadata":{ "key":"some_other_key" }, "modified":"2018-02-01T08:00:00.000000Z", "related":{ "source_credential":"/api/v2/credentials/2/", "target_credential":"/api/v2/credentials/1/" }, "source_credential":2, "summary_fields":{ "source_credential":{ "cloud":false, "credential_type_id":2, "description":"", "id":2, "name":"external-cred" }, "target_credential":{ "cloud":false, "credential_type_id":1, "description":"", "id":1, "kind":"ssh", "name":"machine-cred" }, "user_capabilities":{ "delete":true } }, "target_credential":1, "type":"credential_input_source", "url":"/api/v2/credential_input_sources/1/" } } }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Update a Credential Input Source", "tags":[ "Credential Input Sources" ], "x-internal-id":"api-v2-credential_input_sources-{id}--patch", "x-filename-id":"api-v2-credential_input_sources-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\ncredential input source. The following fields may be modified:
\ndescription: Optional description of this credential input source. (string, default=\"\")input_field_name: (string, required)metadata: (json, default={})target_credential: (id, required)source_credential: (id, required)For a PUT request, include all fields in the request.
", "operationId":"Credential Input Sources_credential_input_sources_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "input_field_name":{ "description":"", "type":"string" }, "metadata":{ "description":"", "type":"object" }, "source_credential":{ "description":"", "type":"integer" }, "target_credential":{ "description":"", "type":"integer" } }, "required":[ "input_field_name", "target_credential", "source_credential" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Credential Input Source", "tags":[ "Credential Input Sources" ], "x-internal-id":"api-v2-credential_input_sources-{id}--put", "x-filename-id":"api-v2-credential_input_sources-id-put" } }, "/api/v2/credential_types/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\ncredential types.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credential types\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential type records.
Each credential type data structure includes the following fields:
\nid: Database ID for this credential type. (integer)type: Data type for this credential type. (choice)url: URL for this credential type. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential type was created. (datetime)modified: Timestamp when this credential type was last modified. (datetime)name: Name of this credential type. (string)description: Optional description of this credential type. (string)kind: (choice)ssh: Machinevault: Vaultnet: Networkscm: Source Controlcloud: Cloudtoken: Personal Access Tokeninsights: Insightsexternal: Externalkubernetes: Kubernetesgalaxy: Galaxy/Automation Hubnamespace: (string)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)injectors: Enter injectors using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)To specify that credential types are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential type\nfields to create a new credential type:
\nname: Name of this credential type. (string, required)description: Optional description of this credential type. (string, default=\"\")kind: (choice, required)
net: Networkcloud: Cloudinputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
injectors: Enter injectors using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})Make a DELETE request to this resource to delete this credential type.
", "operationId":"Credential Types_credential_types_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "401":{ "examples":{ "application/json":{ "detail":"Authentication credentials were not provided. To establish a login session, visit /api/login/." } }, "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"Credential types that are in use cannot be deleted" } }, "description":"" } }, "summary":" Delete a Credential Type", "tags":[ "Credential Types" ], "x-internal-id":"api-v2-credential_types-{id}--delete", "x-filename-id":"api-v2-credential_types-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:
\nid: Database ID for this credential type. (integer)type: Data type for this credential type. (choice)url: URL for this credential type. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential type was created. (datetime)modified: Timestamp when this credential type was last modified. (datetime)name: Name of this credential type. (string)description: Optional description of this credential type. (string)kind: (choice)ssh: Machinevault: Vaultnet: Networkscm: Source Controlcloud: Cloudtoken: Personal Access Tokeninsights: Insightsexternal: Externalkubernetes: Kubernetesgalaxy: Galaxy/Automation Hubnamespace: (string)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)injectors: Enter injectors using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)Make a PUT or PATCH request to this resource to update this\ncredential type. The following fields may be modified:
\nname: Name of this credential type. (string, required)description: Optional description of this credential type. (string, default=\"\")kind: (choice, required)
net: Networkcloud: Cloudinputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
injectors: Enter injectors using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})For a PATCH request, include only the fields that are being modified.
", "operationId":"Credential Types_credential_types_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "name":"Some Other Name" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "created":"2018-02-01T08:00:00.000000Z", "description":"", "id":1, "injectors":{ }, "inputs":{ }, "kind":"cloud", "managed_by_tower":false, "modified":"2018-02-01T08:00:00.000000Z", "name":"Some Other Name", "namespace":null, "related":{ "activity_stream":"/api/v2/credential_types/1/activity_stream/", "credentials":"/api/v2/credential_types/1/credentials/" }, "summary_fields":{ "user_capabilities":{ "delete":true, "edit":true } }, "type":"credential_type", "url":"/api/v2/credential_types/1/" } } }, "401":{ "examples":{ "application/json":{ "detail":"Authentication credentials were not provided. To establish a login session, visit /api/login/." } }, "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"Modifications to inputs are not allowed for credential types that are in use" } }, "description":"" } }, "summary":" Update a Credential Type", "tags":[ "Credential Types" ], "x-internal-id":"api-v2-credential_types-{id}--patch", "x-filename-id":"api-v2-credential_types-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\ncredential type. The following fields may be modified:
\nname: Name of this credential type. (string, required)description: Optional description of this credential type. (string, default=\"\")kind: (choice, required)
net: Networkcloud: Cloudinputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
injectors: Enter injectors using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})For a PUT request, include all fields in the request.
", "operationId":"Credential Types_credential_types_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "injectors":{ "description":"Enter injectors using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax.", "type":"object" }, "inputs":{ "description":"Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax.", "type":"object" }, "kind":{ "description":"", "type":"string" }, "name":{ "description":"", "type":"string" } }, "required":[ "name", "kind" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Credential Type", "tags":[ "Credential Types" ], "x-internal-id":"api-v2-credential_types-{id}--put", "x-filename-id":"api-v2-credential_types-id-put" } }, "/api/v2/credential_types/{id}/activity_stream/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ncredential type.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ncredential type.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: (id)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential\nfields to create a new credential associated with this\ncredential type.
\nname: Name of this credential. (string, required)description: Optional description of this credential. (string, default=\"\")organization: (id, default=None)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)
inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:
", "operationId":"Credential Types_credential_types_test_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":" Retrieve a Credential Type", "tags":[ "Credential Types" ], "x-internal-id":"api-v2-credential_types-{id}-test--get", "x-filename-id":"api-v2-credential_types-id-test-get" }, "post":{ "description":"Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:
", "operationId":"Credential Types_credential_types_test_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "inputs":{ }, "metadata":{ } } } } ], "produces":[ "application/json" ], "responses":{ "201":{ "description":"" }, "202":{ "examples":{ "application/json":{ } }, "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Retrieve a Credential Type", "tags":[ "Credential Types" ], "x-internal-id":"api-v2-credential_types-{id}-test--post", "x-filename-id":"api-v2-credential_types-id-test-post" } }, "/api/v2/credentials/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\ncredentials.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential\nfields to create a new credential:
\nname: Name of this credential. (string, required)description: Optional description of this credential. (string, default=\"\")organization: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id, default=None)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)
inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
user: Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation. (id, default=None)
team: Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation. (id, default=None)Make a DELETE request to this resource to delete this credential.
", "operationId":"Credentials_credentials_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}--delete", "x-filename-id":"api-v2-credentials-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: (id)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)Make a PUT or PATCH request to this resource to update this\ncredential. The following fields may be modified:
\nname: Name of this credential. (string, required)description: Optional description of this credential. (string, default=\"\")organization: (id, default=None)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)
inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
For a PATCH request, include only the fields that are being modified.
", "operationId":"Credentials_credentials_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "inputs":{ "password":"$encrypted$", "username":"joe" } } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "cloud":false, "created":"2018-02-01T08:00:00.000000Z", "credential_type":1, "description":"", "id":1, "inputs":{ "password":"$encrypted$", "username":"joe" }, "kind":"ssh", "kubernetes":false, "managed_by_tower":false, "modified":"2018-02-01T08:00:00.000000Z", "name":"Best credential ever", "organization":1, "related":{ "access_list":"/api/v2/credentials/1/access_list/", "activity_stream":"/api/v2/credentials/1/activity_stream/", "copy":"/api/v2/credentials/1/copy/", "credential_type":"/api/v2/credential_types/1/", "input_sources":"/api/v2/credentials/1/input_sources/", "object_roles":"/api/v2/credentials/1/object_roles/", "organization":"/api/v2/organizations/1/", "owner_teams":"/api/v2/credentials/1/owner_teams/", "owner_users":"/api/v2/credentials/1/owner_users/" }, "summary_fields":{ "credential_type":{ "description":"", "id":1, "name":"Machine" }, "object_roles":{ "admin_role":{ "description":"Can manage all aspects of the credential", "id":15, "name":"Admin" }, "read_role":{ "description":"May view settings for the credential", "id":17, "name":"Read" }, "use_role":{ "description":"Can use the credential in a job template", "id":16, "name":"Use" } }, "organization":{ "description":"test-org-desc", "id":1, "name":"test-org" }, "owners":[ { "description":"test-org-desc", "id":1, "name":"test-org", "type":"organization", "url":"/api/v2/organizations/1/" } ], "user_capabilities":{ "copy":true, "delete":true, "edit":true, "use":true } }, "type":"credential", "url":"/api/v2/credentials/1/" } } }, "400":{ "examples":{ "application/json":{ "credential_type":[ "You cannot change the credential type of the credential, as it may break the functionality of the resources using it." ] } }, "description":"" } }, "summary":" Update a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}--patch", "x-filename-id":"api-v2-credentials-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\ncredential. The following fields may be modified:
\nname: Name of this credential. (string, required)description: Optional description of this credential. (string, default=\"\")organization: (id, default=None)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)
inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
For a PUT request, include all fields in the request.
", "operationId":"Credentials_credentials_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "credential_type":1, "inputs":{ "ssh_key_data":"$encrypted$", "ssh_key_unlock":"new-unlock", "username":"joe" }, "name":"Best credential ever", "organization":1 } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "cloud":false, "created":"2018-02-01T08:00:00.000000Z", "credential_type":1, "description":"", "id":1, "inputs":{ "ssh_key_data":"$encrypted$", "ssh_key_unlock":"$encrypted$", "username":"joe" }, "kind":"ssh", "kubernetes":false, "managed_by_tower":false, "modified":"2018-02-01T08:00:00.000000Z", "name":"Best credential ever", "organization":1, "related":{ "access_list":"/api/v2/credentials/1/access_list/", "activity_stream":"/api/v2/credentials/1/activity_stream/", "copy":"/api/v2/credentials/1/copy/", "credential_type":"/api/v2/credential_types/1/", "input_sources":"/api/v2/credentials/1/input_sources/", "object_roles":"/api/v2/credentials/1/object_roles/", "organization":"/api/v2/organizations/1/", "owner_teams":"/api/v2/credentials/1/owner_teams/", "owner_users":"/api/v2/credentials/1/owner_users/" }, "summary_fields":{ "credential_type":{ "description":"", "id":1, "name":"Machine" }, "object_roles":{ "admin_role":{ "description":"Can manage all aspects of the credential", "id":15, "name":"Admin" }, "read_role":{ "description":"May view settings for the credential", "id":17, "name":"Read" }, "use_role":{ "description":"Can use the credential in a job template", "id":16, "name":"Use" } }, "organization":{ "description":"test-org-desc", "id":1, "name":"test-org" }, "owners":[ { "description":"test-org-desc", "id":1, "name":"test-org", "type":"organization", "url":"/api/v2/organizations/1/" } ], "user_capabilities":{ "copy":true, "delete":true, "edit":true, "use":true } }, "type":"credential", "url":"/api/v2/credentials/1/" } } }, "400":{ "examples":{ "application/json":{ "inputs":{ "ssh_key_data":[ "Invalid certificate or key: invalid-key..." ] } } }, "description":"" } }, "summary":" Update a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}--put", "x-filename-id":"api-v2-credentials-id-put" } }, "/api/v2/credentials/{id}/access_list/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nusers.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ncredential.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\ncredential input sources associated with the selected\ncredential.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credential input sources\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential input source records.
Each credential input source data structure includes the following fields:
\nid: Database ID for this credential input source. (integer)type: Data type for this credential input source. (choice)url: URL for this credential input source. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential input source was created. (datetime)modified: Timestamp when this credential input source was last modified. (datetime)description: Optional description of this credential input source. (string)input_field_name: (string)metadata: (json)target_credential: (id)source_credential: (id)To specify that credential input sources are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential input source\nfields to create a new credential input source associated with this\ncredential.
\ndescription: Optional description of this credential input source. (string, default=\"\")input_field_name: (string, required)metadata: (json, default={})
source_credential: (id, required)
Make a GET request to this resource to retrieve a list of\nroles associated with the selected\ncredential.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nteams associated with the selected\ncredential.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of teams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more team records.
Each team data structure includes the following fields:
\nid: Database ID for this team. (integer)type: Data type for this team. (choice)url: URL for this team. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this team was created. (datetime)modified: Timestamp when this team was last modified. (datetime)name: Name of this team. (string)description: Optional description of this team. (string)organization: (id)To specify that teams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nusers associated with the selected\ncredential.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single credential\nrecord containing the following fields:
", "operationId":"Credentials_credentials_test_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":" Retrieve a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}-test--get", "x-filename-id":"api-v2-credentials-id-test-get" }, "post":{ "description":"Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:
", "operationId":"Credentials_credentials_test_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "metadata":{ "key":"some_key" } } } } ], "produces":[ "application/json" ], "responses":{ "201":{ "description":"" }, "202":{ "examples":{ "application/json":{ } }, "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Retrieve a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}-test--post", "x-filename-id":"api-v2-credentials-id-test-post" } }, "/api/v2/dashboard/":{ "get":{ "description":"", "operationId":"Dashboard_dashboard_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "summary":"Show Dashboard Details", "tags":[ "Dashboard" ], "x-internal-id":"api-v2-dashboard--get", "x-filename-id":"api-v2-dashboard-get" } }, "/api/v2/dashboard/graphs/jobs/":{ "get":{ "description":"Make a GET request to this resource to retrieve aggregate statistics about job runs suitable for graphing.
\nThe period of the data can be adjusted with:
?period=month\nWhere month can be replaced with week, or day. month is the default.
The type of job can be filtered with:
\n?job_type=all\nWhere all can be replaced with inv_sync, playbook_run or scm_update. all is the default.
Data will be returned in the following format:
\n\"jobs\": {\n \"successful\": [\n [\n 1402808400.0, \n 9\n ], ... ],\n \"failed\": [\n [\n 1402808400.0, \n 3\n ], ... ]\n}\nEach element contains an epoch timestamp represented in seconds and a numerical value indicating\nthe number of events during that time period
", "operationId":"Dashboard_dashboard_graphs_jobs_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "summary":" View Statistics for Job Runs", "tags":[ "Dashboard" ], "x-internal-id":"api-v2-dashboard-graphs-jobs--get", "x-filename-id":"api-v2-dashboard-graphs-jobs-get" } }, "/api/v2/groups/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\ngroups.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more group records.
Each group data structure includes the following fields:
\nid: Database ID for this group. (integer)type: Data type for this group. (choice)url: URL for this group. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this group was created. (datetime)modified: Timestamp when this group was last modified. (datetime)name: Name of this group. (string)description: Optional description of this group. (string)inventory: (id)variables: Group variables in JSON or YAML format. (json)To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following group\nfields to create a new group:
\nname: Name of this group. (string, required)description: Optional description of this group. (string, default=\"\")inventory: (id, required)variables: Group variables in JSON or YAML format. (json, default=``)Make a DELETE request to this resource to delete this group.
", "operationId":"Groups_groups_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Delete a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}--delete", "x-filename-id":"api-v2-groups-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single group\nrecord containing the following fields:
\nid: Database ID for this group. (integer)type: Data type for this group. (choice)url: URL for this group. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this group was created. (datetime)modified: Timestamp when this group was last modified. (datetime)name: Name of this group. (string)description: Optional description of this group. (string)inventory: (id)variables: Group variables in JSON or YAML format. (json)Make a PUT or PATCH request to this resource to update this\ngroup. The following fields may be modified:
\nname: Name of this group. (string, required)description: Optional description of this group. (string, default=\"\")inventory: (id, required)variables: Group variables in JSON or YAML format. (json, default=``)For a PATCH request, include only the fields that are being modified.
", "operationId":"Groups_groups_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "inventory":{ "description":"", "type":"integer" }, "name":{ "description":"", "type":"string" }, "variables":{ "description":"Group variables in JSON or YAML format.", "type":"string" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}--patch", "x-filename-id":"api-v2-groups-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\ngroup. The following fields may be modified:
\nname: Name of this group. (string, required)description: Optional description of this group. (string, default=\"\")inventory: (id, required)variables: Group variables in JSON or YAML format. (json, default=``)For a PUT request, include all fields in the request.
", "operationId":"Groups_groups_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "description":"Hello world", "name":"New name" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "created":"2018-02-01T08:00:00.000000Z", "description":"Hello world", "id":1, "inventory":1, "modified":"2018-02-01T08:00:00.000000Z", "name":"New name", "related":{ "activity_stream":"/api/v2/groups/1/activity_stream/", "ad_hoc_commands":"/api/v2/groups/1/ad_hoc_commands/", "all_hosts":"/api/v2/groups/1/all_hosts/", "children":"/api/v2/groups/1/children/", "hosts":"/api/v2/groups/1/hosts/", "inventory":"/api/v2/inventories/1/", "inventory_sources":"/api/v2/groups/1/inventory_sources/", "job_events":"/api/v2/groups/1/job_events/", "job_host_summaries":"/api/v2/groups/1/job_host_summaries/", "potential_children":"/api/v2/groups/1/potential_children/", "variable_data":"/api/v2/groups/1/variable_data/" }, "summary_fields":{ "inventory":{ "description":"", "has_active_failures":false, "has_inventory_sources":false, "hosts_with_active_failures":0, "id":1, "inventory_sources_with_failures":0, "kind":"", "name":"test-inv", "organization_id":1, "total_groups":0, "total_hosts":0, "total_inventory_sources":0 }, "user_capabilities":{ "copy":true, "delete":true, "edit":true } }, "type":"group", "url":"/api/v2/groups/1/", "variables":"" } } }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Update a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}--put", "x-filename-id":"api-v2-groups-id-put" } }, "/api/v2/groups/{id}/activity_stream/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ngroup.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\ngroup.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of ad hoc commands\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more ad hoc command records.
Each ad hoc command data structure includes the following fields:
\nid: Database ID for this ad hoc command. (integer)type: Data type for this ad hoc command. (choice)url: URL for this ad hoc command. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this ad hoc command was created. (datetime)modified: Timestamp when this ad hoc command was last modified. (datetime)name: Name of this ad hoc command. (string)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)controller_node: The instance that managed the isolated execution environment. (string)job_type: (choice)run: Runcheck: Checkinventory: (id)limit: (string)credential: (id)module_name: (choice)commandshellyumaptapt_keyapt_repositoryapt_rpmservicegroupusermountpingselinuxsetupwin_pingwin_servicewin_updateswin_groupwin_usermodule_args: (string)forks: (integer)verbosity: (choice)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (string)become_enabled: (boolean)diff_mode: (boolean)To specify that ad hoc commands are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following ad hoc command\nfields to create a new ad hoc command associated with this\ngroup.
\njob_type: (choice)run: Run (default)check: Checkinventory: (id, default=``)limit: (string, default=\"\")credential: (id, default=``)module_name: (choice)command (default)shellyumaptapt_keyapt_repositoryapt_rpmservicegroupusermountpingselinuxsetupwin_pingwin_servicewin_updateswin_groupwin_usermodule_args: (string, default=\"\")forks: (integer, default=0)verbosity: (choice)0: 0 (Normal) (default)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (string, default=\"\")become_enabled: (boolean, default=False)diff_mode: (boolean, default=False)Make a GET request to this resource to retrieve a list of all\nhosts directly or indirectly belonging to this\ngroup.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of hosts\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more host records.
Each host data structure includes the following fields:
\nid: Database ID for this host. (integer)type: Data type for this host. (choice)url: URL for this host. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this host was created. (datetime)modified: Timestamp when this host was last modified. (datetime)name: Name of this host. (string)description: Optional description of this host. (string)inventory: (id)enabled: Is this host online and available for running jobs? (boolean)instance_id: The value used by the remote inventory source to uniquely identify the host (string)variables: Host variables in JSON or YAML format. (json)has_active_failures: (field)has_inventory_sources: (field)last_job: (id)last_job_host_summary: (id)insights_system_id: Red Hat Insights host unique identifier. (string)ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)To specify that hosts are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\ngroups associated with the selected\ngroup.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more group records.
Each group data structure includes the following fields:
\nid: Database ID for this group. (integer)type: Data type for this group. (choice)url: URL for this group. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this group was created. (datetime)modified: Timestamp when this group was last modified. (datetime)name: Name of this group. (string)description: Optional description of this group. (string)inventory: (id)variables: Group variables in JSON or YAML format. (json)To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following group\nfields to create a new group associated with this\ngroup.
\nname: Name of this group. (string, required)description: Optional description of this group. (string, default=\"\")inventory: (id, required)variables: Group variables in JSON or YAML format. (json, default=``)Make a POST request to this resource with only an id field to associate an\nexisting group with this group.
Make a POST request to this resource with id and disassociate fields to\nremove the group from this group\n without deleting the group.
Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ngroup.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of hosts\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more host records.
Each host data structure includes the following fields:
\nid: Database ID for this host. (integer)type: Data type for this host. (choice)url: URL for this host. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this host was created. (datetime)modified: Timestamp when this host was last modified. (datetime)name: Name of this host. (string)description: Optional description of this host. (string)inventory: (id)enabled: Is this host online and available for running jobs? (boolean)instance_id: The value used by the remote inventory source to uniquely identify the host (string)variables: Host variables in JSON or YAML format. (json)has_active_failures: (field)has_inventory_sources: (field)last_job: (id)last_job_host_summary: (id)insights_system_id: Red Hat Insights host unique identifier. (string)ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)To specify that hosts are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following host\nfields to create a new host associated with this\ngroup.
\nname: Name of this host. (string, required)description: Optional description of this host. (string, default=\"\")inventory: (id, required)enabled: Is this host online and available for running jobs? (boolean, default=True)instance_id: The value used by the remote inventory source to uniquely identify the host (string, default=\"\")variables: Host variables in JSON or YAML format. (json, default=``)Make a POST request to this resource with only an id field to associate an\nexisting host with this group.
Make a POST request to this resource with id and disassociate fields to\nremove the host from this group\n without deleting the host.
Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\ngroup.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of inventory sources\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more inventory source records.
Each inventory source data structure includes the following fields:
\nid: Database ID for this inventory source. (integer)type: Data type for this inventory source. (choice)url: URL for this inventory source. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory source was created. (datetime)modified: Timestamp when this inventory source was last modified. (datetime)name: Name of this inventory source. (string)description: Optional description of this inventory source. (string)source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string)source_script: (id)source_vars: Inventory source variables in YAML or JSON format. (string)credential: Cloud credential to use for inventory updates. (integer)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string)host_filter: Regex where only matching hosts will be imported into Tower. (string)overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)overwrite_vars: Overwrite local variables from remote inventory source. (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)verbosity: (choice)0: 0 (WARNING)1: 1 (INFO)2: 2 (DEBUG)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatednone: No External Sourceinventory: (id)update_on_launch: (boolean)update_cache_timeout: (integer)source_project: Project containing inventory file used as source. (id)update_on_project_update: (boolean)last_update_failed: (boolean)last_updated: (datetime)To specify that inventory sources are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\njob events associated with the selected\ngroup.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of job events\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job event records.
Each job event data structure includes the following fields:
\nid: Database ID for this job event. (integer)type: Data type for this job event. (choice)url: URL for this job event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job event was created. (datetime)modified: Timestamp when this job event was last modified. (datetime)job: (id)event: (choice)runner_on_failed: Host Failedrunner_on_start: Host Startedrunner_on_ok: Host OKrunner_on_error: Host Failurerunner_on_skipped: Host Skippedrunner_on_unreachable: Host Unreachablerunner_on_no_hosts: No Hosts Remainingrunner_on_async_poll: Host Pollingrunner_on_async_ok: Host Async OKrunner_on_async_failed: Host Async Failurerunner_item_on_ok: Item OKrunner_item_on_failed: Item Failedrunner_item_on_skipped: Item Skippedrunner_retry: Host Retryrunner_on_file_diff: File Differenceplaybook_on_start: Playbook Startedplaybook_on_notify: Running Handlersplaybook_on_include: Including Fileplaybook_on_no_hosts_matched: No Hosts Matchedplaybook_on_no_hosts_remaining: No Hosts Remainingplaybook_on_task_start: Task Startedplaybook_on_vars_prompt: Variables Promptedplaybook_on_setup: Gathering Factsplaybook_on_import_for_host: internal: on Import for Hostplaybook_on_not_import_for_host: internal: on Not Import for Hostplaybook_on_play_start: Play Startedplaybook_on_stats: Playbook Completedebug: Debugverbose: Verbosedeprecated: Deprecatedwarning: Warningsystem_warning: System Warningerror: Errorcounter: (integer)event_display: (string)event_data: (json)event_level: (integer)failed: (boolean)changed: (boolean)uuid: (string)parent_uuid: (string)host: (id)host_name: (string)playbook: (string)play: (string)task: (string)role: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)To specify that job events are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\njob host summaries associated with the selected\ngroup.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of job host summaries\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job host summary records.
Each job host summary data structure includes the following fields:
\nid: Database ID for this job host summary. (integer)type: Data type for this job host summary. (choice)url: URL for this job host summary. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job host summary was created. (datetime)modified: Timestamp when this job host summary was last modified. (datetime)job: (id)host: (id)host_name: (string)changed: (integer)dark: (integer)failures: (integer)ok: (integer)processed: (integer)skipped: (integer)failed: (boolean)ignored: (integer)rescued: (integer)To specify that job host summaries are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\ngroups available to be added as children of the\ncurrent group.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more group records.
Each group data structure includes the following fields:
\nid: Database ID for this group. (integer)type: Data type for this group. (choice)url: URL for this group. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this group was created. (datetime)modified: Timestamp when this group was last modified. (datetime)name: Name of this group. (string)description: Optional description of this group. (string)inventory: (id)variables: Group variables in JSON or YAML format. (json)To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve all variables defined for a\ngroup.
", "operationId":"Groups_groups_variable_data_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":" Retrieve Group Variable Data", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-variable_data--get", "x-filename-id":"api-v2-groups-id-variable_data-get" }, "patch":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update variables defined for a\ngroup.
", "operationId":"Groups_groups_variable_data_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "variables":{ "description":"Group variables in JSON or YAML format.", "type":"string" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update Group Variable Data", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-variable_data--patch", "x-filename-id":"api-v2-groups-id-variable_data-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update variables defined for a\ngroup.
", "operationId":"Groups_groups_variable_data_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "variables":{ "description":"Group variables in JSON or YAML format.", "type":"string" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update Group Variable Data", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-variable_data--put", "x-filename-id":"api-v2-groups-id-variable_data-put" } }, "/api/v2/hosts/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nhosts.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of hosts\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more host records.
Each host data structure includes the following fields:
\nid: Database ID for this host. (integer)type: Data type for this host. (choice)url: URL for this host. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this host was created. (datetime)modified: Timestamp when this host was last modified. (datetime)name: Name of this host. (string)description: Optional description of this host. (string)inventory: (id)enabled: Is this host online and available for running jobs? (boolean)instance_id: The value used by the remote inventory source to uniquely identify the host (string)variables: Host variables in JSON or YAML format. (json)has_active_failures: (field)has_inventory_sources: (field)last_job: (id)last_job_host_summary: (id)insights_system_id: Red Hat Insights host unique identifier. (string)ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)To specify that hosts are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\n?host_filter=name=my_host\n?host_filter=name=\"my host\" or name=my_host\n?host_filter=groups__name=\"my group\"\n?host_filter=name=my_host and groups__name=\"my group\"\n?host_filter=name=my_host and groups__name=\"my group\"\n?host_filter=(name=my_host and groups__name=\"my group\") or (name=my_host2 and groups__name=my_group2)\nhost_filter can also be used to query JSON data in the related ansible_facts. __ may be used to traverse JSON dictionaries. [] may be used to traverse JSON arrays.
?host_filter=ansible_facts__ansible_processor_vcpus=8\n?host_filter=ansible_facts__ansible_processor_vcpus=8 and name=\"my_host\" and ansible_facts__ansible_lo__ipv6[]__scope=host\nMake a DELETE request to this resource to delete this host.
", "operationId":"Hosts_hosts_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Delete a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}--delete", "x-filename-id":"api-v2-hosts-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single host\nrecord containing the following fields:
\nid: Database ID for this host. (integer)type: Data type for this host. (choice)url: URL for this host. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this host was created. (datetime)modified: Timestamp when this host was last modified. (datetime)name: Name of this host. (string)description: Optional description of this host. (string)inventory: (id)enabled: Is this host online and available for running jobs? (boolean)instance_id: The value used by the remote inventory source to uniquely identify the host (string)variables: Host variables in JSON or YAML format. (json)has_active_failures: (field)has_inventory_sources: (field)last_job: (id)last_job_host_summary: (id)insights_system_id: Red Hat Insights host unique identifier. (string)ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)Make a PUT or PATCH request to this resource to update this\nhost. The following fields may be modified:
\nname: Name of this host. (string, required)description: Optional description of this host. (string, default=\"\")inventory: (id, required)enabled: Is this host online and available for running jobs? (boolean, default=True)instance_id: The value used by the remote inventory source to uniquely identify the host (string, default=\"\")variables: Host variables in JSON or YAML format. (json, default=``)For a PATCH request, include only the fields that are being modified.
", "operationId":"Hosts_hosts_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "enabled":{ "description":"Is this host online and available for running jobs?", "type":"boolean" }, "instance_id":{ "description":"The value used by the remote inventory source to uniquely identify the host", "type":"string" }, "inventory":{ "description":"", "type":"integer" }, "name":{ "description":"", "type":"string" }, "variables":{ "description":"Host variables in JSON or YAML format.", "type":"string" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}--patch", "x-filename-id":"api-v2-hosts-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\nhost. The following fields may be modified:
\nname: Name of this host. (string, required)description: Optional description of this host. (string, default=\"\")inventory: (id, required)enabled: Is this host online and available for running jobs? (boolean, default=True)instance_id: The value used by the remote inventory source to uniquely identify the host (string, default=\"\")variables: Host variables in JSON or YAML format. (json, default=``)For a PUT request, include all fields in the request.
", "operationId":"Hosts_hosts_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "description":"Hello world", "name":"New name" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "ansible_facts_modified":null, "created":"2018-02-01T08:00:00.000000Z", "description":"Hello world", "enabled":true, "has_active_failures":false, "has_inventory_sources":false, "id":1, "insights_system_id":null, "instance_id":"", "inventory":1, "last_job":null, "last_job_host_summary":null, "modified":"2018-02-01T08:00:00.000000Z", "name":"New name", "related":{ "activity_stream":"/api/v2/hosts/1/activity_stream/", "ad_hoc_command_events":"/api/v2/hosts/1/ad_hoc_command_events/", "ad_hoc_commands":"/api/v2/hosts/1/ad_hoc_commands/", "all_groups":"/api/v2/hosts/1/all_groups/", "ansible_facts":"/api/v2/hosts/1/ansible_facts/", "groups":"/api/v2/hosts/1/groups/", "insights":"/api/v2/hosts/1/insights/", "inventory":"/api/v2/inventories/1/", "inventory_sources":"/api/v2/hosts/1/inventory_sources/", "job_events":"/api/v2/hosts/1/job_events/", "job_host_summaries":"/api/v2/hosts/1/job_host_summaries/", "smart_inventories":"/api/v2/hosts/1/smart_inventories/", "variable_data":"/api/v2/hosts/1/variable_data/" }, "summary_fields":{ "groups":{ "count":1, "results":[ { "id":1, "name":"single-group" } ] }, "inventory":{ "description":"", "has_active_failures":false, "has_inventory_sources":false, "hosts_with_active_failures":0, "id":1, "inventory_sources_with_failures":0, "kind":"", "name":"test-inv", "organization_id":1, "total_groups":0, "total_hosts":0, "total_inventory_sources":0 }, "recent_jobs":[ ], "user_capabilities":{ "delete":true, "edit":true } }, "type":"host", "url":"/api/v2/hosts/1/", "variables":"" } } }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Update a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}--put", "x-filename-id":"api-v2-hosts-id-put" } }, "/api/v2/hosts/{id}/activity_stream/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nhost.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nad hoc command events associated with the selected\nhost.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of ad hoc command events\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more ad hoc command event records.
Each ad hoc command event data structure includes the following fields:
\nid: Database ID for this ad hoc command event. (integer)type: Data type for this ad hoc command event. (choice)url: URL for this ad hoc command event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this ad hoc command event was created. (datetime)modified: Timestamp when this ad hoc command event was last modified. (datetime)ad_hoc_command: (id)event: (choice)runner_on_failed: Host Failedrunner_on_ok: Host OKrunner_on_unreachable: Host Unreachablerunner_on_skipped: Host Skippeddebug: Debugverbose: Verbosedeprecated: Deprecatedwarning: Warningsystem_warning: System Warningerror: Errorcounter: (integer)event_display: (string)event_data: (json)failed: (boolean)changed: (boolean)uuid: (string)host: (id)host_name: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)To specify that ad hoc command events are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\nhost.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of ad hoc commands\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more ad hoc command records.
Each ad hoc command data structure includes the following fields:
\nid: Database ID for this ad hoc command. (integer)type: Data type for this ad hoc command. (choice)url: URL for this ad hoc command. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this ad hoc command was created. (datetime)modified: Timestamp when this ad hoc command was last modified. (datetime)name: Name of this ad hoc command. (string)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)controller_node: The instance that managed the isolated execution environment. (string)job_type: (choice)run: Runcheck: Checkinventory: (id)limit: (string)credential: (id)module_name: (choice)commandshellyumaptapt_keyapt_repositoryapt_rpmservicegroupusermountpingselinuxsetupwin_pingwin_servicewin_updateswin_groupwin_usermodule_args: (string)forks: (integer)verbosity: (choice)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (string)become_enabled: (boolean)diff_mode: (boolean)To specify that ad hoc commands are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following ad hoc command\nfields to create a new ad hoc command associated with this\nhost.
\njob_type: (choice)run: Run (default)check: Checkinventory: (id, default=``)limit: (string, default=\"\")credential: (id, default=``)module_name: (choice)command (default)shellyumaptapt_keyapt_repositoryapt_rpmservicegroupusermountpingselinuxsetupwin_pingwin_servicewin_updateswin_groupwin_usermodule_args: (string, default=\"\")forks: (integer, default=0)verbosity: (choice)0: 0 (Normal) (default)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (string, default=\"\")become_enabled: (boolean, default=False)diff_mode: (boolean, default=False)Make a GET request to this resource to retrieve a list of all\ngroups of which the selected\nhost is directly or indirectly a member.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more group records.
Each group data structure includes the following fields:
\nid: Database ID for this group. (integer)type: Data type for this group. (choice)url: URL for this group. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this group was created. (datetime)modified: Timestamp when this group was last modified. (datetime)name: Name of this group. (string)description: Optional description of this group. (string)inventory: (id)variables: Group variables in JSON or YAML format. (json)To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single host\nrecord containing the following fields:
\nid: Database ID for this host. (integer)type: Data type for this host. (choice)url: URL for this host. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this host was created. (datetime)modified: Timestamp when this host was last modified. (datetime)name: Name of this host. (string)description: Optional description of this host. (string)Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\nhost.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more group records.
Each group data structure includes the following fields:
\nid: Database ID for this group. (integer)type: Data type for this group. (choice)url: URL for this group. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this group was created. (datetime)modified: Timestamp when this group was last modified. (datetime)name: Name of this group. (string)description: Optional description of this group. (string)inventory: (id)variables: Group variables in JSON or YAML format. (json)To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following group\nfields to create a new group associated with this\nhost.
\nname: Name of this group. (string, required)description: Optional description of this group. (string, default=\"\")inventory: (id, required)variables: Group variables in JSON or YAML format. (json, default=``)Make a POST request to this resource with only an id field to associate an\nexisting group with this host.
Make a POST request to this resource with id and disassociate fields to\nremove the group from this host\n without deleting the group.
Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\nhost.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of inventory sources\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more inventory source records.
Each inventory source data structure includes the following fields:
\nid: Database ID for this inventory source. (integer)type: Data type for this inventory source. (choice)url: URL for this inventory source. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory source was created. (datetime)modified: Timestamp when this inventory source was last modified. (datetime)name: Name of this inventory source. (string)description: Optional description of this inventory source. (string)source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string)source_script: (id)source_vars: Inventory source variables in YAML or JSON format. (string)credential: Cloud credential to use for inventory updates. (integer)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string)host_filter: Regex where only matching hosts will be imported into Tower. (string)overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)overwrite_vars: Overwrite local variables from remote inventory source. (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)verbosity: (choice)0: 0 (WARNING)1: 1 (INFO)2: 2 (DEBUG)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatednone: No External Sourceinventory: (id)update_on_launch: (boolean)update_cache_timeout: (integer)source_project: Project containing inventory file used as source. (id)update_on_project_update: (boolean)last_update_failed: (boolean)last_updated: (datetime)To specify that inventory sources are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\njob events associated with the selected\nhost.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of job events\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job event records.
Each job event data structure includes the following fields:
\nid: Database ID for this job event. (integer)type: Data type for this job event. (choice)url: URL for this job event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job event was created. (datetime)modified: Timestamp when this job event was last modified. (datetime)job: (id)event: (choice)runner_on_failed: Host Failedrunner_on_start: Host Startedrunner_on_ok: Host OKrunner_on_error: Host Failurerunner_on_skipped: Host Skippedrunner_on_unreachable: Host Unreachablerunner_on_no_hosts: No Hosts Remainingrunner_on_async_poll: Host Pollingrunner_on_async_ok: Host Async OKrunner_on_async_failed: Host Async Failurerunner_item_on_ok: Item OKrunner_item_on_failed: Item Failedrunner_item_on_skipped: Item Skippedrunner_retry: Host Retryrunner_on_file_diff: File Differenceplaybook_on_start: Playbook Startedplaybook_on_notify: Running Handlersplaybook_on_include: Including Fileplaybook_on_no_hosts_matched: No Hosts Matchedplaybook_on_no_hosts_remaining: No Hosts Remainingplaybook_on_task_start: Task Startedplaybook_on_vars_prompt: Variables Promptedplaybook_on_setup: Gathering Factsplaybook_on_import_for_host: internal: on Import for Hostplaybook_on_not_import_for_host: internal: on Not Import for Hostplaybook_on_play_start: Play Startedplaybook_on_stats: Playbook Completedebug: Debugverbose: Verbosedeprecated: Deprecatedwarning: Warningsystem_warning: System Warningerror: Errorcounter: (integer)event_display: (string)event_data: (json)event_level: (integer)failed: (boolean)changed: (boolean)uuid: (string)parent_uuid: (string)host: (id)host_name: (string)playbook: (string)play: (string)task: (string)role: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)To specify that job events are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\njob host summaries associated with the selected\nhost.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of job host summaries\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job host summary records.
Each job host summary data structure includes the following fields:
\nid: Database ID for this job host summary. (integer)type: Data type for this job host summary. (choice)url: URL for this job host summary. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job host summary was created. (datetime)modified: Timestamp when this job host summary was last modified. (datetime)job: (id)host: (id)host_name: (string)changed: (integer)dark: (integer)failures: (integer)ok: (integer)processed: (integer)skipped: (integer)failed: (boolean)ignored: (integer)rescued: (integer)To specify that job host summaries are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\ninventories associated with the selected\nhost.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of inventories\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more inventory records.
Each inventory data structure includes the following fields:
\nid: Database ID for this inventory. (integer)type: Data type for this inventory. (choice)url: URL for this inventory. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory was created. (datetime)modified: Timestamp when this inventory was last modified. (datetime)name: Name of this inventory. (string)description: Optional description of this inventory. (string)organization: Organization containing this inventory. (id)kind: Kind of inventory being represented. (choice)\"\": Hosts have a direct link to this inventory.smart: Hosts for inventory generated using the host_filter property.host_filter: Filter that will be applied to the hosts of this inventory. (string)variables: Inventory variables in JSON or YAML format. (json)has_active_failures: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)hosts_with_active_failures: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)has_inventory_sources: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)insights_credential: Credentials to be used by hosts belonging to this inventory when accessing Red Hat Insights API. (id)pending_deletion: Flag indicating the inventory is being deleted. (boolean)To specify that inventories are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve all variables defined for a\nhost.
", "operationId":"Hosts_hosts_variable_data_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":" Retrieve Host Variable Data", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-variable_data--get", "x-filename-id":"api-v2-hosts-id-variable_data-get" }, "patch":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update variables defined for a\nhost.
", "operationId":"Hosts_hosts_variable_data_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "variables":{ "description":"Host variables in JSON or YAML format.", "type":"string" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update Host Variable Data", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-variable_data--patch", "x-filename-id":"api-v2-hosts-id-variable_data-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update variables defined for a\nhost.
", "operationId":"Hosts_hosts_variable_data_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "variables":{ "description":"Host variables in JSON or YAML format.", "type":"string" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update Host Variable Data", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-variable_data--put", "x-filename-id":"api-v2-hosts-id-variable_data-put" } }, "/api/v2/instance_groups/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\ninstance groups.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of instance groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more instance group records.
Each instance group data structure includes the following fields:
\nid: Database ID for this instance group. (integer)type: Data type for this instance group. (choice)url: URL for this instance group. (string)related: Data structure with URLs of related resources. (object)name: Name of this instance group. (string)created: Timestamp when this instance group was created. (datetime)modified: Timestamp when this instance group was last modified. (datetime)capacity: (field)committed_capacity: (field)consumed_capacity: (field)percent_capacity_remaining: (field)jobs_running: Count of jobs in the running or waiting state that are targeted for this instance group (integer)jobs_total: Count of all jobs that target this instance group (integer)instances: (field)controller: Instance Group to remotely control this group. (id)is_controller: Indicates whether instance group controls any other group (boolean)is_isolated: Indicates whether instances in this group are isolated.Isolated groups have a designated controller group. (boolean)is_containerized: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)credential: (id)policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)policy_instance_list: List of exact-match Instances that will be assigned to this group (json)pod_spec_override: (string)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following instance group\nfields to create a new instance group:
\nname: Name of this instance group. (string, required)
credential: (id, default=``)
policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)pod_spec_override: (string, default=\"\")Make a DELETE request to this resource to delete this instance group.
", "operationId":"Instance Groups_instance_groups_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"Isolated Groups can not be removed from the API" } }, "description":"" }, "409":{ "examples":{ "application/json":{ "active_jobs":[ { "id":1, "type":"job" }, { "id":2, "type":"job" }, { "id":3, "type":"project_update" }, { "id":4, "type":"project_update" } ], "error":"Resource is being used by running jobs." } }, "description":"" } }, "summary":" Delete an Instance Group", "tags":[ "Instance Groups" ], "x-internal-id":"api-v2-instance_groups-{id}--delete", "x-filename-id":"api-v2-instance_groups-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single instance group\nrecord containing the following fields:
\nid: Database ID for this instance group. (integer)type: Data type for this instance group. (choice)url: URL for this instance group. (string)related: Data structure with URLs of related resources. (object)name: Name of this instance group. (string)created: Timestamp when this instance group was created. (datetime)modified: Timestamp when this instance group was last modified. (datetime)capacity: (field)committed_capacity: (field)consumed_capacity: (field)percent_capacity_remaining: (field)jobs_running: Count of jobs in the running or waiting state that are targeted for this instance group (integer)jobs_total: Count of all jobs that target this instance group (integer)instances: (field)controller: Instance Group to remotely control this group. (id)is_controller: Indicates whether instance group controls any other group (boolean)is_isolated: Indicates whether instances in this group are isolated.Isolated groups have a designated controller group. (boolean)is_containerized: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)credential: (id)policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)policy_instance_list: List of exact-match Instances that will be assigned to this group (json)pod_spec_override: (string)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)Make a PUT or PATCH request to this resource to update this\ninstance group. The following fields may be modified:
\nname: Name of this instance group. (string, required)
credential: (id, default=``)
policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)pod_spec_override: (string, default=\"\")For a PATCH request, include only the fields that are being modified.
", "operationId":"Instance Groups_instance_groups_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "name":"foobar" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "capacity":0, "committed_capacity":0, "consumed_capacity":0, "controller":null, "created":"2018-02-01T08:00:00.000000Z", "credential":null, "id":2, "instances":0, "is_containerized":false, "is_controller":false, "is_isolated":false, "jobs_running":0, "jobs_total":0, "modified":"2018-02-01T08:00:00.000000Z", "name":"foobar", "percent_capacity_remaining":0, "pod_spec_override":"", "policy_instance_list":[ ], "policy_instance_minimum":0, "policy_instance_percentage":0, "related":{ "instances":"/api/v2/instance_groups/2/instances/", "jobs":"/api/v2/instance_groups/2/jobs/" }, "summary_fields":{ "user_capabilities":{ "delete":true, "edit":true } }, "type":"instance_group", "url":"/api/v2/instance_groups/2/" } } }, "400":{ "examples":{ "application/json":{ "policy_instance_list":[ "Containerized instances may not be managed via the API" ] } }, "description":"" } }, "summary":" Update an Instance Group", "tags":[ "Instance Groups" ], "x-internal-id":"api-v2-instance_groups-{id}--patch", "x-filename-id":"api-v2-instance_groups-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\ninstance group. The following fields may be modified:
\nname: Name of this instance group. (string, required)
credential: (id, default=``)
policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)pod_spec_override: (string, default=\"\")For a PUT request, include all fields in the request.
", "operationId":"Instance Groups_instance_groups_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "credential":{ "description":"", "type":"integer" }, "name":{ "description":"", "type":"string" }, "pod_spec_override":{ "description":"", "type":"string" }, "policy_instance_list":{ "description":"List of exact-match Instances that will be assigned to this group", "items":{ "type":"string" }, "type":"array" }, "policy_instance_minimum":{ "description":"Static minimum number of Instances that will be automatically assign to this group when new instances come online.", "type":"integer" }, "policy_instance_percentage":{ "description":"Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.", "type":"integer" } }, "required":[ "name" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update an Instance Group", "tags":[ "Instance Groups" ], "x-internal-id":"api-v2-instance_groups-{id}--put", "x-filename-id":"api-v2-instance_groups-id-put" } }, "/api/v2/instance_groups/{id}/instances/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\ninstances associated with the selected\ninstance group.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of instances\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more instance records.
Each instance data structure includes the following fields:
\nid: Database ID for this instance. (integer)type: Data type for this instance. (choice)url: URL for this instance. (string)related: Data structure with URLs of related resources. (object)uuid: (string)hostname: (string)created: Timestamp when this instance was created. (datetime)modified: Timestamp when this instance was last modified. (datetime)capacity_adjustment: (decimal)version: (string)capacity: (integer)consumed_capacity: (field)percent_capacity_remaining: (field)jobs_running: Count of jobs in the running or waiting state that are targeted for this instance (integer)jobs_total: Count of all jobs that target this instance (integer)cpu: (integer)memory: (integer)cpu_capacity: (integer)mem_capacity: (integer)enabled: (boolean)managed_by_policy: (boolean)To specify that instances are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following instance\nfields to create a new instance associated with this\ninstance group.
\ncapacity_adjustment: (decimal, default=1)
enabled: (boolean, default=True)
managed_by_policy: (boolean, default=True)Make a POST request to this resource with only an id field to associate an\nexisting instance with this instance group.
Make a POST request to this resource with id and disassociate fields to\nremove the instance from this instance group\n without deleting the instance.
Make a GET request to this resource to retrieve a list of\nunified jobs associated with the selected\ninstance group.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of unified jobs\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more unified job records.
Each unified job data structure includes the following fields:
\nid: Database ID for this unified job. (integer)type: Data type for this unified job. (choice)url: URL for this unified job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this unified job was created. (datetime)modified: Timestamp when this unified job was last modified. (datetime)name: Name of this unified job. (string)description: Optional description of this unified job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)controller_node: The instance that managed the isolated execution environment. (string)To specify that unified jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\ninstances.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of instances\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more instance records.
Each instance data structure includes the following fields:
\nid: Database ID for this instance. (integer)type: Data type for this instance. (choice)url: URL for this instance. (string)related: Data structure with URLs of related resources. (object)uuid: (string)hostname: (string)created: Timestamp when this instance was created. (datetime)modified: Timestamp when this instance was last modified. (datetime)capacity_adjustment: (decimal)version: (string)capacity: (integer)consumed_capacity: (field)percent_capacity_remaining: (field)jobs_running: Count of jobs in the running or waiting state that are targeted for this instance (integer)jobs_total: Count of all jobs that target this instance (integer)cpu: (integer)memory: (integer)cpu_capacity: (integer)mem_capacity: (integer)enabled: (boolean)managed_by_policy: (boolean)To specify that instances are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single instance\nrecord containing the following fields:
\nid: Database ID for this instance. (integer)type: Data type for this instance. (choice)url: URL for this instance. (string)related: Data structure with URLs of related resources. (object)uuid: (string)hostname: (string)created: Timestamp when this instance was created. (datetime)modified: Timestamp when this instance was last modified. (datetime)capacity_adjustment: (decimal)version: (string)capacity: (integer)consumed_capacity: (field)percent_capacity_remaining: (field)jobs_running: Count of jobs in the running or waiting state that are targeted for this instance (integer)jobs_total: Count of all jobs that target this instance (integer)cpu: (integer)memory: (integer)cpu_capacity: (integer)mem_capacity: (integer)enabled: (boolean)managed_by_policy: (boolean)Make a PUT or PATCH request to this resource to update this\ninstance. The following fields may be modified:
\ncapacity_adjustment: (decimal, default=1)
enabled: (boolean, default=True)
managed_by_policy: (boolean, default=True)For a PATCH request, include only the fields that are being modified.
", "operationId":"Instances_instances_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "capacity_adjustment":{ "description":"", "type":"number" }, "enabled":{ "description":"", "type":"boolean" }, "managed_by_policy":{ "description":"", "type":"boolean" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update an Instance", "tags":[ "Instances" ], "x-internal-id":"api-v2-instances-{id}--patch", "x-filename-id":"api-v2-instances-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\ninstance. The following fields may be modified:
\ncapacity_adjustment: (decimal, default=1)
enabled: (boolean, default=True)
managed_by_policy: (boolean, default=True)For a PUT request, include all fields in the request.
", "operationId":"Instances_instances_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "capacity_adjustment":{ "description":"", "type":"number" }, "enabled":{ "description":"", "type":"boolean" }, "managed_by_policy":{ "description":"", "type":"boolean" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update an Instance", "tags":[ "Instances" ], "x-internal-id":"api-v2-instances-{id}--put", "x-filename-id":"api-v2-instances-id-put" } }, "/api/v2/instances/{id}/instance_groups/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\ninstance.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of instance groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more instance group records.
Each instance group data structure includes the following fields:
\nid: Database ID for this instance group. (integer)type: Data type for this instance group. (choice)url: URL for this instance group. (string)related: Data structure with URLs of related resources. (object)name: Name of this instance group. (string)created: Timestamp when this instance group was created. (datetime)modified: Timestamp when this instance group was last modified. (datetime)capacity: (field)committed_capacity: (field)consumed_capacity: (field)percent_capacity_remaining: (field)jobs_running: Count of jobs in the running or waiting state that are targeted for this instance group (integer)jobs_total: Count of all jobs that target this instance group (integer)instances: (field)controller: Instance Group to remotely control this group. (id)is_controller: Indicates whether instance group controls any other group (boolean)is_isolated: Indicates whether instances in this group are isolated.Isolated groups have a designated controller group. (boolean)is_containerized: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)credential: (id)policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)policy_instance_list: List of exact-match Instances that will be assigned to this group (json)pod_spec_override: (string)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following instance group\nfields to create a new instance group associated with this\ninstance.
\nname: Name of this instance group. (string, required)
credential: (id, default=``)
policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)pod_spec_override: (string, default=\"\")Make a POST request to this resource with only an id field to associate an\nexisting instance group with this instance.
Make a POST request to this resource with id and disassociate fields to\nremove the instance group from this instance\n without deleting the instance group.
Make a GET request to this resource to retrieve a list of\nunified jobs associated with the selected\ninstance.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of unified jobs\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more unified job records.
Each unified job data structure includes the following fields:
\nid: Database ID for this unified job. (integer)type: Data type for this unified job. (choice)url: URL for this unified job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this unified job was created. (datetime)modified: Timestamp when this unified job was last modified. (datetime)name: Name of this unified job. (string)description: Optional description of this unified job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)controller_node: The instance that managed the isolated execution environment. (string)To specify that unified jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\ninventories.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of inventories\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more inventory records.
Each inventory data structure includes the following fields:
\nid: Database ID for this inventory. (integer)type: Data type for this inventory. (choice)url: URL for this inventory. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory was created. (datetime)modified: Timestamp when this inventory was last modified. (datetime)name: Name of this inventory. (string)description: Optional description of this inventory. (string)organization: Organization containing this inventory. (id)kind: Kind of inventory being represented. (choice)\"\": Hosts have a direct link to this inventory.smart: Hosts for inventory generated using the host_filter property.host_filter: Filter that will be applied to the hosts of this inventory. (string)variables: Inventory variables in JSON or YAML format. (json)has_active_failures: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)hosts_with_active_failures: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)has_inventory_sources: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)insights_credential: Credentials to be used by hosts belonging to this inventory when accessing Red Hat Insights API. (id)pending_deletion: Flag indicating the inventory is being deleted. (boolean)To specify that inventories are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following inventory\nfields to create a new inventory:
\nname: Name of this inventory. (string, required)description: Optional description of this inventory. (string, default=\"\")organization: Organization containing this inventory. (id, required)kind: Kind of inventory being represented. (choice)\"\": Hosts have a direct link to this inventory. (default)smart: Hosts for inventory generated using the host_filter property.host_filter: Filter that will be applied to the hosts of this inventory. (string, default=\"\")variables: Inventory variables in JSON or YAML format. (json, default=``)
insights_credential: Credentials to be used by hosts belonging to this inventory when accessing Red Hat Insights API. (id, default=``)
Make a DELETE request to this resource to delete this inventory.
", "operationId":"Inventories_inventories_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "400":{ "examples":{ "application/json":{ "error":"Inventory is already pending deletion." } }, "description":"" } }, "summary":" Delete an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}--delete", "x-filename-id":"api-v2-inventories-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:
\nid: Database ID for this inventory. (integer)type: Data type for this inventory. (choice)url: URL for this inventory. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory was created. (datetime)modified: Timestamp when this inventory was last modified. (datetime)name: Name of this inventory. (string)description: Optional description of this inventory. (string)organization: Organization containing this inventory. (id)kind: Kind of inventory being represented. (choice)\"\": Hosts have a direct link to this inventory.smart: Hosts for inventory generated using the host_filter property.host_filter: Filter that will be applied to the hosts of this inventory. (string)variables: Inventory variables in JSON or YAML format. (json)has_active_failures: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)hosts_with_active_failures: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)has_inventory_sources: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)insights_credential: Credentials to be used by hosts belonging to this inventory when accessing Red Hat Insights API. (id)pending_deletion: Flag indicating the inventory is being deleted. (boolean)Make a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:
\nname: Name of this inventory. (string, required)description: Optional description of this inventory. (string, default=\"\")organization: Organization containing this inventory. (id, required)kind: Kind of inventory being represented. (choice)\"\": Hosts have a direct link to this inventory. (default)smart: Hosts for inventory generated using the host_filter property.host_filter: Filter that will be applied to the hosts of this inventory. (string, default=\"\")variables: Inventory variables in JSON or YAML format. (json, default=``)
insights_credential: Credentials to be used by hosts belonging to this inventory when accessing Red Hat Insights API. (id, default=``)
For a PATCH request, include only the fields that are being modified.
", "operationId":"Inventories_inventories_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "insights_credential":1 } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "created":"2018-02-01T08:00:00.000000Z", "description":"", "has_active_failures":false, "has_inventory_sources":false, "host_filter":null, "hosts_with_active_failures":0, "id":1, "insights_credential":1, "inventory_sources_with_failures":0, "kind":"", "modified":"2018-02-01T08:00:00.000000Z", "name":"test-inv", "organization":1, "pending_deletion":false, "related":{ "access_list":"/api/v2/inventories/1/access_list/", "activity_stream":"/api/v2/inventories/1/activity_stream/", "ad_hoc_commands":"/api/v2/inventories/1/ad_hoc_commands/", "copy":"/api/v2/inventories/1/copy/", "groups":"/api/v2/inventories/1/groups/", "hosts":"/api/v2/inventories/1/hosts/", "insights_credential":"/api/v2/credentials/1/", "instance_groups":"/api/v2/inventories/1/instance_groups/", "inventory_sources":"/api/v2/inventories/1/inventory_sources/", "job_templates":"/api/v2/inventories/1/job_templates/", "object_roles":"/api/v2/inventories/1/object_roles/", "organization":"/api/v2/organizations/1/", "root_groups":"/api/v2/inventories/1/root_groups/", "script":"/api/v2/inventories/1/script/", "tree":"/api/v2/inventories/1/tree/", "update_inventory_sources":"/api/v2/inventories/1/update_inventory_sources/", "variable_data":"/api/v2/inventories/1/variable_data/" }, "summary_fields":{ "insights_credential":{ "description":"", "id":1, "name":"insights-cred" }, "object_roles":{ "adhoc_role":{ "description":"May run ad hoc commands on the inventory", "id":17, "name":"Ad Hoc" }, "admin_role":{ "description":"Can manage all aspects of the inventory", "id":15, "name":"Admin" }, "read_role":{ "description":"May view settings for the inventory", "id":19, "name":"Read" }, "update_role":{ "description":"May update the inventory", "id":16, "name":"Update" }, "use_role":{ "description":"Can use the inventory in a job template", "id":18, "name":"Use" } }, "organization":{ "description":"test-org-desc", "id":1, "name":"test-org" }, "user_capabilities":{ "adhoc":true, "copy":true, "delete":true, "edit":true } }, "total_groups":0, "total_hosts":0, "total_inventory_sources":0, "type":"inventory", "url":"/api/v2/inventories/1/", "variables":"" } } }, "400":{ "examples":{ "application/json":{ "insights_credential":[ "Credential kind must be 'insights'." ] } }, "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Update an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}--patch", "x-filename-id":"api-v2-inventories-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:
\nname: Name of this inventory. (string, required)description: Optional description of this inventory. (string, default=\"\")organization: Organization containing this inventory. (id, required)kind: Kind of inventory being represented. (choice)\"\": Hosts have a direct link to this inventory. (default)smart: Hosts for inventory generated using the host_filter property.host_filter: Filter that will be applied to the hosts of this inventory. (string, default=\"\")variables: Inventory variables in JSON or YAML format. (json, default=``)
insights_credential: Credentials to be used by hosts belonging to this inventory when accessing Red Hat Insights API. (id, default=``)
For a PUT request, include all fields in the request.
", "operationId":"Inventories_inventories_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "description":"Hello world", "name":"New name", "organization":1 } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "created":"2018-02-01T08:00:00.000000Z", "description":"Hello world", "has_active_failures":false, "has_inventory_sources":false, "host_filter":null, "hosts_with_active_failures":0, "id":1, "insights_credential":null, "inventory_sources_with_failures":0, "kind":"", "modified":"2018-02-01T08:00:00.000000Z", "name":"New name", "organization":1, "pending_deletion":false, "related":{ "access_list":"/api/v2/inventories/1/access_list/", "activity_stream":"/api/v2/inventories/1/activity_stream/", "ad_hoc_commands":"/api/v2/inventories/1/ad_hoc_commands/", "copy":"/api/v2/inventories/1/copy/", "groups":"/api/v2/inventories/1/groups/", "hosts":"/api/v2/inventories/1/hosts/", "instance_groups":"/api/v2/inventories/1/instance_groups/", "inventory_sources":"/api/v2/inventories/1/inventory_sources/", "job_templates":"/api/v2/inventories/1/job_templates/", "object_roles":"/api/v2/inventories/1/object_roles/", "organization":"/api/v2/organizations/1/", "root_groups":"/api/v2/inventories/1/root_groups/", "script":"/api/v2/inventories/1/script/", "tree":"/api/v2/inventories/1/tree/", "update_inventory_sources":"/api/v2/inventories/1/update_inventory_sources/", "variable_data":"/api/v2/inventories/1/variable_data/" }, "summary_fields":{ "object_roles":{ "adhoc_role":{ "description":"May run ad hoc commands on the inventory", "id":17, "name":"Ad Hoc" }, "admin_role":{ "description":"Can manage all aspects of the inventory", "id":15, "name":"Admin" }, "read_role":{ "description":"May view settings for the inventory", "id":19, "name":"Read" }, "update_role":{ "description":"May update the inventory", "id":16, "name":"Update" }, "use_role":{ "description":"Can use the inventory in a job template", "id":18, "name":"Use" } }, "organization":{ "description":"test-org-desc", "id":1, "name":"test-org" }, "user_capabilities":{ "adhoc":true, "copy":false, "delete":true, "edit":true } }, "total_groups":0, "total_hosts":0, "total_inventory_sources":0, "type":"inventory", "url":"/api/v2/inventories/1/", "variables":"" } } }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Update an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}--put", "x-filename-id":"api-v2-inventories-id-put" } }, "/api/v2/inventories/{id}/access_list/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nusers.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ninventory.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\ninventory.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of ad hoc commands\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more ad hoc command records.
Each ad hoc command data structure includes the following fields:
\nid: Database ID for this ad hoc command. (integer)type: Data type for this ad hoc command. (choice)url: URL for this ad hoc command. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this ad hoc command was created. (datetime)modified: Timestamp when this ad hoc command was last modified. (datetime)name: Name of this ad hoc command. (string)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)controller_node: The instance that managed the isolated execution environment. (string)job_type: (choice)run: Runcheck: Checkinventory: (id)limit: (string)credential: (id)module_name: (choice)commandshellyumaptapt_keyapt_repositoryapt_rpmservicegroupusermountpingselinuxsetupwin_pingwin_servicewin_updateswin_groupwin_usermodule_args: (string)forks: (integer)verbosity: (choice)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (string)become_enabled: (boolean)diff_mode: (boolean)To specify that ad hoc commands are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following ad hoc command\nfields to create a new ad hoc command associated with this\ninventory.
\njob_type: (choice)
run: Run (default)check: Checklimit: (string, default=\"\")
credential: (id, default=``)module_name: (choice)command (default)shellyumaptapt_keyapt_repositoryapt_rpmservicegroupusermountpingselinuxsetupwin_pingwin_servicewin_updateswin_groupwin_usermodule_args: (string, default=\"\")forks: (integer, default=0)verbosity: (choice)0: 0 (Normal) (default)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (string, default=\"\")become_enabled: (boolean, default=False)diff_mode: (boolean, default=False)Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ninventory.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more group records.
Each group data structure includes the following fields:
\nid: Database ID for this group. (integer)type: Data type for this group. (choice)url: URL for this group. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this group was created. (datetime)modified: Timestamp when this group was last modified. (datetime)name: Name of this group. (string)description: Optional description of this group. (string)inventory: (id)variables: Group variables in JSON or YAML format. (json)To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following group\nfields to create a new group associated with this\ninventory.
\nname: Name of this group. (string, required)description: Optional description of this group. (string, default=\"\")
variables: Group variables in JSON or YAML format. (json, default=``)
Make a POST request to this resource with id and disassociate fields to\ndelete the associated group.
{\n \"id\": 123,\n \"disassociate\": true\n}\nMake a GET request to this resource to retrieve a list of\nhosts associated with the selected\ninventory.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of hosts\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more host records.
Each host data structure includes the following fields:
\nid: Database ID for this host. (integer)type: Data type for this host. (choice)url: URL for this host. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this host was created. (datetime)modified: Timestamp when this host was last modified. (datetime)name: Name of this host. (string)description: Optional description of this host. (string)inventory: (id)enabled: Is this host online and available for running jobs? (boolean)instance_id: The value used by the remote inventory source to uniquely identify the host (string)variables: Host variables in JSON or YAML format. (json)has_active_failures: (field)has_inventory_sources: (field)last_job: (id)last_job_host_summary: (id)insights_system_id: Red Hat Insights host unique identifier. (string)ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)To specify that hosts are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following host\nfields to create a new host associated with this\ninventory.
\nname: Name of this host. (string, required)description: Optional description of this host. (string, default=\"\")
enabled: Is this host online and available for running jobs? (boolean, default=True)
instance_id: The value used by the remote inventory source to uniquely identify the host (string, default=\"\")variables: Host variables in JSON or YAML format. (json, default=``)Make a POST request to this resource with id and disassociate fields to\ndelete the associated host.
{\n \"id\": 123,\n \"disassociate\": true\n}\nMake a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\ninventory.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of instance groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more instance group records.
Each instance group data structure includes the following fields:
\nid: Database ID for this instance group. (integer)type: Data type for this instance group. (choice)url: URL for this instance group. (string)related: Data structure with URLs of related resources. (object)name: Name of this instance group. (string)created: Timestamp when this instance group was created. (datetime)modified: Timestamp when this instance group was last modified. (datetime)capacity: (field)committed_capacity: (field)consumed_capacity: (field)percent_capacity_remaining: (field)jobs_running: Count of jobs in the running or waiting state that are targeted for this instance group (integer)jobs_total: Count of all jobs that target this instance group (integer)instances: (field)controller: Instance Group to remotely control this group. (id)is_controller: Indicates whether instance group controls any other group (boolean)is_isolated: Indicates whether instances in this group are isolated.Isolated groups have a designated controller group. (boolean)is_containerized: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)credential: (id)policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)policy_instance_list: List of exact-match Instances that will be assigned to this group (json)pod_spec_override: (string)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following instance group\nfields to create a new instance group associated with this\ninventory.
\nname: Name of this instance group. (string, required)
credential: (id, default=``)
policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)pod_spec_override: (string, default=\"\")Make a POST request to this resource with only an id field to associate an\nexisting instance group with this inventory.
Make a POST request to this resource with id and disassociate fields to\nremove the instance group from this inventory\n without deleting the instance group.
Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\ninventory.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of inventory sources\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more inventory source records.
Each inventory source data structure includes the following fields:
\nid: Database ID for this inventory source. (integer)type: Data type for this inventory source. (choice)url: URL for this inventory source. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory source was created. (datetime)modified: Timestamp when this inventory source was last modified. (datetime)name: Name of this inventory source. (string)description: Optional description of this inventory source. (string)source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string)source_script: (id)source_vars: Inventory source variables in YAML or JSON format. (string)credential: Cloud credential to use for inventory updates. (integer)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string)host_filter: Regex where only matching hosts will be imported into Tower. (string)overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)overwrite_vars: Overwrite local variables from remote inventory source. (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)verbosity: (choice)0: 0 (WARNING)1: 1 (INFO)2: 2 (DEBUG)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatednone: No External Sourceinventory: (id)update_on_launch: (boolean)update_cache_timeout: (integer)source_project: Project containing inventory file used as source. (id)update_on_project_update: (boolean)last_update_failed: (boolean)last_updated: (datetime)To specify that inventory sources are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following inventory source\nfields to create a new inventory source associated with this\ninventory.
\nname: Name of this inventory source. (string, required)description: Optional description of this inventory source. (string, default=\"\")source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string, default=\"\")source_script: (id, default=``)source_vars: Inventory source variables in YAML or JSON format. (string, default=\"\")credential: Cloud credential to use for inventory updates. (integer, default=None)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string, default=\"\")enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string, default=\"\")host_filter: Regex where only matching hosts will be imported into Tower. (string, default=\"\")overwrite: Overwrite local groups and hosts from remote inventory source. (boolean, default=False)overwrite_vars: Overwrite local variables from remote inventory source. (boolean, default=False)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)verbosity: (choice)
0: 0 (WARNING)1: 1 (INFO) (default)2: 2 (DEBUG)update_on_launch: (boolean, default=False)
update_cache_timeout: (integer, default=0)source_project: Project containing inventory file used as source. (id, default=``)update_on_project_update: (boolean, default=False)Make a GET request to this resource to retrieve a list of\njob templates associated with the selected\ninventory.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of job templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job template records.
Each job template data structure includes the following fields:
\nid: Database ID for this job template. (integer)type: Data type for this job template. (choice)url: URL for this job template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job template was created. (datetime)modified: Timestamp when this job template was last modified. (datetime)name: Name of this job template. (string)description: Optional description of this job template. (string)job_type: (choice)run: Runcheck: Checkinventory: (id)project: (id)playbook: (string)scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)forks: (integer)limit: (string)verbosity: (choice)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (json)job_tags: (string)force_handlers: (boolean)skip_tags: (string)start_at_task: (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)use_fact_cache: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)organization: The organization used to determine access to this template. (id)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedhost_config_key: (string)ask_scm_branch_on_launch: (boolean)ask_diff_mode_on_launch: (boolean)ask_variables_on_launch: (boolean)ask_limit_on_launch: (boolean)ask_tags_on_launch: (boolean)ask_skip_tags_on_launch: (boolean)ask_job_type_on_launch: (boolean)ask_verbosity_on_launch: (boolean)ask_inventory_on_launch: (boolean)ask_credential_on_launch: (boolean)survey_enabled: (boolean)become_enabled: (boolean)diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)allow_simultaneous: (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)job_slice_count: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)To specify that job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\ninventory.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of root (top-level)\ngroups associated with this\ninventory.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more group records.
Each group data structure includes the following fields:
\nid: Database ID for this group. (integer)type: Data type for this group. (choice)url: URL for this group. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this group was created. (datetime)modified: Timestamp when this group was last modified. (datetime)name: Name of this group. (string)description: Optional description of this group. (string)inventory: (id)variables: Group variables in JSON or YAML format. (json)To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nRefer to Dynamic Inventory\nfor more information on inventory scripts.
\nMake a GET request to this resource without query parameters to retrieve a JSON\nobject containing groups, including the hosts, children and variables for each\ngroup. The response data is equivalent to that returned by passing the\n--list argument to an inventory script.
Specify a query string of ?hostvars=1 to retrieve the JSON\nobject above including all host variables. The ['_meta']['hostvars'] object\nin the response contains an entry for each host with its variables. This\nresponse format can be used with Ansible 1.3 and later to avoid making a\nseparate API request for each host. Refer to\nTuning the External Inventory Script\nfor more information on this feature.
By default, the inventory script will only return hosts that\nare enabled in the inventory. This feature allows disabled hosts to be skipped\nwhen running jobs without removing them from the inventory. Specify a query\nstring of ?all=1 to return all hosts, including disabled ones.
Specify a query string of ?towervars=1 to add variables\nto the hostvars of each host that specifies its enabled state and database ID.
Specify a query string of ?subset=slice2of5 to produce an inventory that\nhas a restricted number of hosts according to the rules of job slicing.
To apply multiple query strings, join them with the & character, like ?hostvars=1&all=1.
Make a GET request to this resource with a query string similar to\n?host=HOSTNAME to retrieve a JSON object containing host variables for the\nspecified host. The response data is equivalent to that returned by passing\nthe --host HOSTNAME argument to an inventory script.
Make a GET request to this resource to retrieve a hierarchical view of groups\nassociated with the selected inventory.
\nThe resulting data structure contains a list of root groups, with each group\nalso containing a list of its children.
\nEach group data structure includes the following fields:
\nid: Database ID for this group. (integer)type: Data type for this group. (choice)url: URL for this group. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this group was created. (datetime)modified: Timestamp when this group was last modified. (datetime)name: Name of this group. (string)description: Optional description of this group. (string)inventory: (id)variables: Group variables in JSON or YAML format. (json)children: (field)Make a GET request to this resource to determine if any of the inventory sources for\nthis inventory can be updated. The response will include the following fields for each\ninventory source:
\ninventory_source: ID of the inventory_source\n (integer, read-only)can_update: Flag indicating if this inventory source can be updated\n (boolean, read-only)Make a POST request to this resource to update the inventory sources. The response\nstatus code will be a 202. The response will contain the follow fields for each of the individual\ninventory sources:
\nstatus: started or message why the update could not be started.\n (string, read-only)inventory_update: ID of the inventory update job that was started.\n (integer, read-only)project_update: ID of the project update job that was started if this inventory source is an SCM source.\n (interger, read-only, optional)Make a GET request to this resource to determine if any of the inventory sources for\nthis inventory can be updated. The response will include the following fields for each\ninventory source:
\ninventory_source: ID of the inventory_source\n (integer, read-only)can_update: Flag indicating if this inventory source can be updated\n (boolean, read-only)Make a POST request to this resource to update the inventory sources. The response\nstatus code will be a 202. The response will contain the follow fields for each of the individual\ninventory sources:
\nstatus: started or message why the update could not be started.\n (string, read-only)inventory_update: ID of the inventory update job that was started.\n (integer, read-only)project_update: ID of the project update job that was started if this inventory source is an SCM source.\n (interger, read-only, optional)Make a GET request to this resource to retrieve all variables defined for a\ninventory.
", "operationId":"Inventories_inventories_variable_data_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ } } } }, "summary":" Retrieve Inventory Variable Data", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-variable_data--get", "x-filename-id":"api-v2-inventories-id-variable_data-get" }, "patch":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update variables defined for a\ninventory.
", "operationId":"Inventories_inventories_variable_data_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "host_filter":"bar" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "host_filter":"bar" } } }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Update Inventory Variable Data", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-variable_data--patch", "x-filename-id":"api-v2-inventories-id-variable_data-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update variables defined for a\ninventory.
", "operationId":"Inventories_inventories_variable_data_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "fooooo":"bar" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "fooooo":"bar" } } }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Update Inventory Variable Data", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-variable_data--put", "x-filename-id":"api-v2-inventories-id-variable_data-put" } }, "/api/v2/inventory_scripts/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\ncustom inventory scripts.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of custom inventory scripts\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more custom inventory script records.
Each custom inventory script data structure includes the following fields:
\nid: Database ID for this custom inventory script. (integer)type: Data type for this custom inventory script. (choice)url: URL for this custom inventory script. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this custom inventory script was created. (datetime)modified: Timestamp when this custom inventory script was last modified. (datetime)name: Name of this custom inventory script. (string)description: Optional description of this custom inventory script. (string)script: (string)organization: Organization owning this inventory script (id)To specify that custom inventory scripts are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following custom inventory script\nfields to create a new custom inventory script:
\nname: Name of this custom inventory script. (string, required)description: Optional description of this custom inventory script. (string, default=\"\")script: (string, required)organization: Organization owning this inventory script (id, required)Make a DELETE request to this resource to delete this custom inventory script.
", "operationId":"Custom Inventory Scripts_inventory_scripts_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete a Custom Inventory Script", "tags":[ "Custom Inventory Scripts" ], "x-internal-id":"api-v2-inventory_scripts-{id}--delete", "x-filename-id":"api-v2-inventory_scripts-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single custom inventory script\nrecord containing the following fields:
\nid: Database ID for this custom inventory script. (integer)type: Data type for this custom inventory script. (choice)url: URL for this custom inventory script. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this custom inventory script was created. (datetime)modified: Timestamp when this custom inventory script was last modified. (datetime)name: Name of this custom inventory script. (string)description: Optional description of this custom inventory script. (string)script: (string)organization: Organization owning this inventory script (id)Make a PUT or PATCH request to this resource to update this\ncustom inventory script. The following fields may be modified:
\nname: Name of this custom inventory script. (string, required)description: Optional description of this custom inventory script. (string, default=\"\")script: (string, required)organization: Organization owning this inventory script (id, required)For a PATCH request, include only the fields that are being modified.
", "operationId":"Custom Inventory Scripts_inventory_scripts_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "name":{ "description":"", "type":"string" }, "organization":{ "description":"Organization owning this inventory script", "type":"integer" }, "script":{ "description":"", "type":"string" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Custom Inventory Script", "tags":[ "Custom Inventory Scripts" ], "x-internal-id":"api-v2-inventory_scripts-{id}--patch", "x-filename-id":"api-v2-inventory_scripts-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\ncustom inventory script. The following fields may be modified:
\nname: Name of this custom inventory script. (string, required)description: Optional description of this custom inventory script. (string, default=\"\")script: (string, required)organization: Organization owning this inventory script (id, required)For a PUT request, include all fields in the request.
", "operationId":"Custom Inventory Scripts_inventory_scripts_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "name":{ "description":"", "type":"string" }, "organization":{ "description":"Organization owning this inventory script", "type":"integer" }, "script":{ "description":"", "type":"string" } }, "required":[ "name", "script", "organization" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Custom Inventory Script", "tags":[ "Custom Inventory Scripts" ], "x-internal-id":"api-v2-inventory_scripts-{id}--put", "x-filename-id":"api-v2-inventory_scripts-id-put" } }, "/api/v2/inventory_scripts/{id}/copy/":{ "get":{ "deprecated":true, "operationId":"Custom Inventory Scripts_inventory_scripts_copy_list", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A page number within the paginated result set.", "in":"query", "name":"page", "required":false, "type":"integer" }, { "description":"Number of results to return per page.", "in":"query", "name":"page_size", "required":false, "type":"integer" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "tags":[ "Custom Inventory Scripts" ], "summary":"Inventory Scripts Copy List", "x-internal-id":"api-v2-inventory_scripts-{id}-copy--get", "x-filename-id":"api-v2-inventory_scripts-id-copy-get" }, "post":{ "consumes":[ "application/json" ], "deprecated":true, "operationId":"Custom Inventory Scripts_inventory_scripts_copy_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "name":{ "description":"", "type":"string" } }, "required":[ "name" ], "type":"object" } } ], "responses":{ "201":{ "description":"" } }, "tags":[ "Custom Inventory Scripts" ], "summary":"Inventory Scripts Copy Create", "x-internal-id":"api-v2-inventory_scripts-{id}-copy--post", "x-filename-id":"api-v2-inventory_scripts-id-copy-post" } }, "/api/v2/inventory_scripts/{id}/object_roles/":{ "get":{ "deprecated":true, "description":"Make a GET request to this resource to retrieve a list of\nroles associated with the selected\ncustom inventory script.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\ninventory sources.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of inventory sources\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more inventory source records.
Each inventory source data structure includes the following fields:
\nid: Database ID for this inventory source. (integer)type: Data type for this inventory source. (choice)url: URL for this inventory source. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory source was created. (datetime)modified: Timestamp when this inventory source was last modified. (datetime)name: Name of this inventory source. (string)description: Optional description of this inventory source. (string)source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string)source_script: (id)source_vars: Inventory source variables in YAML or JSON format. (string)credential: Cloud credential to use for inventory updates. (integer)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string)host_filter: Regex where only matching hosts will be imported into Tower. (string)overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)overwrite_vars: Overwrite local variables from remote inventory source. (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)verbosity: (choice)0: 0 (WARNING)1: 1 (INFO)2: 2 (DEBUG)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatednone: No External Sourceinventory: (id)update_on_launch: (boolean)update_cache_timeout: (integer)source_project: Project containing inventory file used as source. (id)update_on_project_update: (boolean)last_update_failed: (boolean)last_updated: (datetime)To specify that inventory sources are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following inventory source\nfields to create a new inventory source:
\nname: Name of this inventory source. (string, required)description: Optional description of this inventory source. (string, default=\"\")source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string, default=\"\")source_script: (id, default=``)source_vars: Inventory source variables in YAML or JSON format. (string, default=\"\")credential: Cloud credential to use for inventory updates. (integer, default=None)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string, default=\"\")enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string, default=\"\")host_filter: Regex where only matching hosts will be imported into Tower. (string, default=\"\")overwrite: Overwrite local groups and hosts from remote inventory source. (boolean, default=False)overwrite_vars: Overwrite local variables from remote inventory source. (boolean, default=False)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)verbosity: (choice)
0: 0 (WARNING)1: 1 (INFO) (default)2: 2 (DEBUG)inventory: (id, required)
update_on_launch: (boolean, default=False)update_cache_timeout: (integer, default=0)source_project: Project containing inventory file used as source. (id, default=``)update_on_project_update: (boolean, default=False)Make a DELETE request to this resource to delete this inventory source.
", "operationId":"Inventory Sources_inventory_sources_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}--delete", "x-filename-id":"api-v2-inventory_sources-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single inventory source\nrecord containing the following fields:
\nid: Database ID for this inventory source. (integer)type: Data type for this inventory source. (choice)url: URL for this inventory source. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory source was created. (datetime)modified: Timestamp when this inventory source was last modified. (datetime)name: Name of this inventory source. (string)description: Optional description of this inventory source. (string)source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string)source_script: (id)source_vars: Inventory source variables in YAML or JSON format. (string)credential: Cloud credential to use for inventory updates. (integer)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string)host_filter: Regex where only matching hosts will be imported into Tower. (string)overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)overwrite_vars: Overwrite local variables from remote inventory source. (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)verbosity: (choice)0: 0 (WARNING)1: 1 (INFO)2: 2 (DEBUG)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatednone: No External Sourceinventory: (id)update_on_launch: (boolean)update_cache_timeout: (integer)source_project: Project containing inventory file used as source. (id)update_on_project_update: (boolean)last_update_failed: (boolean)last_updated: (datetime)Make a PUT or PATCH request to this resource to update this\ninventory source. The following fields may be modified:
\nname: Name of this inventory source. (string, required)description: Optional description of this inventory source. (string, default=\"\")source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string, default=\"\")source_script: (id, default=``)source_vars: Inventory source variables in YAML or JSON format. (string, default=\"\")credential: Cloud credential to use for inventory updates. (integer, default=None)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string, default=\"\")enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string, default=\"\")host_filter: Regex where only matching hosts will be imported into Tower. (string, default=\"\")overwrite: Overwrite local groups and hosts from remote inventory source. (boolean, default=False)overwrite_vars: Overwrite local variables from remote inventory source. (boolean, default=False)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)verbosity: (choice)
0: 0 (WARNING)1: 1 (INFO) (default)2: 2 (DEBUG)inventory: (id, required)
update_on_launch: (boolean, default=False)update_cache_timeout: (integer, default=0)source_project: Project containing inventory file used as source. (id, default=``)update_on_project_update: (boolean, default=False)For a PATCH request, include only the fields that are being modified.
", "operationId":"Inventory Sources_inventory_sources_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "credential":2 } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "created":"2018-02-01T08:00:00.000000Z", "credential":2, "custom_virtualenv":null, "description":"", "enabled_value":"", "enabled_var":"", "host_filter":"", "id":2, "inventory":1, "last_job_failed":false, "last_job_run":null, "last_update_failed":false, "last_updated":null, "modified":"2018-02-01T08:00:00.000000Z", "name":"fobar", "next_job_run":null, "overwrite":false, "overwrite_vars":false, "related":{ "activity_stream":"/api/v2/inventory_sources/2/activity_stream/", "credential":"/api/v2/credentials/2/", "credentials":"/api/v2/inventory_sources/2/credentials/", "groups":"/api/v2/inventory_sources/2/groups/", "hosts":"/api/v2/inventory_sources/2/hosts/", "inventory":"/api/v2/inventories/1/", "inventory_updates":"/api/v2/inventory_sources/2/inventory_updates/", "notification_templates_error":"/api/v2/inventory_sources/2/notification_templates_error/", "notification_templates_started":"/api/v2/inventory_sources/2/notification_templates_started/", "notification_templates_success":"/api/v2/inventory_sources/2/notification_templates_success/", "schedules":"/api/v2/inventory_sources/2/schedules/", "source_project":"/api/v2/projects/1/", "update":"/api/v2/inventory_sources/2/update/" }, "source":"scm", "source_path":"", "source_project":1, "source_script":null, "source_vars":"plugin: a.b.c", "status":"never updated", "summary_fields":{ "credential":{ "cloud":true, "credential_type_id":2, "description":"", "id":2, "kind":"aws", "name":"bar2" }, "credentials":[ { "cloud":true, "credential_type_id":2, "description":"", "id":2, "kind":"aws", "name":"bar2" } ], "inventory":{ "description":"", "has_active_failures":false, "has_inventory_sources":true, "hosts_with_active_failures":0, "id":1, "inventory_sources_with_failures":0, "kind":"", "name":"test-inv", "organization_id":1, "total_groups":0, "total_hosts":0, "total_inventory_sources":1 }, "organization":{ "description":"test-org-desc", "id":1, "name":"test-org" }, "source_project":{ "description":"test-proj-desc", "id":1, "name":"test-proj", "scm_type":"git", "status":"never updated" }, "user_capabilities":{ "delete":true, "edit":true, "schedule":true, "start":true } }, "timeout":0, "type":"inventory_source", "update_cache_timeout":0, "update_on_launch":false, "update_on_project_update":false, "url":"/api/v2/inventory_sources/2/", "verbosity":1 } } }, "400":{ "examples":{ "application/json":{ "update_on_project_update":[ "More than one SCM-based inventory source with update on project update per-inventory not allowed." ] } }, "description":"" } }, "summary":" Update an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}--patch", "x-filename-id":"api-v2-inventory_sources-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\ninventory source. The following fields may be modified:
\nname: Name of this inventory source. (string, required)description: Optional description of this inventory source. (string, default=\"\")source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string, default=\"\")source_script: (id, default=``)source_vars: Inventory source variables in YAML or JSON format. (string, default=\"\")credential: Cloud credential to use for inventory updates. (integer, default=None)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string, default=\"\")enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string, default=\"\")host_filter: Regex where only matching hosts will be imported into Tower. (string, default=\"\")overwrite: Overwrite local groups and hosts from remote inventory source. (boolean, default=False)overwrite_vars: Overwrite local variables from remote inventory source. (boolean, default=False)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)verbosity: (choice)
0: 0 (WARNING)1: 1 (INFO) (default)2: 2 (DEBUG)inventory: (id, required)
update_on_launch: (boolean, default=False)update_cache_timeout: (integer, default=0)source_project: Project containing inventory file used as source. (id, default=``)update_on_project_update: (boolean, default=False)For a PUT request, include all fields in the request.
", "operationId":"Inventory Sources_inventory_sources_update_0", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "credential":{ "description":"Cloud credential to use for inventory updates.", "type":"integer" }, "custom_virtualenv":{ "description":"Local absolute file path containing a custom Python virtualenv to use", "type":"string" }, "description":{ "description":"", "type":"string" }, "enabled_value":{ "description":"Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var=\"status.power_state\"and enabled_value=\"powered_on\" with host variables:{ \"status\": { \"power_state\": \"powered_on\", \"created\": \"2018-02-01T08:00:00.000000Z:00\", \"healthy\": true }, \"name\": \"foobar\", \"ip_address\": \"192.168.2.1\"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled", "type":"string" }, "enabled_var":{ "description":"Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as \"foo.bar\", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get(\"foo\", {}).get(\"bar\", default)", "type":"string" }, "host_filter":{ "description":"Regex where only matching hosts will be imported into Tower.", "type":"string" }, "inventory":{ "description":"", "type":"integer" }, "name":{ "description":"", "type":"string" }, "overwrite":{ "description":"Overwrite local groups and hosts from remote inventory source.", "type":"boolean" }, "overwrite_vars":{ "description":"Overwrite local variables from remote inventory source.", "type":"boolean" }, "source":{ "description":"", "type":"string" }, "source_path":{ "description":"", "type":"string" }, "source_project":{ "description":"Project containing inventory file used as source.", "type":"string" }, "source_script":{ "description":"", "type":"integer" }, "source_vars":{ "description":"Inventory source variables in YAML or JSON format.", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) to run before the task is canceled.", "type":"integer" }, "update_cache_timeout":{ "description":"", "type":"integer" }, "update_on_launch":{ "description":"", "type":"boolean" }, "update_on_project_update":{ "description":"", "type":"boolean" }, "verbosity":{ "description":"", "type":"string" } }, "required":[ "name", "inventory" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}--put", "x-filename-id":"api-v2-inventory_sources-id-put" } }, "/api/v2/inventory_sources/{id}/activity_stream/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ninventory source.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ninventory source.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: (id)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential\nfields to create a new credential associated with this\ninventory source.
\nname: Name of this credential. (string, required)description: Optional description of this credential. (string, default=\"\")organization: (id, default=None)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)
inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
Make a POST request to this resource with only an id field to associate an\nexisting credential with this inventory source.
Make a POST request to this resource with id and disassociate fields to\nremove the credential from this inventory source\n without deleting the credential.
Make a POST request to this resource with the following group\nfields to create a new group associated with this\ninventory source.
\nname: Name of this group. (string, required)description: Optional description of this group. (string, default=\"\")inventory: (id, required)variables: Group variables in JSON or YAML format. (json, default=``)Make a DELETE request to this resource to delete all groups show in the list.\nThe Inventory Source will not be deleted by this request.
", "operationId":"Inventory Sources_inventory_sources_groups_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Create a Group for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-groups--delete", "x-filename-id":"api-v2-inventory_sources-id-groups-delete" }, "get":{ "description":"Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ninventory source.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more group records.
Each group data structure includes the following fields:
\nid: Database ID for this group. (integer)type: Data type for this group. (choice)url: URL for this group. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this group was created. (datetime)modified: Timestamp when this group was last modified. (datetime)name: Name of this group. (string)description: Optional description of this group. (string)inventory: (id)variables: Group variables in JSON or YAML format. (json)To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following host\nfields to create a new host associated with this\ninventory source.
\nname: Name of this host. (string, required)description: Optional description of this host. (string, default=\"\")inventory: (id, required)enabled: Is this host online and available for running jobs? (boolean, default=True)instance_id: The value used by the remote inventory source to uniquely identify the host (string, default=\"\")variables: Host variables in JSON or YAML format. (json, default=``)Make a DELETE request to this resource to delete all hosts show in the list.\nThe Inventory Source will not be deleted by this request.
", "operationId":"Inventory Sources_inventory_sources_hosts_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Create a Host for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-hosts--delete", "x-filename-id":"api-v2-inventory_sources-id-hosts-delete" }, "get":{ "description":"Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ninventory source.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of hosts\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more host records.
Each host data structure includes the following fields:
\nid: Database ID for this host. (integer)type: Data type for this host. (choice)url: URL for this host. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this host was created. (datetime)modified: Timestamp when this host was last modified. (datetime)name: Name of this host. (string)description: Optional description of this host. (string)inventory: (id)enabled: Is this host online and available for running jobs? (boolean)instance_id: The value used by the remote inventory source to uniquely identify the host (string)variables: Host variables in JSON or YAML format. (json)has_active_failures: (field)has_inventory_sources: (field)last_job: (id)last_job_host_summary: (id)insights_system_id: Red Hat Insights host unique identifier. (string)ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)To specify that hosts are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\ninventory updates associated with the selected\ninventory source.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of inventory updates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more inventory update records.
Each inventory update data structure includes the following fields:
\nid: Database ID for this inventory update. (integer)type: Data type for this inventory update. (choice)url: URL for this inventory update. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory update was created. (datetime)modified: Timestamp when this inventory update was last modified. (datetime)name: Name of this inventory update. (string)description: Optional description of this inventory update. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string)source_script: (id)source_vars: Inventory source variables in YAML or JSON format. (string)credential: Cloud credential to use for inventory updates. (integer)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string)host_filter: Regex where only matching hosts will be imported into Tower. (string)overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)overwrite_vars: Overwrite local variables from remote inventory source. (boolean)custom_virtualenv: (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)verbosity: (choice)0: 0 (WARNING)1: 1 (INFO)2: 2 (DEBUG)inventory: (id)inventory_source: (id)license_error: (boolean)org_host_limit_error: (boolean)source_project_update: Inventory files from this Project Update were used for the inventory update. (id)To specify that inventory updates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\ninventory source.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this inventory source.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this inventory source\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\ninventory source.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this inventory source.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this inventory source\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\ninventory source.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this inventory source.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this inventory source\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\ninventory source.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of schedules\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more schedule records.
Each schedule data structure includes the following fields:
\nrrule: A value representing the schedules iCal recurrence rule. (string)id: Database ID for this schedule. (integer)type: Data type for this schedule. (choice)url: URL for this schedule. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this schedule was created. (datetime)modified: Timestamp when this schedule was last modified. (datetime)name: Name of this schedule. (string)description: Optional description of this schedule. (string)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)unified_job_template: (id)enabled: Enables processing of this schedule. (boolean)dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)next_run: The next time that the scheduled action will run. (datetime)timezone: (field)until: (field)To specify that schedules are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following schedule\nfields to create a new schedule associated with this\ninventory source.
\nrrule: A value representing the schedules iCal recurrence rule. (string, required)
name: Name of this schedule. (string, required)
description: Optional description of this schedule. (string, default=\"\")extra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)
None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)enabled: Enables processing of this schedule. (boolean, default=True)
POST requests to this resource must include a proper rrule value following\na particular format and conforming to subset of allowed rules.
The following lists the expected format and details of our rrules:
\nHere are some example rrules:
\n\"DTSTART:20500331T055000Z RRULE:FREQ=MINUTELY;INTERVAL=10;COUNT=5\"\n\"DTSTART:20240331T075000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MINUTELY;INTERVAL=1;UNTIL=20230401T075000Z\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=5;BYDAY=MO\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=6\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=4;BYDAY=SU\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR,SA,SU\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=4;BYMONTHDAY=1\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYSETPOS=-1;BYMONTH=8;BYDAY=SU\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;UNTIL=20230401T075000Z;BYDAY=MO,WE,FR\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=HOURLY;INTERVAL=1;UNTIL=20230610T075000Z\"\nMake a GET request to this resource to determine if the group can be updated\nfrom its inventory source. The response will include the following field:
\ncan_update: Flag indicating if this inventory source can be updated\n (boolean, read-only)Make a POST request to this resource to update the inventory source. If\nsuccessful, the response status code will be 202. If the inventory source is\nnot defined or cannot be updated, a 405 status code will be returned.
", "operationId":"Inventory Sources_inventory_sources_update_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":" Update Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-update--get", "x-filename-id":"api-v2-inventory_sources-id-update-get" }, "post":{ "description":"Make a GET request to this resource to determine if the group can be updated\nfrom its inventory source. The response will include the following field:
\ncan_update: Flag indicating if this inventory source can be updated\n (boolean, read-only)Make a POST request to this resource to update the inventory source. If\nsuccessful, the response status code will be 202. If the inventory source is\nnot defined or cannot be updated, a 405 status code will be returned.
", "operationId":"Inventory Sources_inventory_sources_update_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "201":{ "description":"" }, "202":{ "examples":{ "application/json":{ "canceled_on":null, "created":"2018-02-01T08:00:00.000000Z", "credential":null, "custom_virtualenv":null, "description":"", "elapsed":0, "enabled_value":"", "enabled_var":"", "event_processing_finished":false, "execution_node":"", "failed":false, "finished":null, "host_filter":"", "id":1, "inventory":1, "inventory_source":1, "inventory_update":1, "job_args":"", "job_cwd":"", "job_env":{ }, "job_explanation":"", "launch_type":"manual", "license_error":false, "modified":"2018-02-01T08:00:00.000000Z", "name":"test-inv - single-inv-src", "org_host_limit_error":false, "overwrite":false, "overwrite_vars":false, "related":{ "cancel":"/api/v2/inventory_updates/1/cancel/", "credentials":"/api/v2/inventory_updates/1/credentials/", "events":"/api/v2/inventory_updates/1/events/", "inventory":"/api/v2/inventories/1/", "inventory_source":"/api/v2/inventory_sources/1/", "notifications":"/api/v2/inventory_updates/1/notifications/", "stdout":"/api/v2/inventory_updates/1/stdout/", "unified_job_template":"/api/v2/inventory_sources/1/" }, "result_traceback":"", "source":"ec2", "source_path":"", "source_project":null, "source_project_update":null, "source_script":null, "source_vars":"", "started":null, "status":"pending", "summary_fields":{ "credentials":[ ], "inventory":{ "description":"", "has_active_failures":false, "has_inventory_sources":true, "hosts_with_active_failures":0, "id":1, "inventory_sources_with_failures":0, "kind":"", "name":"test-inv", "organization_id":1, "total_groups":0, "total_hosts":0, "total_inventory_sources":1 }, "inventory_source":{ "source":"ec2", "status":"pending" }, "organization":{ "description":"test-org-desc", "id":1, "name":"test-org" }, "unified_job_template":{ "description":"", "id":1, "name":"single-inv-src", "unified_job_type":"inventory_update" }, "user_capabilities":{ "delete":false, "start":false } }, "timeout":0, "type":"inventory_update", "unified_job_template":1, "url":"/api/v2/inventory_updates/1/", "verbosity":1 } }, "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Update Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-update--post", "x-filename-id":"api-v2-inventory_sources-id-update-post" } }, "/api/v2/inventory_updates/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\ninventory updates.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of inventory updates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more inventory update records.
Each inventory update data structure includes the following fields:
\nid: Database ID for this inventory update. (integer)type: Data type for this inventory update. (choice)url: URL for this inventory update. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory update was created. (datetime)modified: Timestamp when this inventory update was last modified. (datetime)name: Name of this inventory update. (string)description: Optional description of this inventory update. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string)source_script: (id)source_vars: Inventory source variables in YAML or JSON format. (string)credential: Cloud credential to use for inventory updates. (integer)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string)host_filter: Regex where only matching hosts will be imported into Tower. (string)overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)overwrite_vars: Overwrite local variables from remote inventory source. (boolean)custom_virtualenv: (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)verbosity: (choice)0: 0 (WARNING)1: 1 (INFO)2: 2 (DEBUG)inventory: (id)inventory_source: (id)license_error: (boolean)org_host_limit_error: (boolean)source_project_update: Inventory files from this Project Update were used for the inventory update. (id)To specify that inventory updates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a DELETE request to this resource to delete this inventory update.
", "operationId":"Inventory Updates_inventory_updates_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"Cannot delete running job resource." } }, "description":"" } }, "summary":" Delete an Inventory Update", "tags":[ "Inventory Updates" ], "x-internal-id":"api-v2-inventory_updates-{id}--delete", "x-filename-id":"api-v2-inventory_updates-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:
\nid: Database ID for this inventory update. (integer)type: Data type for this inventory update. (choice)url: URL for this inventory update. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory update was created. (datetime)modified: Timestamp when this inventory update was last modified. (datetime)name: Name of this inventory update. (string)description: Optional description of this inventory update. (string)source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string)source_script: (id)source_vars: Inventory source variables in YAML or JSON format. (string)credential: Cloud credential to use for inventory updates. (integer)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string)host_filter: Regex where only matching hosts will be imported into Tower. (string)overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)overwrite_vars: Overwrite local variables from remote inventory source. (boolean)custom_virtualenv: (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)verbosity: (choice)0: 0 (WARNING)1: 1 (INFO)2: 2 (DEBUG)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_args: (string)job_cwd: (string)job_env: (json)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)result_traceback: (string)event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)inventory: (id)inventory_source: (id)license_error: (boolean)org_host_limit_error: (boolean)source_project_update: Inventory files from this Project Update were used for the inventory update. (id)source_project: The project used for this job. (field)Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:
\ncan_cancel: (boolean)Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:
\ncan_cancel: (boolean)Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ninventory update.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: (id)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\ninventory update events associated with the selected\ninventory update.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of inventory update events\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more inventory update event records.
Each inventory update event data structure includes the following fields:
\nid: Database ID for this inventory update event. (integer)type: Data type for this inventory update event. (choice)url: URL for this inventory update event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory update event was created. (datetime)modified: Timestamp when this inventory update event was last modified. (datetime)event: (field)counter: (integer)event_display: (string)event_data: (json)failed: (field)changed: (field)uuid: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)inventory_update: (id)To specify that inventory update events are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nnotifications associated with the selected\ninventory update.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notifications\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification records.
Each notification data structure includes the following fields:
\nid: Database ID for this notification. (integer)type: Data type for this notification. (choice)url: URL for this notification. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification was created. (datetime)modified: Timestamp when this notification was last modified. (datetime)notification_template: (id)error: (string)status: (choice)pending: Pendingsuccessful: Successfulfailed: Failednotifications_sent: (integer)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhookrecipients: (string)subject: (string)body: Notification body (json)To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve the stdout from running this\ninventory update.
\nUse the format query string parameter to specify the output format.
?format=api?format=html?format=txt?format=ansi?format=json?format=txt_download?format=ansi_download(New in Ansible Tower 2.0.0) When using the Browsable API, HTML and JSON\nformats, the start_line and end_line query string parameters can be used\nto specify a range of line numbers to retrieve.
Use dark=1 or dark=0 as a query string parameter to force or disable a\ndark background.
Files over 1.0??MB (configurable)\nwill not display in the browser. Use the txt_download or ansi_download\nformats to download the file directly to view it.
Make a GET request to this resource to retrieve the list of\njob events.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of job events\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job event records.
Each job event data structure includes the following fields:
\nid: Database ID for this job event. (integer)type: Data type for this job event. (choice)url: URL for this job event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job event was created. (datetime)modified: Timestamp when this job event was last modified. (datetime)job: (id)event: (choice)runner_on_failed: Host Failedrunner_on_start: Host Startedrunner_on_ok: Host OKrunner_on_error: Host Failurerunner_on_skipped: Host Skippedrunner_on_unreachable: Host Unreachablerunner_on_no_hosts: No Hosts Remainingrunner_on_async_poll: Host Pollingrunner_on_async_ok: Host Async OKrunner_on_async_failed: Host Async Failurerunner_item_on_ok: Item OKrunner_item_on_failed: Item Failedrunner_item_on_skipped: Item Skippedrunner_retry: Host Retryrunner_on_file_diff: File Differenceplaybook_on_start: Playbook Startedplaybook_on_notify: Running Handlersplaybook_on_include: Including Fileplaybook_on_no_hosts_matched: No Hosts Matchedplaybook_on_no_hosts_remaining: No Hosts Remainingplaybook_on_task_start: Task Startedplaybook_on_vars_prompt: Variables Promptedplaybook_on_setup: Gathering Factsplaybook_on_import_for_host: internal: on Import for Hostplaybook_on_not_import_for_host: internal: on Not Import for Hostplaybook_on_play_start: Play Startedplaybook_on_stats: Playbook Completedebug: Debugverbose: Verbosedeprecated: Deprecatedwarning: Warningsystem_warning: System Warningerror: Errorcounter: (integer)event_display: (string)event_data: (json)event_level: (integer)failed: (boolean)changed: (boolean)uuid: (string)parent_uuid: (string)host: (id)host_name: (string)playbook: (string)play: (string)task: (string)role: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)To specify that job events are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single job event\nrecord containing the following fields:
\nid: Database ID for this job event. (integer)type: Data type for this job event. (choice)url: URL for this job event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job event was created. (datetime)modified: Timestamp when this job event was last modified. (datetime)job: (id)event: (choice)runner_on_failed: Host Failedrunner_on_start: Host Startedrunner_on_ok: Host OKrunner_on_error: Host Failurerunner_on_skipped: Host Skippedrunner_on_unreachable: Host Unreachablerunner_on_no_hosts: No Hosts Remainingrunner_on_async_poll: Host Pollingrunner_on_async_ok: Host Async OKrunner_on_async_failed: Host Async Failurerunner_item_on_ok: Item OKrunner_item_on_failed: Item Failedrunner_item_on_skipped: Item Skippedrunner_retry: Host Retryrunner_on_file_diff: File Differenceplaybook_on_start: Playbook Startedplaybook_on_notify: Running Handlersplaybook_on_include: Including Fileplaybook_on_no_hosts_matched: No Hosts Matchedplaybook_on_no_hosts_remaining: No Hosts Remainingplaybook_on_task_start: Task Startedplaybook_on_vars_prompt: Variables Promptedplaybook_on_setup: Gathering Factsplaybook_on_import_for_host: internal: on Import for Hostplaybook_on_not_import_for_host: internal: on Not Import for Hostplaybook_on_play_start: Play Startedplaybook_on_stats: Playbook Completedebug: Debugverbose: Verbosedeprecated: Deprecatedwarning: Warningsystem_warning: System Warningerror: Errorcounter: (integer)event_display: (string)event_data: (json)event_level: (integer)failed: (boolean)changed: (boolean)uuid: (string)parent_uuid: (string)host: (id)host_name: (string)playbook: (string)play: (string)task: (string)role: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)Make a GET request to this resource to retrieve a list of\njob events associated with the selected\njob event.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of job events\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job event records.
Each job event data structure includes the following fields:
\nid: Database ID for this job event. (integer)type: Data type for this job event. (choice)url: URL for this job event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job event was created. (datetime)modified: Timestamp when this job event was last modified. (datetime)job: (id)event: (choice)runner_on_failed: Host Failedrunner_on_start: Host Startedrunner_on_ok: Host OKrunner_on_error: Host Failurerunner_on_skipped: Host Skippedrunner_on_unreachable: Host Unreachablerunner_on_no_hosts: No Hosts Remainingrunner_on_async_poll: Host Pollingrunner_on_async_ok: Host Async OKrunner_on_async_failed: Host Async Failurerunner_item_on_ok: Item OKrunner_item_on_failed: Item Failedrunner_item_on_skipped: Item Skippedrunner_retry: Host Retryrunner_on_file_diff: File Differenceplaybook_on_start: Playbook Startedplaybook_on_notify: Running Handlersplaybook_on_include: Including Fileplaybook_on_no_hosts_matched: No Hosts Matchedplaybook_on_no_hosts_remaining: No Hosts Remainingplaybook_on_task_start: Task Startedplaybook_on_vars_prompt: Variables Promptedplaybook_on_setup: Gathering Factsplaybook_on_import_for_host: internal: on Import for Hostplaybook_on_not_import_for_host: internal: on Not Import for Hostplaybook_on_play_start: Play Startedplaybook_on_stats: Playbook Completedebug: Debugverbose: Verbosedeprecated: Deprecatedwarning: Warningsystem_warning: System Warningerror: Errorcounter: (integer)event_display: (string)event_data: (json)event_level: (integer)failed: (boolean)changed: (boolean)uuid: (string)parent_uuid: (string)host: (id)host_name: (string)playbook: (string)play: (string)task: (string)role: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)To specify that job events are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nhosts associated with the selected\njob event.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of hosts\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more host records.
Each host data structure includes the following fields:
\nid: Database ID for this host. (integer)type: Data type for this host. (choice)url: URL for this host. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this host was created. (datetime)modified: Timestamp when this host was last modified. (datetime)name: Name of this host. (string)description: Optional description of this host. (string)inventory: (id)enabled: Is this host online and available for running jobs? (boolean)instance_id: The value used by the remote inventory source to uniquely identify the host (string)variables: Host variables in JSON or YAML format. (json)has_active_failures: (field)has_inventory_sources: (field)last_job: (id)last_job_host_summary: (id)insights_system_id: Red Hat Insights host unique identifier. (string)ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)To specify that hosts are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single job host summary\nrecord containing the following fields:
\nid: Database ID for this job host summary. (integer)type: Data type for this job host summary. (choice)url: URL for this job host summary. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job host summary was created. (datetime)modified: Timestamp when this job host summary was last modified. (datetime)job: (id)host: (id)host_name: (string)changed: (integer)dark: (integer)failures: (integer)ok: (integer)processed: (integer)skipped: (integer)failed: (boolean)ignored: (integer)rescued: (integer)Make a GET request to this resource to retrieve the list of\njob templates.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of job templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job template records.
Each job template data structure includes the following fields:
\nid: Database ID for this job template. (integer)type: Data type for this job template. (choice)url: URL for this job template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job template was created. (datetime)modified: Timestamp when this job template was last modified. (datetime)name: Name of this job template. (string)description: Optional description of this job template. (string)job_type: (choice)run: Runcheck: Checkinventory: (id)project: (id)playbook: (string)scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)forks: (integer)limit: (string)verbosity: (choice)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (json)job_tags: (string)force_handlers: (boolean)skip_tags: (string)start_at_task: (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)use_fact_cache: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)organization: The organization used to determine access to this template. (id)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedhost_config_key: (string)ask_scm_branch_on_launch: (boolean)ask_diff_mode_on_launch: (boolean)ask_variables_on_launch: (boolean)ask_limit_on_launch: (boolean)ask_tags_on_launch: (boolean)ask_skip_tags_on_launch: (boolean)ask_job_type_on_launch: (boolean)ask_verbosity_on_launch: (boolean)ask_inventory_on_launch: (boolean)ask_credential_on_launch: (boolean)survey_enabled: (boolean)become_enabled: (boolean)diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)allow_simultaneous: (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)job_slice_count: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)To specify that job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following job template\nfields to create a new job template:
\nname: Name of this job template. (string, required)description: Optional description of this job template. (string, default=\"\")job_type: (choice)run: Run (default)check: Checkinventory: (id, default=``)project: (id, default=``)playbook: (string, default=\"\")scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=\"\")forks: (integer, default=0)limit: (string, default=\"\")verbosity: (choice)0: 0 (Normal) (default)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (json, default=``)job_tags: (string, default=\"\")force_handlers: (boolean, default=False)skip_tags: (string, default=\"\")start_at_task: (string, default=\"\")timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)use_fact_cache: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=False)
host_config_key: (string, default=\"\")
ask_scm_branch_on_launch: (boolean, default=False)ask_diff_mode_on_launch: (boolean, default=False)ask_variables_on_launch: (boolean, default=False)ask_limit_on_launch: (boolean, default=False)ask_tags_on_launch: (boolean, default=False)ask_skip_tags_on_launch: (boolean, default=False)ask_job_type_on_launch: (boolean, default=False)ask_verbosity_on_launch: (boolean, default=False)ask_inventory_on_launch: (boolean, default=False)ask_credential_on_launch: (boolean, default=False)survey_enabled: (boolean, default=False)become_enabled: (boolean, default=False)diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=False)allow_simultaneous: (boolean, default=False)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")job_slice_count: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=1)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)Make a DELETE request to this resource to delete this job template.
", "operationId":"Job Templates_job_templates_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "409":{ "examples":{ "application/json":{ "active_jobs":[ { "id":1, "type":"job" } ], "error":"Resource is being used by running jobs." } }, "description":"" } }, "summary":" Delete a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}--delete", "x-filename-id":"api-v2-job_templates-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single job template\nrecord containing the following fields:
\nid: Database ID for this job template. (integer)type: Data type for this job template. (choice)url: URL for this job template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job template was created. (datetime)modified: Timestamp when this job template was last modified. (datetime)name: Name of this job template. (string)description: Optional description of this job template. (string)job_type: (choice)run: Runcheck: Checkinventory: (id)project: (id)playbook: (string)scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)forks: (integer)limit: (string)verbosity: (choice)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (json)job_tags: (string)force_handlers: (boolean)skip_tags: (string)start_at_task: (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)use_fact_cache: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)organization: The organization used to determine access to this template. (id)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedhost_config_key: (string)ask_scm_branch_on_launch: (boolean)ask_diff_mode_on_launch: (boolean)ask_variables_on_launch: (boolean)ask_limit_on_launch: (boolean)ask_tags_on_launch: (boolean)ask_skip_tags_on_launch: (boolean)ask_job_type_on_launch: (boolean)ask_verbosity_on_launch: (boolean)ask_inventory_on_launch: (boolean)ask_credential_on_launch: (boolean)survey_enabled: (boolean)become_enabled: (boolean)diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)allow_simultaneous: (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)job_slice_count: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)Make a PUT or PATCH request to this resource to update this\njob template. The following fields may be modified:
\nname: Name of this job template. (string, required)description: Optional description of this job template. (string, default=\"\")job_type: (choice)run: Run (default)check: Checkinventory: (id, default=``)project: (id, default=``)playbook: (string, default=\"\")scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=\"\")forks: (integer, default=0)limit: (string, default=\"\")verbosity: (choice)0: 0 (Normal) (default)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (json, default=``)job_tags: (string, default=\"\")force_handlers: (boolean, default=False)skip_tags: (string, default=\"\")start_at_task: (string, default=\"\")timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)use_fact_cache: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=False)
host_config_key: (string, default=\"\")
ask_scm_branch_on_launch: (boolean, default=False)ask_diff_mode_on_launch: (boolean, default=False)ask_variables_on_launch: (boolean, default=False)ask_limit_on_launch: (boolean, default=False)ask_tags_on_launch: (boolean, default=False)ask_skip_tags_on_launch: (boolean, default=False)ask_job_type_on_launch: (boolean, default=False)ask_verbosity_on_launch: (boolean, default=False)ask_inventory_on_launch: (boolean, default=False)ask_credential_on_launch: (boolean, default=False)survey_enabled: (boolean, default=False)become_enabled: (boolean, default=False)diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=False)allow_simultaneous: (boolean, default=False)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")job_slice_count: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=1)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)For a PATCH request, include only the fields that are being modified.
", "operationId":"Job Templates_job_templates_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "allow_simultaneous":false, "ask_credential_on_launch":false, "ask_diff_mode_on_launch":false, "ask_inventory_on_launch":true, "ask_job_type_on_launch":false, "ask_limit_on_launch":false, "ask_scm_branch_on_launch":false, "ask_skip_tags_on_launch":false, "ask_tags_on_launch":false, "ask_variables_on_launch":false, "ask_verbosity_on_launch":false, "become_enabled":false, "created":"2018-02-01T08:00:00.000000Z", "custom_virtualenv":null, "description":"", "diff_mode":false, "extra_vars":"", "force_handlers":false, "forks":0, "host_config_key":"", "id":3, "inventory":null, "job_slice_count":1, "job_tags":"", "job_type":"run", "last_job_failed":false, "last_job_run":null, "limit":"", "modified":"2018-02-01T08:00:00.000000Z", "name":"fooo", "next_job_run":null, "organization":1, "playbook":"helloworld.yml", "project":2, "related":{ "access_list":"/api/v2/job_templates/3/access_list/", "activity_stream":"/api/v2/job_templates/3/activity_stream/", "copy":"/api/v2/job_templates/3/copy/", "credentials":"/api/v2/job_templates/3/credentials/", "instance_groups":"/api/v2/job_templates/3/instance_groups/", "jobs":"/api/v2/job_templates/3/jobs/", "labels":"/api/v2/job_templates/3/labels/", "launch":"/api/v2/job_templates/3/launch/", "notification_templates_error":"/api/v2/job_templates/3/notification_templates_error/", "notification_templates_started":"/api/v2/job_templates/3/notification_templates_started/", "notification_templates_success":"/api/v2/job_templates/3/notification_templates_success/", "object_roles":"/api/v2/job_templates/3/object_roles/", "organization":"/api/v2/organizations/1/", "project":"/api/v2/projects/1/", "schedules":"/api/v2/job_templates/3/schedules/", "slice_workflow_jobs":"/api/v2/job_templates/3/slice_workflow_jobs/", "survey_spec":"/api/v2/job_templates/3/survey_spec/", "webhook_key":"/api/v2/job_templates/3/webhook_key/", "webhook_receiver":"" }, "scm_branch":"", "skip_tags":"", "start_at_task":"", "status":"never updated", "summary_fields":{ "credentials":[ ], "labels":{ "count":0, "results":[ ] }, "object_roles":{ "admin_role":{ "description":"Can manage all aspects of the job template", "id":35, "name":"Admin" }, "execute_role":{ "description":"May run the job template", "id":36, "name":"Execute" }, "read_role":{ "description":"May view settings for the job template", "id":37, "name":"Read" } }, "organization":{ "description":"", "id":1, "name":"foo1" }, "project":{ "description":"", "id":1, "name":"proj1", "scm_type":"git", "status":"pending" }, "recent_jobs":[ ], "user_capabilities":{ "copy":true, "delete":true, "edit":true, "schedule":true, "start":true } }, "survey_enabled":false, "timeout":0, "type":"job_template", "url":"/api/v2/job_templates/3/", "use_fact_cache":false, "verbosity":0, "webhook_credential":null, "webhook_service":"" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "allow_simultaneous":false, "ask_credential_on_launch":false, "ask_diff_mode_on_launch":false, "ask_inventory_on_launch":true, "ask_job_type_on_launch":false, "ask_limit_on_launch":false, "ask_scm_branch_on_launch":false, "ask_skip_tags_on_launch":false, "ask_tags_on_launch":false, "ask_variables_on_launch":false, "ask_verbosity_on_launch":false, "become_enabled":false, "created":"2018-02-01T08:00:00.000000Z", "custom_virtualenv":null, "description":"", "diff_mode":false, "extra_vars":"", "force_handlers":false, "forks":0, "host_config_key":"", "id":3, "inventory":null, "job_slice_count":1, "job_tags":"", "job_type":"run", "last_job_failed":false, "last_job_run":null, "limit":"", "modified":"2018-02-01T08:00:00.000000Z", "name":"fooo", "next_job_run":null, "organization":2, "playbook":"helloworld.yml", "project":2, "related":{ "access_list":"/api/v2/job_templates/3/access_list/", "activity_stream":"/api/v2/job_templates/3/activity_stream/", "copy":"/api/v2/job_templates/3/copy/", "credentials":"/api/v2/job_templates/3/credentials/", "instance_groups":"/api/v2/job_templates/3/instance_groups/", "jobs":"/api/v2/job_templates/3/jobs/", "labels":"/api/v2/job_templates/3/labels/", "launch":"/api/v2/job_templates/3/launch/", "notification_templates_error":"/api/v2/job_templates/3/notification_templates_error/", "notification_templates_started":"/api/v2/job_templates/3/notification_templates_started/", "notification_templates_success":"/api/v2/job_templates/3/notification_templates_success/", "object_roles":"/api/v2/job_templates/3/object_roles/", "organization":"/api/v2/organizations/2/", "project":"/api/v2/projects/2/", "schedules":"/api/v2/job_templates/3/schedules/", "slice_workflow_jobs":"/api/v2/job_templates/3/slice_workflow_jobs/", "survey_spec":"/api/v2/job_templates/3/survey_spec/", "webhook_key":"/api/v2/job_templates/3/webhook_key/", "webhook_receiver":"" }, "scm_branch":"", "skip_tags":"", "start_at_task":"", "status":"never updated", "summary_fields":{ "credentials":[ ], "labels":{ "count":0, "results":[ ] }, "object_roles":{ "admin_role":{ "description":"Can manage all aspects of the job template", "id":35, "name":"Admin" }, "execute_role":{ "description":"May run the job template", "id":36, "name":"Execute" }, "read_role":{ "description":"May view settings for the job template", "id":37, "name":"Read" } }, "organization":{ "description":"", "id":2, "name":"foo2" }, "project":{ "description":"", "id":2, "name":"proj2", "scm_type":"git", "status":"pending" }, "recent_jobs":[ ], "user_capabilities":{ "copy":true, "delete":true, "edit":true, "schedule":true, "start":true } }, "survey_enabled":false, "timeout":0, "type":"job_template", "url":"/api/v2/job_templates/3/", "use_fact_cache":false, "verbosity":0, "webhook_credential":null, "webhook_service":"" } } }, "400":{ "examples":{ "application/json":{ "webhook_credential":[ "Must match the selected webhook service." ] } }, "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Update a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}--patch", "x-filename-id":"api-v2-job_templates-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\njob template. The following fields may be modified:
\nname: Name of this job template. (string, required)description: Optional description of this job template. (string, default=\"\")job_type: (choice)run: Run (default)check: Checkinventory: (id, default=``)project: (id, default=``)playbook: (string, default=\"\")scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=\"\")forks: (integer, default=0)limit: (string, default=\"\")verbosity: (choice)0: 0 (Normal) (default)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (json, default=``)job_tags: (string, default=\"\")force_handlers: (boolean, default=False)skip_tags: (string, default=\"\")start_at_task: (string, default=\"\")timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)use_fact_cache: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=False)
host_config_key: (string, default=\"\")
ask_scm_branch_on_launch: (boolean, default=False)ask_diff_mode_on_launch: (boolean, default=False)ask_variables_on_launch: (boolean, default=False)ask_limit_on_launch: (boolean, default=False)ask_tags_on_launch: (boolean, default=False)ask_skip_tags_on_launch: (boolean, default=False)ask_job_type_on_launch: (boolean, default=False)ask_verbosity_on_launch: (boolean, default=False)ask_inventory_on_launch: (boolean, default=False)ask_credential_on_launch: (boolean, default=False)survey_enabled: (boolean, default=False)become_enabled: (boolean, default=False)diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=False)allow_simultaneous: (boolean, default=False)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")job_slice_count: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=1)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_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.
", "operationId":"Job Templates_job_templates_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "allow_simultaneous":false, "ask_credential_on_launch":true, "ask_diff_mode_on_launch":false, "ask_inventory_on_launch":false, "ask_job_type_on_launch":false, "ask_limit_on_launch":false, "ask_scm_branch_on_launch":false, "ask_skip_tags_on_launch":false, "ask_tags_on_launch":false, "ask_variables_on_launch":false, "ask_verbosity_on_launch":false, "become_enabled":false, "created":"2018-02-01T08:00:00.000000Z", "custom_virtualenv":null, "description":"", "diff_mode":false, "extra_vars":"", "force_handlers":false, "forks":0, "host_config_key":"", "id":1, "inventory":1, "job_slice_count":1, "job_tags":"", "job_type":"run", "last_job_failed":false, "last_job_run":null, "limit":"", "modified":"2018-02-01T08:00:00.000000Z", "name":"test-job_template", "next_job_run":null, "organization":1, "playbook":"helloworld.yml", "project":2, "related":{ "access_list":"/api/v2/job_templates/1/access_list/", "activity_stream":"/api/v2/job_templates/1/activity_stream/", "copy":"/api/v2/job_templates/1/copy/", "credentials":"/api/v2/job_templates/1/credentials/", "instance_groups":"/api/v2/job_templates/1/instance_groups/", "inventory":"/api/v2/inventories/1/", "jobs":"/api/v2/job_templates/1/jobs/", "labels":"/api/v2/job_templates/1/labels/", "launch":"/api/v2/job_templates/1/launch/", "notification_templates_error":"/api/v2/job_templates/1/notification_templates_error/", "notification_templates_started":"/api/v2/job_templates/1/notification_templates_started/", "notification_templates_success":"/api/v2/job_templates/1/notification_templates_success/", "object_roles":"/api/v2/job_templates/1/object_roles/", "organization":"/api/v2/organizations/1/", "project":"/api/v2/projects/2/", "schedules":"/api/v2/job_templates/1/schedules/", "slice_workflow_jobs":"/api/v2/job_templates/1/slice_workflow_jobs/", "survey_spec":"/api/v2/job_templates/1/survey_spec/", "webhook_key":"/api/v2/job_templates/1/webhook_key/", "webhook_receiver":"" }, "scm_branch":"", "skip_tags":"", "start_at_task":"", "status":"never updated", "summary_fields":{ "credentials":[ { "cloud":false, "description":"", "id":2, "kind":"vault", "name":"second-vault" }, { "cloud":false, "description":"", "id":1, "kind":"vault", "name":"test-cred" } ], "inventory":{ "description":"", "has_active_failures":false, "has_inventory_sources":false, "hosts_with_active_failures":0, "id":1, "inventory_sources_with_failures":0, "kind":"", "name":"test-inv", "organization_id":1, "total_groups":0, "total_hosts":0, "total_inventory_sources":0 }, "labels":{ "count":0, "results":[ ] }, "object_roles":{ "admin_role":{ "description":"Can manage all aspects of the job template", "id":2, "name":"Admin" }, "execute_role":{ "description":"May run the job template", "id":3, "name":"Execute" }, "read_role":{ "description":"May view settings for the job template", "id":4, "name":"Read" } }, "organization":{ "description":"test-org-desc", "id":1, "name":"test-org" }, "project":{ "description":"test-proj-desc", "id":2, "name":"test-proj", "scm_type":"git", "status":"never updated" }, "recent_jobs":[ ], "user_capabilities":{ "copy":true, "delete":true, "edit":true, "schedule":true, "start":true } }, "survey_enabled":false, "timeout":0, "type":"job_template", "url":"/api/v2/job_templates/1/", "use_fact_cache":false, "verbosity":0, "webhook_credential":null, "webhook_service":"" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "allow_simultaneous":false, "ask_credential_on_launch":true, "ask_diff_mode_on_launch":false, "ask_inventory_on_launch":false, "ask_job_type_on_launch":false, "ask_limit_on_launch":false, "ask_scm_branch_on_launch":false, "ask_skip_tags_on_launch":false, "ask_tags_on_launch":false, "ask_variables_on_launch":false, "ask_verbosity_on_launch":false, "become_enabled":false, "created":"2018-02-01T08:00:00.000000Z", "custom_virtualenv":null, "description":"", "diff_mode":false, "extra_vars":"", "force_handlers":false, "forks":0, "host_config_key":"", "id":1, "inventory":1, "job_slice_count":1, "job_tags":"", "job_type":"run", "last_job_failed":false, "last_job_run":null, "limit":"", "modified":"2018-02-01T08:00:00.000000Z", "name":"test-job_template", "next_job_run":null, "organization":1, "playbook":"helloworld.yml", "project":2, "related":{ "access_list":"/api/v2/job_templates/1/access_list/", "activity_stream":"/api/v2/job_templates/1/activity_stream/", "copy":"/api/v2/job_templates/1/copy/", "credentials":"/api/v2/job_templates/1/credentials/", "instance_groups":"/api/v2/job_templates/1/instance_groups/", "inventory":"/api/v2/inventories/1/", "jobs":"/api/v2/job_templates/1/jobs/", "labels":"/api/v2/job_templates/1/labels/", "launch":"/api/v2/job_templates/1/launch/", "notification_templates_error":"/api/v2/job_templates/1/notification_templates_error/", "notification_templates_started":"/api/v2/job_templates/1/notification_templates_started/", "notification_templates_success":"/api/v2/job_templates/1/notification_templates_success/", "object_roles":"/api/v2/job_templates/1/object_roles/", "organization":"/api/v2/organizations/1/", "project":"/api/v2/projects/2/", "schedules":"/api/v2/job_templates/1/schedules/", "slice_workflow_jobs":"/api/v2/job_templates/1/slice_workflow_jobs/", "survey_spec":"/api/v2/job_templates/1/survey_spec/", "webhook_key":"/api/v2/job_templates/1/webhook_key/", "webhook_receiver":"" }, "scm_branch":"", "skip_tags":"", "start_at_task":"", "status":"never updated", "summary_fields":{ "credentials":[ { "cloud":false, "description":"", "id":2, "kind":"vault", "name":"second-vault" }, { "cloud":false, "description":"", "id":1, "kind":"vault", "name":"test-cred" } ], "inventory":{ "description":"", "has_active_failures":false, "has_inventory_sources":false, "hosts_with_active_failures":0, "id":1, "inventory_sources_with_failures":0, "kind":"", "name":"test-inv", "organization_id":1, "total_groups":0, "total_hosts":0, "total_inventory_sources":0 }, "labels":{ "count":0, "results":[ ] }, "object_roles":{ "admin_role":{ "description":"Can manage all aspects of the job template", "id":2, "name":"Admin" }, "execute_role":{ "description":"May run the job template", "id":3, "name":"Execute" }, "read_role":{ "description":"May view settings for the job template", "id":4, "name":"Read" } }, "organization":{ "description":"test-org-desc", "id":1, "name":"test-org" }, "project":{ "description":"test-proj-desc", "id":2, "name":"test-proj", "scm_type":"git", "status":"never updated" }, "recent_jobs":[ ], "user_capabilities":{ "copy":true, "delete":true, "edit":true, "schedule":true, "start":true } }, "survey_enabled":false, "timeout":0, "type":"job_template", "url":"/api/v2/job_templates/1/", "use_fact_cache":false, "verbosity":0, "webhook_credential":null, "webhook_service":"" } } } }, "summary":" Update a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}--put", "x-filename-id":"api-v2-job_templates-id-put" } }, "/api/v2/job_templates/{id}/access_list/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nusers.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\njob template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nConfigure a host to POST to this resource, passing the host_config_key\nparameter, to start a new job limited to only the requesting host. In the\nexamples below, replace the N parameter with the id of the job template\nand the HOST_CONFIG_KEY with the host_config_key associated with the\njob template.
For example, using curl:
\ncurl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\"}' http://server/api/v2/job_templates/N/callback/\nOr using wget:
\nwget -O /dev/null --post-data='{\"host_config_key\": \"HOST_CONFIG_KEY\"}' --header=Content-Type:application/json http://server/api/v2/job_templates/N/callback/\nYou may also pass extra_vars to the callback:
curl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\", \"extra_vars\": {\"key\": \"value\"}}' http://server/api/v2/job_templates/N/callback/\nThe response will return status 202 if the request is valid, 403 for an\ninvalid host config key, or 400 if the host cannot be determined from the\naddress making the request.
\n(New in Ansible Tower 2.0.0) If the associated inventory has the\nupdate_on_launch flag set and if the update_cache_timeout has expired, the\ncallback will perform an inventory sync to find a matching host.
A GET request may be used to verify that the correct host will be selected.\nThis request must authenticate as a valid user with permission to edit the\njob template. For example:
\ncurl http://user:password@server/api/v2/job_templates/N/callback/\nThe response will include the host config key as well as the host name(s)\nthat would match the request:
\n{\n \"host_config_key\": \"HOST_CONFIG_KEY\",\n \"matching_hosts\": [\"hostname\"]\n}\nConfigure a host to POST to this resource, passing the host_config_key\nparameter, to start a new job limited to only the requesting host. In the\nexamples below, replace the N parameter with the id of the job template\nand the HOST_CONFIG_KEY with the host_config_key associated with the\njob template.
For example, using curl:
\ncurl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\"}' http://server/api/v2/job_templates/N/callback/\nOr using wget:
\nwget -O /dev/null --post-data='{\"host_config_key\": \"HOST_CONFIG_KEY\"}' --header=Content-Type:application/json http://server/api/v2/job_templates/N/callback/\nYou may also pass extra_vars to the callback:
curl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\", \"extra_vars\": {\"key\": \"value\"}}' http://server/api/v2/job_templates/N/callback/\nThe response will return status 202 if the request is valid, 403 for an\ninvalid host config key, or 400 if the host cannot be determined from the\naddress making the request.
\n(New in Ansible Tower 2.0.0) If the associated inventory has the\nupdate_on_launch flag set and if the update_cache_timeout has expired, the\ncallback will perform an inventory sync to find a matching host.
A GET request may be used to verify that the correct host will be selected.\nThis request must authenticate as a valid user with permission to edit the\njob template. For example:
\ncurl http://user:password@server/api/v2/job_templates/N/callback/\nThe response will include the host config key as well as the host name(s)\nthat would match the request:
\n{\n \"host_config_key\": \"HOST_CONFIG_KEY\",\n \"matching_hosts\": [\"hostname\"]\n}\nMake a GET request to this resource to retrieve a list of\ncredentials associated with the selected\njob template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: (id)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential\nfields to create a new credential associated with this\njob template.
\nname: Name of this credential. (string, required)description: Optional description of this credential. (string, default=\"\")organization: (id, default=None)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)
inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
Make a POST request to this resource with only an id field to associate an\nexisting credential with this job template.
Make a POST request to this resource with id and disassociate fields to\nremove the credential from this job template\n without deleting the credential.
Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\njob template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of instance groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more instance group records.
Each instance group data structure includes the following fields:
\nid: Database ID for this instance group. (integer)type: Data type for this instance group. (choice)url: URL for this instance group. (string)related: Data structure with URLs of related resources. (object)name: Name of this instance group. (string)created: Timestamp when this instance group was created. (datetime)modified: Timestamp when this instance group was last modified. (datetime)capacity: (field)committed_capacity: (field)consumed_capacity: (field)percent_capacity_remaining: (field)jobs_running: Count of jobs in the running or waiting state that are targeted for this instance group (integer)jobs_total: Count of all jobs that target this instance group (integer)instances: (field)controller: Instance Group to remotely control this group. (id)is_controller: Indicates whether instance group controls any other group (boolean)is_isolated: Indicates whether instances in this group are isolated.Isolated groups have a designated controller group. (boolean)is_containerized: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)credential: (id)policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)policy_instance_list: List of exact-match Instances that will be assigned to this group (json)pod_spec_override: (string)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following instance group\nfields to create a new instance group associated with this\njob template.
\nname: Name of this instance group. (string, required)
credential: (id, default=``)
policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)pod_spec_override: (string, default=\"\")Make a POST request to this resource with only an id field to associate an\nexisting instance group with this job template.
Make a POST request to this resource with id and disassociate fields to\nremove the instance group from this job template\n without deleting the instance group.
Make a GET request to this resource to retrieve a list of\njobs associated with the selected\njob template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of jobs\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job records.
Each job data structure includes the following fields:
\nid: Database ID for this job. (integer)type: Data type for this job. (choice)url: URL for this job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job was created. (datetime)modified: Timestamp when this job was last modified. (datetime)name: Name of this job. (string)description: Optional description of this job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)controller_node: The instance that managed the isolated execution environment. (string)job_type: (choice)run: Runcheck: Checkscan: Scaninventory: (id)project: (id)playbook: (string)scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)forks: (integer)limit: (string)verbosity: (choice)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (json)job_tags: (string)force_handlers: (boolean)skip_tags: (string)start_at_task: (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)use_fact_cache: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)organization: The organization used to determine access to this unified job. (id)job_template: (id)passwords_needed_to_start: (field)allow_simultaneous: (boolean)artifacts: (json)scm_revision: The SCM Revision from the Project used for this job, if available (string)instance_group: The Instance group the job was run under (id)diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)job_slice_number: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. (integer)job_slice_count: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. (integer)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)webhook_guid: Unique identifier of the event that triggered this webhook (string)To specify that jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nlabels associated with the selected\njob template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of labels\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more label records.
Each label data structure includes the following fields:
\nid: Database ID for this label. (integer)type: Data type for this label. (choice)url: URL for this label. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this label was created. (datetime)modified: Timestamp when this label was last modified. (datetime)name: Name of this label. (string)organization: Organization this label belongs to. (id)To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following label\nfields to create a new label associated with this\njob template.
\nname: Name of this label. (string, required)organization: Organization this label belongs to. (id, required)Make a POST request to this resource with only an id field to associate an\nexisting label with this job template.
Make a POST request to this resource with id and disassociate fields to\nremove the label from this job template\n.
Labels not associated with any other resources are deleted. A label can become disassociated with a resource as a result of 3 events.
\nMake a GET request to this resource to determine if the job_template can be\nlaunched and whether any passwords are required to launch the job_template.\nThe response will include the following fields:
\nask_variables_on_launch: Flag indicating whether the job_template is\n configured to prompt for variables upon launch (boolean, read-only)ask_tags_on_launch: Flag indicating whether the job_template is\n configured to prompt for tags upon launch (boolean, read-only)ask_skip_tags_on_launch: Flag indicating whether the job_template is\n configured to prompt for skip_tags upon launch (boolean, read-only)ask_job_type_on_launch: Flag indicating whether the job_template is\n configured to prompt for job_type upon launch (boolean, read-only)ask_limit_on_launch: Flag indicating whether the job_template is\n configured to prompt for limit upon launch (boolean, read-only)ask_inventory_on_launch: Flag indicating whether the job_template is\n configured to prompt for inventory upon launch (boolean, read-only)ask_credential_on_launch: Flag indicating whether the job_template is\n configured to prompt for credential upon launch (boolean, read-only)can_start_without_user_input: Flag indicating if the job_template can be\n launched without user-input (boolean, read-only)passwords_needed_to_start: Password names required to launch the\n job_template (array, read-only)variables_needed_to_start: Required variable names required to launch the\n job_template (array, read-only)survey_enabled: Flag indicating whether the job_template has an enabled\n survey (boolean, read-only)inventory_needed_to_start: Flag indicating the presence of an inventory\n associated with the job template. If not then one should be supplied when\n launching the job (boolean, read-only)Make a POST request to this resource to launch the job_template. If any\npasswords, inventory, or extra variables (extra_vars) are required, they must\nbe passed via POST data, with extra_vars given as a YAML or JSON string and\nescaped parentheses. If the inventory_needed_to_start is True then the\ninventory is required.
If successful, the response status code will be 201. If any required passwords\nare not provided, a 400 status code will be returned. If the job cannot be\nlaunched, a 405 status code will be returned. If the provided credential or\ninventory are not allowed to be used by the user, then a 403 status code will\nbe returned.
", "operationId":"Job Templates_job_templates_launch_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "ask_credential_on_launch":false, "ask_diff_mode_on_launch":false, "ask_inventory_on_launch":false, "ask_job_type_on_launch":false, "ask_limit_on_launch":false, "ask_scm_branch_on_launch":false, "ask_skip_tags_on_launch":false, "ask_tags_on_launch":false, "ask_variables_on_launch":false, "ask_verbosity_on_launch":false, "can_start_without_user_input":false, "credential_needed_to_start":false, "defaults":{ "credentials":[ { "credential_type":2, "id":4, "name":"Vault #1", "passwords_needed":[ "vault_password.abc" ], "vault_id":"abc" }, { "credential_type":2, "id":5, "name":"Vault #2", "passwords_needed":[ "vault_password.xyz" ], "vault_id":"xyz" }, { "credential_type":3, "id":3, "name":"test-cred", "passwords_needed":[ ] } ], "diff_mode":false, "extra_vars":"", "inventory":{ "id":1, "name":"test-inv" }, "job_tags":"", "job_type":"run", "limit":"", "scm_branch":"", "skip_tags":"", "verbosity":0 }, "inventory_needed_to_start":false, "job_template_data":{ "description":"", "id":2, "name":"deploy-job-template" }, "passwords_needed_to_start":[ "vault_password.abc", "vault_password.xyz" ], "survey_enabled":false, "variables_needed_to_start":[ ] } } } }, "summary":"Launch a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-launch--get", "x-filename-id":"api-v2-job_templates-id-launch-get" }, "post":{ "consumes":[ "application/json" ], "description":"Make a GET request to this resource to determine if the job_template can be\nlaunched and whether any passwords are required to launch the job_template.\nThe response will include the following fields:
\nask_variables_on_launch: Flag indicating whether the job_template is\n configured to prompt for variables upon launch (boolean, read-only)ask_tags_on_launch: Flag indicating whether the job_template is\n configured to prompt for tags upon launch (boolean, read-only)ask_skip_tags_on_launch: Flag indicating whether the job_template is\n configured to prompt for skip_tags upon launch (boolean, read-only)ask_job_type_on_launch: Flag indicating whether the job_template is\n configured to prompt for job_type upon launch (boolean, read-only)ask_limit_on_launch: Flag indicating whether the job_template is\n configured to prompt for limit upon launch (boolean, read-only)ask_inventory_on_launch: Flag indicating whether the job_template is\n configured to prompt for inventory upon launch (boolean, read-only)ask_credential_on_launch: Flag indicating whether the job_template is\n configured to prompt for credential upon launch (boolean, read-only)can_start_without_user_input: Flag indicating if the job_template can be\n launched without user-input (boolean, read-only)passwords_needed_to_start: Password names required to launch the\n job_template (array, read-only)variables_needed_to_start: Required variable names required to launch the\n job_template (array, read-only)survey_enabled: Flag indicating whether the job_template has an enabled\n survey (boolean, read-only)inventory_needed_to_start: Flag indicating the presence of an inventory\n associated with the job template. If not then one should be supplied when\n launching the job (boolean, read-only)Make a POST request to this resource to launch the job_template. If any\npasswords, inventory, or extra variables (extra_vars) are required, they must\nbe passed via POST data, with extra_vars given as a YAML or JSON string and\nescaped parentheses. If the inventory_needed_to_start is True then the\ninventory is required.
If successful, the response status code will be 201. If any required passwords\nare not provided, a 400 status code will be returned. If the job cannot be\nlaunched, a 405 status code will be returned. If the provided credential or\ninventory are not allowed to be used by the user, then a 403 status code will\nbe returned.
", "operationId":"Job Templates_job_templates_launch_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "extra_vars":{ "survey_var":7 } } } } ], "produces":[ "application/json" ], "responses":{ "201":{ "description":"", "examples":{ "application/json":{ "ignored_fields":{ "extra_vars":{ "survey_var":7 } }, "job":968 } } }, "400":{ "examples":{ "application/json":{ "variables_needed_to_start":[ "'secret_value' value missing" ] } }, "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":"Launch a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-launch--post", "x-filename-id":"api-v2-job_templates-id-launch-post" } }, "/api/v2/job_templates/{id}/notification_templates_error/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\njob template.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this job template.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this job template\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\njob template.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this job template.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this job template\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\njob template.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this job template.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this job template\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nroles associated with the selected\njob template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nschedules associated with the selected\njob template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of schedules\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more schedule records.
Each schedule data structure includes the following fields:
\nrrule: A value representing the schedules iCal recurrence rule. (string)id: Database ID for this schedule. (integer)type: Data type for this schedule. (choice)url: URL for this schedule. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this schedule was created. (datetime)modified: Timestamp when this schedule was last modified. (datetime)name: Name of this schedule. (string)description: Optional description of this schedule. (string)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)unified_job_template: (id)enabled: Enables processing of this schedule. (boolean)dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)next_run: The next time that the scheduled action will run. (datetime)timezone: (field)until: (field)To specify that schedules are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following schedule\nfields to create a new schedule associated with this\njob template.
\nrrule: A value representing the schedules iCal recurrence rule. (string, required)
name: Name of this schedule. (string, required)
description: Optional description of this schedule. (string, default=\"\")extra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)
None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)enabled: Enables processing of this schedule. (boolean, default=True)
POST requests to this resource must include a proper rrule value following\na particular format and conforming to subset of allowed rules.
The following lists the expected format and details of our rrules:
\nHere are some example rrules:
\n\"DTSTART:20500331T055000Z RRULE:FREQ=MINUTELY;INTERVAL=10;COUNT=5\"\n\"DTSTART:20240331T075000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MINUTELY;INTERVAL=1;UNTIL=20230401T075000Z\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=5;BYDAY=MO\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=6\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=4;BYDAY=SU\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR,SA,SU\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=4;BYMONTHDAY=1\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYSETPOS=-1;BYMONTH=8;BYDAY=SU\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;UNTIL=20230401T075000Z;BYDAY=MO,WE,FR\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=HOURLY;INTERVAL=1;UNTIL=20230610T075000Z\"\nMake a GET request to this resource to retrieve a list of\nworkflow jobs associated with the selected\njob template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow jobs\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job records.
Each workflow job data structure includes the following fields:
\nid: Database ID for this workflow job. (integer)type: Data type for this workflow job. (choice)url: URL for this workflow job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job was created. (datetime)modified: Timestamp when this workflow job was last modified. (datetime)name: Name of this workflow job. (string)description: Optional description of this workflow job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)workflow_job_template: (id)extra_vars: (json)allow_simultaneous: (boolean)job_template: If automatically created for a sliced job run, the job template the workflow job was created from. (id)is_sliced_job: (boolean)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)limit: (string)scm_branch: (string)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)webhook_guid: Unique identifier of the event that triggered this webhook (string)To specify that workflow jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following workflow job\nfields to create a new workflow job associated with this\njob template.
\nname: Name of this workflow job. (string, required)description: Optional description of this workflow job. (string, default=\"\")
workflow_job_template: (id, default=``)
extra_vars: (json, default=``)allow_simultaneous: (boolean, default=False)
is_sliced_job: (boolean, default=False)
inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)limit: (string, default=\"\")scm_branch: (string, default=\"\")webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)webhook_guid: Unique identifier of the event that triggered this webhook (string, default=\"\")Here is an example survey specification:
\n{\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \"type\": \"text\",\n \"question_name\": \"example question\",\n \"question_description\": \"What is your favorite color?\",\n \"variable\": \"favorite_color\",\n \"required\": false,\n \"default\": \"blue\"\n }\n ]\n}\nname and description are required elements at the beginning of the survey specification. spec must be a\nlist of survey items.
Within each survey item type must be one of:
Each item must contain a question_name and question_description field that describes the survey question itself.\nThe variable elements of each survey items represents the key that will be given to the playbook when the job template\nis launched. It will contain the value as a result of the survey.
Here is a more comprehensive example showing the various question types and their acceptable parameters:
\n{\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \"type\": \"text\",\n \"question_name\": \"cantbeshort\",\n \"question_description\": \"What is a long answer\",\n \"variable\": \"long_answer\",\n \"choices\": \"\",\n \"min\": 5,\n \"max\": \"\",\n \"required\": false,\n \"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \"type\": \"text\",\n \"question_name\": \"cantbelong\",\n \"question_description\": \"What is a short answer\",\n \"variable\": \"short_answer\",\n \"choices\": \"\",\n \"min\": \"\",\n \"max\": 7,\n \"required\": false,\n \"default\": \"leeloo\"\n },\n {\n \"type\": \"text\",\n \"question_name\": \"reqd\",\n \"question_description\": \"I should be required\",\n \"variable\": \"reqd_answer\",\n \"choices\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"required\": true,\n \"default\": \"NOT OPTIONAL\"\n },\n {\n \"type\": \"multiplechoice\",\n \"question_name\": \"achoice\",\n \"question_description\": \"Need one of these\",\n \"variable\": \"single_choice\",\n \"choices\": [\"one\", \"two\"],\n \"min\": \"\",\n \"max\": \"\",\n \"required\": false,\n \"default\": \"one\"\n },\n {\n \"type\": \"multiselect\",\n \"question_name\": \"mchoice\",\n \"question_description\": \"Can have multiples of these\",\n \"variable\": \"multi_choice\",\n \"choices\": [\"one\", \"two\", \"three\"],\n \"min\": \"\",\n \"max\": \"\",\n \"required\": false,\n \"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n}\nHere is an example survey specification:
\n{\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \"type\": \"text\",\n \"question_name\": \"example question\",\n \"question_description\": \"What is your favorite color?\",\n \"variable\": \"favorite_color\",\n \"required\": false,\n \"default\": \"blue\"\n }\n ]\n}\nname and description are required elements at the beginning of the survey specification. spec must be a\nlist of survey items.
Within each survey item type must be one of:
Each item must contain a question_name and question_description field that describes the survey question itself.\nThe variable elements of each survey items represents the key that will be given to the playbook when the job template\nis launched. It will contain the value as a result of the survey.
Here is a more comprehensive example showing the various question types and their acceptable parameters:
\n{\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \"type\": \"text\",\n \"question_name\": \"cantbeshort\",\n \"question_description\": \"What is a long answer\",\n \"variable\": \"long_answer\",\n \"choices\": \"\",\n \"min\": 5,\n \"max\": \"\",\n \"required\": false,\n \"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \"type\": \"text\",\n \"question_name\": \"cantbelong\",\n \"question_description\": \"What is a short answer\",\n \"variable\": \"short_answer\",\n \"choices\": \"\",\n \"min\": \"\",\n \"max\": 7,\n \"required\": false,\n \"default\": \"leeloo\"\n },\n {\n \"type\": \"text\",\n \"question_name\": \"reqd\",\n \"question_description\": \"I should be required\",\n \"variable\": \"reqd_answer\",\n \"choices\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"required\": true,\n \"default\": \"NOT OPTIONAL\"\n },\n {\n \"type\": \"multiplechoice\",\n \"question_name\": \"achoice\",\n \"question_description\": \"Need one of these\",\n \"variable\": \"single_choice\",\n \"choices\": [\"one\", \"two\"],\n \"min\": \"\",\n \"max\": \"\",\n \"required\": false,\n \"default\": \"one\"\n },\n {\n \"type\": \"multiselect\",\n \"question_name\": \"mchoice\",\n \"question_description\": \"Can have multiples of these\",\n \"variable\": \"multi_choice\",\n \"choices\": [\"one\", \"two\", \"three\"],\n \"min\": \"\",\n \"max\": \"\",\n \"required\": false,\n \"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n}\nHere is an example survey specification:
\n{\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \"type\": \"text\",\n \"question_name\": \"example question\",\n \"question_description\": \"What is your favorite color?\",\n \"variable\": \"favorite_color\",\n \"required\": false,\n \"default\": \"blue\"\n }\n ]\n}\nname and description are required elements at the beginning of the survey specification. spec must be a\nlist of survey items.
Within each survey item type must be one of:
Each item must contain a question_name and question_description field that describes the survey question itself.\nThe variable elements of each survey items represents the key that will be given to the playbook when the job template\nis launched. It will contain the value as a result of the survey.
Here is a more comprehensive example showing the various question types and their acceptable parameters:
\n{\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \"type\": \"text\",\n \"question_name\": \"cantbeshort\",\n \"question_description\": \"What is a long answer\",\n \"variable\": \"long_answer\",\n \"choices\": \"\",\n \"min\": 5,\n \"max\": \"\",\n \"required\": false,\n \"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \"type\": \"text\",\n \"question_name\": \"cantbelong\",\n \"question_description\": \"What is a short answer\",\n \"variable\": \"short_answer\",\n \"choices\": \"\",\n \"min\": \"\",\n \"max\": 7,\n \"required\": false,\n \"default\": \"leeloo\"\n },\n {\n \"type\": \"text\",\n \"question_name\": \"reqd\",\n \"question_description\": \"I should be required\",\n \"variable\": \"reqd_answer\",\n \"choices\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"required\": true,\n \"default\": \"NOT OPTIONAL\"\n },\n {\n \"type\": \"multiplechoice\",\n \"question_name\": \"achoice\",\n \"question_description\": \"Need one of these\",\n \"variable\": \"single_choice\",\n \"choices\": [\"one\", \"two\"],\n \"min\": \"\",\n \"max\": \"\",\n \"required\": false,\n \"default\": \"one\"\n },\n {\n \"type\": \"multiselect\",\n \"question_name\": \"mchoice\",\n \"question_description\": \"Can have multiples of these\",\n \"variable\": \"multi_choice\",\n \"choices\": [\"one\", \"two\", \"three\"],\n \"min\": \"\",\n \"max\": \"\",\n \"required\": false,\n \"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n}\nMake a GET request to this resource to retrieve the list of\njobs.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of jobs\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job records.
Each job data structure includes the following fields:
\nid: Database ID for this job. (integer)type: Data type for this job. (choice)url: URL for this job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job was created. (datetime)modified: Timestamp when this job was last modified. (datetime)name: Name of this job. (string)description: Optional description of this job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)controller_node: The instance that managed the isolated execution environment. (string)job_type: (choice)run: Runcheck: Checkscan: Scaninventory: (id)project: (id)playbook: (string)scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)forks: (integer)limit: (string)verbosity: (choice)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (json)job_tags: (string)force_handlers: (boolean)skip_tags: (string)start_at_task: (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)use_fact_cache: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)organization: The organization used to determine access to this unified job. (id)job_template: (id)passwords_needed_to_start: (field)allow_simultaneous: (boolean)artifacts: (json)scm_revision: The SCM Revision from the Project used for this job, if available (string)instance_group: The Instance group the job was run under (id)diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)job_slice_number: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. (integer)job_slice_count: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. (integer)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)webhook_guid: Unique identifier of the event that triggered this webhook (string)To specify that jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a DELETE request to this resource to delete this job.
", "operationId":"Jobs_jobs_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"Cannot delete running job resource." } }, "description":"" } }, "summary":" Delete a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}--delete", "x-filename-id":"api-v2-jobs-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single job host summary\nrecord containing the following fields:
\nid: Database ID for this job host summary. (integer)type: Data type for this job host summary. (choice)url: URL for this job host summary. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job host summary was created. (datetime)modified: Timestamp when this job host summary was last modified. (datetime)job: (id)host: (id)host_name: (string)changed: (integer)dark: (integer)failures: (integer)ok: (integer)processed: (integer)skipped: (integer)failed: (boolean)ignored: (integer)rescued: (integer)Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\njob.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to determine if the job can be canceled.\nThe response will include the following field:
\ncan_cancel: Indicates whether this job can be canceled (boolean, read-only)Make a POST request to this resource to cancel a pending or running job. The\nresponse status code will be 202 if successful, or 405 if the job cannot be\ncanceled.
", "operationId":"Jobs_jobs_cancel_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "responses":{ "201":{ "description":"" } }, "summary":" Cancel a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-cancel--post", "x-filename-id":"api-v2-jobs-id-cancel-post" } }, "/api/v2/jobs/{id}/create_schedule/":{ "get":{ "description":"Make a POST request to this endpoint to create a schedule that launches\nthe job template that launched this job, and uses the same\nparameters that the job was launched with. These parameters include all\n\"prompted\" resources such as extra_vars, inventory, limit, etc.
Jobs that were launched with user-provided passwords cannot have a schedule\ncreated from them.
\nMake a GET request for information about what those prompts are and\nwhether or not a schedule can be created.
", "operationId":"Jobs_jobs_create_schedule_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":"Create a Schedule Based on a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-create_schedule--get", "x-filename-id":"api-v2-jobs-id-create_schedule-get" }, "post":{ "description":"Make a POST request to this endpoint to create a schedule that launches\nthe job template that launched this job, and uses the same\nparameters that the job was launched with. These parameters include all\n\"prompted\" resources such as extra_vars, inventory, limit, etc.
Jobs that were launched with user-provided passwords cannot have a schedule\ncreated from them.
\nMake a GET request for information about what those prompts are and\nwhether or not a schedule can be created.
", "operationId":"Jobs_jobs_create_schedule_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "responses":{ "201":{ "description":"" } }, "summary":"Create a Schedule Based on a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-create_schedule--post", "x-filename-id":"api-v2-jobs-id-create_schedule-post" } }, "/api/v2/jobs/{id}/credentials/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\njob.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: (id)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\njob events associated with the selected\njob.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of job events\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job event records.
Each job event data structure includes the following fields:
\nid: Database ID for this job event. (integer)type: Data type for this job event. (choice)url: URL for this job event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job event was created. (datetime)modified: Timestamp when this job event was last modified. (datetime)job: (id)event: (choice)runner_on_failed: Host Failedrunner_on_start: Host Startedrunner_on_ok: Host OKrunner_on_error: Host Failurerunner_on_skipped: Host Skippedrunner_on_unreachable: Host Unreachablerunner_on_no_hosts: No Hosts Remainingrunner_on_async_poll: Host Pollingrunner_on_async_ok: Host Async OKrunner_on_async_failed: Host Async Failurerunner_item_on_ok: Item OKrunner_item_on_failed: Item Failedrunner_item_on_skipped: Item Skippedrunner_retry: Host Retryrunner_on_file_diff: File Differenceplaybook_on_start: Playbook Startedplaybook_on_notify: Running Handlersplaybook_on_include: Including Fileplaybook_on_no_hosts_matched: No Hosts Matchedplaybook_on_no_hosts_remaining: No Hosts Remainingplaybook_on_task_start: Task Startedplaybook_on_vars_prompt: Variables Promptedplaybook_on_setup: Gathering Factsplaybook_on_import_for_host: internal: on Import for Hostplaybook_on_not_import_for_host: internal: on Not Import for Hostplaybook_on_play_start: Play Startedplaybook_on_stats: Playbook Completedebug: Debugverbose: Verbosedeprecated: Deprecatedwarning: Warningsystem_warning: System Warningerror: Errorcounter: (integer)event_display: (string)event_data: (json)event_level: (integer)failed: (boolean)changed: (boolean)uuid: (string)parent_uuid: (string)host: (id)host_name: (string)playbook: (string)play: (string)task: (string)role: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)To specify that job events are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\njob host summaries associated with the selected\njob.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of job host summaries\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job host summary records.
Each job host summary data structure includes the following fields:
\nid: Database ID for this job host summary. (integer)type: Data type for this job host summary. (choice)url: URL for this job host summary. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job host summary was created. (datetime)modified: Timestamp when this job host summary was last modified. (datetime)job: (id)host: (id)host_name: (string)changed: (integer)dark: (integer)failures: (integer)ok: (integer)processed: (integer)skipped: (integer)failed: (boolean)ignored: (integer)rescued: (integer)To specify that job host summaries are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nlabels associated with the selected\njob.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of labels\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more label records.
Each label data structure includes the following fields:
\nid: Database ID for this label. (integer)type: Data type for this label. (choice)url: URL for this label. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this label was created. (datetime)modified: Timestamp when this label was last modified. (datetime)name: Name of this label. (string)organization: Organization this label belongs to. (id)To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nnotifications associated with the selected\njob.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notifications\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification records.
Each notification data structure includes the following fields:
\nid: Database ID for this notification. (integer)type: Data type for this notification. (choice)url: URL for this notification. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification was created. (datetime)modified: Timestamp when this notification was last modified. (datetime)notification_template: (id)error: (string)status: (choice)pending: Pendingsuccessful: Successfulfailed: Failednotifications_sent: (integer)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhookrecipients: (string)subject: (string)body: Notification body (json)To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.
", "operationId":"Jobs_jobs_relaunch_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":"Relaunch a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-relaunch--get", "x-filename-id":"api-v2-jobs-id-relaunch-get" }, "post":{ "consumes":[ "application/json" ], "description":"Make a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.
", "operationId":"Jobs_jobs_relaunch_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "hosts":"failed" } } } ], "produces":[ "application/json" ], "responses":{ "201":{ "description":"", "examples":{ "application/json":{ "allow_simultaneous":false, "artifacts":{ }, "canceled_on":null, "controller_node":"", "created":"2018-02-01T08:00:00.000000Z", "description":"", "diff_mode":false, "elapsed":0, "event_processing_finished":false, "execution_node":"", "extra_vars":"{}", "failed":false, "finished":null, "force_handlers":false, "forks":0, "id":2, "instance_group":null, "inventory":1, "job":2, "job_args":"", "job_cwd":"", "job_env":{ }, "job_explanation":"", "job_slice_count":1, "job_slice_number":0, "job_tags":"", "job_template":2, "job_type":"run", "launch_type":"relaunch", "limit":"host3", "modified":"2018-02-01T08:00:00.000000Z", "name":"testjt", "organization":1, "passwords_needed_to_start":[ ], "playbook":"", "project":1, "related":{ "activity_stream":"/api/v2/jobs/2/activity_stream/", "cancel":"/api/v2/jobs/2/cancel/", "create_schedule":"/api/v2/jobs/2/create_schedule/", "credentials":"/api/v2/jobs/2/credentials/", "inventory":"/api/v2/inventories/1/", "job_events":"/api/v2/jobs/2/job_events/", "job_host_summaries":"/api/v2/jobs/2/job_host_summaries/", "job_template":"/api/v2/job_templates/2/", "labels":"/api/v2/jobs/2/labels/", "notifications":"/api/v2/jobs/2/notifications/", "organization":"/api/v2/organizations/1/", "project":"/api/v2/projects/1/", "relaunch":"/api/v2/jobs/2/relaunch/", "stdout":"/api/v2/jobs/2/stdout/", "unified_job_template":"/api/v2/job_templates/2/" }, "result_traceback":"", "scm_branch":"", "scm_revision":"", "skip_tags":"", "start_at_task":"", "started":null, "status":"pending", "summary_fields":{ "credentials":[ { "cloud":false, "description":"", "id":1, "kind":"ssh", "name":"machine-cred" } ], "inventory":{ "description":"", "has_active_failures":false, "has_inventory_sources":false, "hosts_with_active_failures":0, "id":1, "inventory_sources_with_failures":0, "kind":"", "name":"test-inv", "organization_id":1, "total_groups":0, "total_hosts":0, "total_inventory_sources":0 }, "job_template":{ "description":"", "id":2, "name":"testjt" }, "labels":{ "count":0, "results":[ ] }, "organization":{ "description":"test-org-desc", "id":1, "name":"test-org" }, "project":{ "description":"test-proj-desc", "id":1, "name":"test-proj", "scm_type":"git", "status":"never updated" }, "unified_job_template":{ "description":"", "id":2, "name":"testjt", "unified_job_type":"job" }, "user_capabilities":{ "delete":true, "start":true } }, "timeout":0, "type":"job", "unified_job_template":2, "url":"/api/v2/jobs/2/", "use_fact_cache":false, "verbosity":0, "webhook_credential":null, "webhook_guid":"", "webhook_service":"" } } }, "403":{ "examples":{ "application/json":{ "detail":"Job was launched with secret prompts provided by another user." } }, "description":"" } }, "summary":"Relaunch a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-relaunch--post", "x-filename-id":"api-v2-jobs-id-relaunch-post" } }, "/api/v2/jobs/{id}/stdout/":{ "get":{ "description":"Make GET request to this resource to retrieve the stdout from running this\njob.
\nUse the format query string parameter to specify the output format.
?format=api?format=html?format=txt?format=ansi?format=json?format=txt_download?format=ansi_download(New in Ansible Tower 2.0.0) When using the Browsable API, HTML and JSON\nformats, the start_line and end_line query string parameters can be used\nto specify a range of line numbers to retrieve.
Use dark=1 or dark=0 as a query string parameter to force or disable a\ndark background.
Files over 1.0??MB (configurable)\nwill not display in the browser. Use the txt_download or ansi_download\nformats to download the file directly to view it.
Make a GET request to this resource to retrieve the list of\nlabels.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of labels\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more label records.
Each label data structure includes the following fields:
\nid: Database ID for this label. (integer)type: Data type for this label. (choice)url: URL for this label. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this label was created. (datetime)modified: Timestamp when this label was last modified. (datetime)name: Name of this label. (string)organization: Organization this label belongs to. (id)To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following label\nfields to create a new label:
\nname: Name of this label. (string, required)organization: Organization this label belongs to. (id, required)Make GET request to this resource to retrieve a single label\nrecord containing the following fields:
\nid: Database ID for this label. (integer)type: Data type for this label. (choice)url: URL for this label. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this label was created. (datetime)modified: Timestamp when this label was last modified. (datetime)name: Name of this label. (string)organization: Organization this label belongs to. (id)Make a PUT or PATCH request to this resource to update this\nlabel. The following fields may be modified:
\nname: Name of this label. (string, required)organization: Organization this label belongs to. (id, required)For a PATCH request, include only the fields that are being modified.
", "operationId":"Labels_labels_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "name":{ "description":"", "type":"string" }, "organization":{ "description":"Organization this label belongs to.", "type":"integer" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Label", "tags":[ "Labels" ], "x-internal-id":"api-v2-labels-{id}--patch", "x-filename-id":"api-v2-labels-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\nlabel. The following fields may be modified:
\nname: Name of this label. (string, required)organization: Organization this label belongs to. (id, required)For a PUT request, include all fields in the request.
", "operationId":"Labels_labels_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "name":{ "description":"", "type":"string" }, "organization":{ "description":"Organization this label belongs to.", "type":"integer" } }, "required":[ "name", "organization" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Label", "tags":[ "Labels" ], "x-internal-id":"api-v2-labels-{id}--put", "x-filename-id":"api-v2-labels-id-put" } }, "/api/v2/me/":{ "get":{ "description":"Make a GET request to retrieve user information about the current user.
\nOne result should be returned containing the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)Use the primary URL for the user (/api/v2/users/N/) to modify the user.
", "operationId":"Users_me_list", "parameters":[ { "description":"A page number within the paginated result set.", "in":"query", "name":"page", "required":false, "type":"integer" }, { "description":"Number of results to return per page.", "in":"query", "name":"page_size", "required":false, "type":"integer" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "count":1, "next":null, "previous":null, "results":[ { "auth":[ ], "created":"2018-02-01T08:00:00.000000Z", "email":"", "external_account":"enterprise", "first_name":"", "id":1, "is_superuser":true, "is_system_auditor":false, "last_login":null, "last_name":"", "ldap_dn":"", "related":{ "access_list":"/api/v2/users/1/access_list/", "activity_stream":"/api/v2/users/1/activity_stream/", "admin_of_organizations":"/api/v2/users/1/admin_of_organizations/", "authorized_tokens":"/api/v2/users/1/authorized_tokens/", "credentials":"/api/v2/users/1/credentials/", "organizations":"/api/v2/users/1/organizations/", "personal_tokens":"/api/v2/users/1/personal_tokens/", "projects":"/api/v2/users/1/projects/", "roles":"/api/v2/users/1/roles/", "teams":"/api/v2/users/1/teams/", "tokens":"/api/v2/users/1/tokens/" }, "summary_fields":{ "user_capabilities":{ "delete":false, "edit":false } }, "type":"user", "url":"/api/v2/users/1/", "username":"admin" } ] } } } }, "summary":" Retrieve Information About the Current User", "tags":[ "Users" ], "x-internal-id":"api-v2-me--get", "x-filename-id":"api-v2-me-get" } }, "/api/v2/metrics/":{ "get":{ "description":"", "operationId":"Metrics_metrics_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "summary":"Show Metrics Details", "tags":[ "Metrics" ], "x-internal-id":"api-v2-metrics--get", "x-filename-id":"api-v2-metrics-get" } }, "/api/v2/notification_templates/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nnotification templates.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template:
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a DELETE request to this resource to delete this notification template.
", "operationId":"Notification Templates_notification_templates_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete a Notification Template", "tags":[ "Notification Templates" ], "x-internal-id":"api-v2-notification_templates-{id}--delete", "x-filename-id":"api-v2-notification_templates-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single notification template\nrecord containing the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)Make a PUT or PATCH request to this resource to update this\nnotification template. The following fields may be modified:
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})For a PATCH request, include only the fields that are being modified.
", "operationId":"Notification Templates_notification_templates_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "messages":{ "description":"Optional custom messages for notification template.", "type":"string" }, "name":{ "description":"", "type":"string" }, "notification_configuration":{ "description":"", "type":"string" }, "notification_type":{ "description":"", "type":"string" }, "organization":{ "description":"", "type":"integer" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Notification Template", "tags":[ "Notification Templates" ], "x-internal-id":"api-v2-notification_templates-{id}--patch", "x-filename-id":"api-v2-notification_templates-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\nnotification template. The following fields may be modified:
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})For a PUT request, include all fields in the request.
", "operationId":"Notification Templates_notification_templates_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "messages":{ "description":"Optional custom messages for notification template.", "type":"string" }, "name":{ "description":"", "type":"string" }, "notification_configuration":{ "description":"", "type":"string" }, "notification_type":{ "description":"", "type":"string" }, "organization":{ "description":"", "type":"integer" } }, "required":[ "name", "organization", "notification_type" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Notification Template", "tags":[ "Notification Templates" ], "x-internal-id":"api-v2-notification_templates-{id}--put", "x-filename-id":"api-v2-notification_templates-id-put" } }, "/api/v2/notification_templates/{id}/copy/":{ "get":{ "operationId":"Notification Templates_notification_templates_copy_list", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A page number within the paginated result set.", "in":"query", "name":"page", "required":false, "type":"integer" }, { "description":"Number of results to return per page.", "in":"query", "name":"page_size", "required":false, "type":"integer" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "tags":[ "Notification Templates" ], "summary":"Notification Templates Copy List", "x-internal-id":"api-v2-notification_templates-{id}-copy--get", "x-filename-id":"api-v2-notification_templates-id-copy-get" }, "post":{ "consumes":[ "application/json" ], "operationId":"Notification Templates_notification_templates_copy_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "name":{ "description":"", "type":"string" } }, "required":[ "name" ], "type":"object" } } ], "responses":{ "201":{ "description":"" } }, "tags":[ "Notification Templates" ], "summary":"Notification Templates Copy Create", "x-internal-id":"api-v2-notification_templates-{id}-copy--post", "x-filename-id":"api-v2-notification_templates-id-copy-post" } }, "/api/v2/notification_templates/{id}/notifications/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nnotification template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notifications\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification records.
Each notification data structure includes the following fields:
\nid: Database ID for this notification. (integer)type: Data type for this notification. (choice)url: URL for this notification. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification was created. (datetime)modified: Timestamp when this notification was last modified. (datetime)notification_template: (id)error: (string)status: (choice)pending: Pendingsuccessful: Successfulfailed: Failednotifications_sent: (integer)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhookrecipients: (string)subject: (string)body: Notification body (json)To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\nnotifications.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notifications\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification records.
Each notification data structure includes the following fields:
\nid: Database ID for this notification. (integer)type: Data type for this notification. (choice)url: URL for this notification. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification was created. (datetime)modified: Timestamp when this notification was last modified. (datetime)notification_template: (id)error: (string)status: (choice)pending: Pendingsuccessful: Successfulfailed: Failednotifications_sent: (integer)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhookrecipients: (string)subject: (string)body: Notification body (json)To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single notification\nrecord containing the following fields:
\nid: Database ID for this notification. (integer)type: Data type for this notification. (choice)url: URL for this notification. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification was created. (datetime)modified: Timestamp when this notification was last modified. (datetime)notification_template: (id)error: (string)status: (choice)pending: Pendingsuccessful: Successfulfailed: Failednotifications_sent: (integer)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhookrecipients: (string)subject: (string)body: Notification body (json)Make a GET request to this resource to retrieve the list of\norganizations.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of organizations\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more organization records.
Each organization data structure includes the following fields:
\nid: Database ID for this organization. (integer)type: Data type for this organization. (choice)url: URL for this organization. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this organization was created. (datetime)modified: Timestamp when this organization was last modified. (datetime)name: Name of this organization. (string)description: Optional description of this organization. (string)max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)To specify that organizations are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following organization\nfields to create a new organization:
\nname: Name of this organization. (string, required)description: Optional description of this organization. (string, default=\"\")max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer, default=0)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")Make a DELETE request to this resource to delete this organization.
", "operationId":"Organizations_organizations_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "401":{ "examples":{ "application/json":{ "detail":"Authentication credentials were not provided. To establish a login session, visit /api/login/." } }, "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" }, "409":{ "examples":{ "application/json":{ "active_jobs":[ { "id":1, "type":"job" }, { "id":2, "type":"job" }, { "id":3, "type":"project_update" }, { "id":4, "type":"project_update" } ], "error":"Resource is being used by running jobs." } }, "description":"" } }, "summary":" Delete an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}--delete", "x-filename-id":"api-v2-organizations-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single organization\nrecord containing the following fields:
\nid: Database ID for this organization. (integer)type: Data type for this organization. (choice)url: URL for this organization. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this organization was created. (datetime)modified: Timestamp when this organization was last modified. (datetime)name: Name of this organization. (string)description: Optional description of this organization. (string)max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)Make a PUT or PATCH request to this resource to update this\norganization. The following fields may be modified:
\nname: Name of this organization. (string, required)description: Optional description of this organization. (string, default=\"\")max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer, default=0)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")For a PATCH request, include only the fields that are being modified.
", "operationId":"Organizations_organizations_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "custom_virtualenv":null } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "created":"2018-02-01T08:00:00.000000Z", "custom_virtualenv":null, "description":"test-org-desc", "id":1, "max_hosts":0, "modified":"2018-02-01T08:00:00.000000Z", "name":"test-org", "related":{ "access_list":"/api/v2/organizations/1/access_list/", "activity_stream":"/api/v2/organizations/1/activity_stream/", "admins":"/api/v2/organizations/1/admins/", "applications":"/api/v2/organizations/1/applications/", "credentials":"/api/v2/organizations/1/credentials/", "galaxy_credentials":"/api/v2/organizations/1/galaxy_credentials/", "instance_groups":"/api/v2/organizations/1/instance_groups/", "inventories":"/api/v2/organizations/1/inventories/", "job_templates":"/api/v2/organizations/1/job_templates/", "notification_templates":"/api/v2/organizations/1/notification_templates/", "notification_templates_approvals":"/api/v2/organizations/1/notification_templates_approvals/", "notification_templates_error":"/api/v2/organizations/1/notification_templates_error/", "notification_templates_started":"/api/v2/organizations/1/notification_templates_started/", "notification_templates_success":"/api/v2/organizations/1/notification_templates_success/", "object_roles":"/api/v2/organizations/1/object_roles/", "projects":"/api/v2/organizations/1/projects/", "teams":"/api/v2/organizations/1/teams/", "users":"/api/v2/organizations/1/users/", "workflow_job_templates":"/api/v2/organizations/1/workflow_job_templates/" }, "summary_fields":{ "object_roles":{ "admin_role":{ "description":"Can manage all aspects of the organization", "id":1, "name":"Admin", "user_only":true }, "approval_role":{ "description":"Can approve or deny a workflow approval node", "id":12, "name":"Approve" }, "auditor_role":{ "description":"Can view all aspects of the organization", "id":9, "name":"Auditor" }, "credential_admin_role":{ "description":"Can manage all credentials of the organization", "id":5, "name":"Credential Admin" }, "execute_role":{ "description":"May run any executable resources in the organization", "id":2, "name":"Execute" }, "inventory_admin_role":{ "description":"Can manage all inventories of the organization", "id":4, "name":"Inventory Admin" }, "job_template_admin_role":{ "description":"Can manage all job templates of the organization", "id":8, "name":"Job Template Admin" }, "member_role":{ "description":"User is a member of the organization", "id":10, "name":"Member", "user_only":true }, "notification_admin_role":{ "description":"Can manage all notifications of the organization", "id":7, "name":"Notification Admin" }, "project_admin_role":{ "description":"Can manage all projects of the organization", "id":3, "name":"Project Admin" }, "read_role":{ "description":"May view settings for the organization", "id":11, "name":"Read" }, "workflow_admin_role":{ "description":"Can manage all workflows of the organization", "id":6, "name":"Workflow Admin" } }, "related_field_counts":{ "admins":0, "inventories":0, "job_templates":0, "projects":0, "teams":0, "users":0 }, "user_capabilities":{ "delete":true, "edit":true } }, "type":"organization", "url":"/api/v2/organizations/1/" } } }, "400":{ "examples":{ "application/json":{ "custom_virtualenv":[ "/foo/bar is not a valid virtualenv in /venv/" ] } }, "description":"" } }, "summary":" Update an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}--patch", "x-filename-id":"api-v2-organizations-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\norganization. The following fields may be modified:
\nname: Name of this organization. (string, required)description: Optional description of this organization. (string, default=\"\")max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer, default=0)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")For a PUT request, include all fields in the request.
", "operationId":"Organizations_organizations_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "created":"2018-02-01T08:00:00.000000Z", "custom_virtualenv":null, "description":"test-org-desc", "id":1, "max_hosts":3, "modified":"2018-02-01T08:00:00.000000Z", "name":"test-org", "related":{ "access_list":"/api/v2/organizations/1/access_list/", "activity_stream":"/api/v2/organizations/1/activity_stream/", "admins":"/api/v2/organizations/1/admins/", "applications":"/api/v2/organizations/1/applications/", "credentials":"/api/v2/organizations/1/credentials/", "galaxy_credentials":"/api/v2/organizations/1/galaxy_credentials/", "instance_groups":"/api/v2/organizations/1/instance_groups/", "inventories":"/api/v2/organizations/1/inventories/", "job_templates":"/api/v2/organizations/1/job_templates/", "notification_templates":"/api/v2/organizations/1/notification_templates/", "notification_templates_approvals":"/api/v2/organizations/1/notification_templates_approvals/", "notification_templates_error":"/api/v2/organizations/1/notification_templates_error/", "notification_templates_started":"/api/v2/organizations/1/notification_templates_started/", "notification_templates_success":"/api/v2/organizations/1/notification_templates_success/", "object_roles":"/api/v2/organizations/1/object_roles/", "projects":"/api/v2/organizations/1/projects/", "teams":"/api/v2/organizations/1/teams/", "users":"/api/v2/organizations/1/users/", "workflow_job_templates":"/api/v2/organizations/1/workflow_job_templates/" }, "summary_fields":{ "object_roles":{ "admin_role":{ "description":"Can manage all aspects of the organization", "id":1, "name":"Admin", "user_only":true }, "approval_role":{ "description":"Can approve or deny a workflow approval node", "id":12, "name":"Approve" }, "auditor_role":{ "description":"Can view all aspects of the organization", "id":9, "name":"Auditor" }, "credential_admin_role":{ "description":"Can manage all credentials of the organization", "id":5, "name":"Credential Admin" }, "execute_role":{ "description":"May run any executable resources in the organization", "id":2, "name":"Execute" }, "inventory_admin_role":{ "description":"Can manage all inventories of the organization", "id":4, "name":"Inventory Admin" }, "job_template_admin_role":{ "description":"Can manage all job templates of the organization", "id":8, "name":"Job Template Admin" }, "member_role":{ "description":"User is a member of the organization", "id":10, "name":"Member", "user_only":true }, "notification_admin_role":{ "description":"Can manage all notifications of the organization", "id":7, "name":"Notification Admin" }, "project_admin_role":{ "description":"Can manage all projects of the organization", "id":3, "name":"Project Admin" }, "read_role":{ "description":"May view settings for the organization", "id":11, "name":"Read" }, "workflow_admin_role":{ "description":"Can manage all workflows of the organization", "id":6, "name":"Workflow Admin" } }, "related_field_counts":{ "admins":0, "inventories":0, "job_templates":0, "projects":0, "teams":0, "users":0 }, "user_capabilities":{ "delete":true, "edit":true } }, "type":"organization", "url":"/api/v2/organizations/1/" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "created":"2018-02-01T08:00:00.000000Z", "custom_virtualenv":null, "description":"test-org-desc", "id":1, "max_hosts":3, "modified":"2018-02-01T08:00:00.000000Z", "name":"test-org", "related":{ "access_list":"/api/v2/organizations/1/access_list/", "activity_stream":"/api/v2/organizations/1/activity_stream/", "admins":"/api/v2/organizations/1/admins/", "applications":"/api/v2/organizations/1/applications/", "credentials":"/api/v2/organizations/1/credentials/", "galaxy_credentials":"/api/v2/organizations/1/galaxy_credentials/", "instance_groups":"/api/v2/organizations/1/instance_groups/", "inventories":"/api/v2/organizations/1/inventories/", "job_templates":"/api/v2/organizations/1/job_templates/", "notification_templates":"/api/v2/organizations/1/notification_templates/", "notification_templates_approvals":"/api/v2/organizations/1/notification_templates_approvals/", "notification_templates_error":"/api/v2/organizations/1/notification_templates_error/", "notification_templates_started":"/api/v2/organizations/1/notification_templates_started/", "notification_templates_success":"/api/v2/organizations/1/notification_templates_success/", "object_roles":"/api/v2/organizations/1/object_roles/", "projects":"/api/v2/organizations/1/projects/", "teams":"/api/v2/organizations/1/teams/", "users":"/api/v2/organizations/1/users/", "workflow_job_templates":"/api/v2/organizations/1/workflow_job_templates/" }, "summary_fields":{ "object_roles":{ "admin_role":{ "description":"Can manage all aspects of the organization", "id":1, "name":"Admin", "user_only":true }, "approval_role":{ "description":"Can approve or deny a workflow approval node", "id":12, "name":"Approve" }, "auditor_role":{ "description":"Can view all aspects of the organization", "id":9, "name":"Auditor" }, "credential_admin_role":{ "description":"Can manage all credentials of the organization", "id":5, "name":"Credential Admin" }, "execute_role":{ "description":"May run any executable resources in the organization", "id":2, "name":"Execute" }, "inventory_admin_role":{ "description":"Can manage all inventories of the organization", "id":4, "name":"Inventory Admin" }, "job_template_admin_role":{ "description":"Can manage all job templates of the organization", "id":8, "name":"Job Template Admin" }, "member_role":{ "description":"User is a member of the organization", "id":10, "name":"Member", "user_only":true }, "notification_admin_role":{ "description":"Can manage all notifications of the organization", "id":7, "name":"Notification Admin" }, "project_admin_role":{ "description":"Can manage all projects of the organization", "id":3, "name":"Project Admin" }, "read_role":{ "description":"May view settings for the organization", "id":11, "name":"Read" }, "workflow_admin_role":{ "description":"Can manage all workflows of the organization", "id":6, "name":"Workflow Admin" } }, "related_field_counts":{ "admins":0, "inventories":0, "job_templates":0, "projects":0, "teams":0, "users":0 }, "user_capabilities":{ "delete":true, "edit":true } }, "type":"organization", "url":"/api/v2/organizations/1/" } } }, "400":{ "examples":{ "application/json":{ "__all__":[ "Cannot change max_hosts." ] } }, "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"You do not have permission to perform this action." } }, "description":"" } }, "summary":" Update an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}--put", "x-filename-id":"api-v2-organizations-id-put" } }, "/api/v2/organizations/{id}/access_list/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nusers.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nadmin users associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of admin users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more admin user records.
Each admin user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that admin users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following admin user\nfields to create a new admin user associated with this\norganization.
\nusername: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)first_name: (string, default=\"\")last_name: (string, default=\"\")email: (string, default=\"\")is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)is_system_auditor: (boolean, default=False)password: Write-only field used to change the password. (string, default=\"\")Make a POST request to this resource with only an id field to associate an\nexisting admin user with this organization.
Make a POST request to this resource with id and disassociate fields to\nremove the admin user from this organization\n without deleting the admin user.
Make a GET request to this resource to retrieve a list of\napplications associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of applications\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more application records.
Each application data structure includes the following fields:
\nid: Database ID for this application. (integer)type: Data type for this application. (choice)url: URL for this application. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this application was created. (datetime)modified: Timestamp when this application was last modified. (datetime)name: Name of this application. (string)description: Optional description of this application. (string)client_id: (string)client_secret: Used for more stringent verification of access to an application when creating a token. (string)client_type: Set to Public or Confidential depending on how secure the client device is. (choice)confidential: Confidentialpublic: Publicredirect_uris: Allowed URIs list, space separated (string)authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice)authorization-code: Authorization codepassword: Resource owner password-basedskip_authorization: Set True to skip authorization step for completely trusted applications. (boolean)organization: Organization containing this application. (id)To specify that applications are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following application\nfields to create a new application associated with this\norganization.
\nname: Name of this application. (string, required)description: Optional description of this application. (string, default=\"\")
client_type: Set to Public or Confidential depending on how secure the client device is. (choice, required)
confidential: Confidentialpublic: Publicredirect_uris: Allowed URIs list, space separated (string, default=\"\")authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice, required)authorization-code: Authorization codepassword: Resource owner password-basedskip_authorization: Set True to skip authorization step for completely trusted applications. (boolean, default=False)Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential\nfields to create a new credential associated with this\norganization.
\nname: Name of this credential. (string, required)description: Optional description of this credential. (string, default=\"\")
credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)
inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: (id)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential\nfields to create a new credential associated with this\norganization.
\nname: Name of this credential. (string, required)description: Optional description of this credential. (string, default=\"\")organization: (id, default=None)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)
inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
Make a POST request to this resource with only an id field to associate an\nexisting credential with this organization.
Make a POST request to this resource with id and disassociate fields to\nremove the credential from this organization\n without deleting the credential.
Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of instance groups\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more instance group records.
Each instance group data structure includes the following fields:
\nid: Database ID for this instance group. (integer)type: Data type for this instance group. (choice)url: URL for this instance group. (string)related: Data structure with URLs of related resources. (object)name: Name of this instance group. (string)created: Timestamp when this instance group was created. (datetime)modified: Timestamp when this instance group was last modified. (datetime)capacity: (field)committed_capacity: (field)consumed_capacity: (field)percent_capacity_remaining: (field)jobs_running: Count of jobs in the running or waiting state that are targeted for this instance group (integer)jobs_total: Count of all jobs that target this instance group (integer)instances: (field)controller: Instance Group to remotely control this group. (id)is_controller: Indicates whether instance group controls any other group (boolean)is_isolated: Indicates whether instances in this group are isolated.Isolated groups have a designated controller group. (boolean)is_containerized: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)credential: (id)policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)policy_instance_list: List of exact-match Instances that will be assigned to this group (json)pod_spec_override: (string)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following instance group\nfields to create a new instance group associated with this\norganization.
\nname: Name of this instance group. (string, required)
credential: (id, default=``)
policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)pod_spec_override: (string, default=\"\")Make a POST request to this resource with only an id field to associate an\nexisting instance group with this organization.
Make a POST request to this resource with id and disassociate fields to\nremove the instance group from this organization\n without deleting the instance group.
Make a GET request to this resource to retrieve a list of\ninventories associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of inventories\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more inventory records.
Each inventory data structure includes the following fields:
\nid: Database ID for this inventory. (integer)type: Data type for this inventory. (choice)url: URL for this inventory. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory was created. (datetime)modified: Timestamp when this inventory was last modified. (datetime)name: Name of this inventory. (string)description: Optional description of this inventory. (string)organization: Organization containing this inventory. (id)kind: Kind of inventory being represented. (choice)\"\": Hosts have a direct link to this inventory.smart: Hosts for inventory generated using the host_filter property.host_filter: Filter that will be applied to the hosts of this inventory. (string)variables: Inventory variables in JSON or YAML format. (json)has_active_failures: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)hosts_with_active_failures: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)has_inventory_sources: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)insights_credential: Credentials to be used by hosts belonging to this inventory when accessing Red Hat Insights API. (id)pending_deletion: Flag indicating the inventory is being deleted. (boolean)To specify that inventories are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\njob templates associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of job templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more job template records.
Each job template data structure includes the following fields:
\nid: Database ID for this job template. (integer)type: Data type for this job template. (choice)url: URL for this job template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job template was created. (datetime)modified: Timestamp when this job template was last modified. (datetime)name: Name of this job template. (string)description: Optional description of this job template. (string)job_type: (choice)run: Runcheck: Checkinventory: (id)project: (id)playbook: (string)scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)forks: (integer)limit: (string)verbosity: (choice)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (json)job_tags: (string)force_handlers: (boolean)skip_tags: (string)start_at_task: (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)use_fact_cache: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)organization: The organization used to determine access to this template. (id)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedhost_config_key: (string)ask_scm_branch_on_launch: (boolean)ask_diff_mode_on_launch: (boolean)ask_variables_on_launch: (boolean)ask_limit_on_launch: (boolean)ask_tags_on_launch: (boolean)ask_skip_tags_on_launch: (boolean)ask_job_type_on_launch: (boolean)ask_verbosity_on_launch: (boolean)ask_inventory_on_launch: (boolean)ask_credential_on_launch: (boolean)survey_enabled: (boolean)become_enabled: (boolean)diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)allow_simultaneous: (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)job_slice_count: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)To specify that job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following job template\nfields to create a new job template associated with this\norganization.
\nname: Name of this job template. (string, required)description: Optional description of this job template. (string, default=\"\")job_type: (choice)run: Run (default)check: Checkinventory: (id, default=``)project: (id, default=``)playbook: (string, default=\"\")scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=\"\")forks: (integer, default=0)limit: (string, default=\"\")verbosity: (choice)0: 0 (Normal) (default)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)extra_vars: (json, default=``)job_tags: (string, default=\"\")force_handlers: (boolean, default=False)skip_tags: (string, default=\"\")start_at_task: (string, default=\"\")timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)use_fact_cache: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=False)
host_config_key: (string, default=\"\")
ask_scm_branch_on_launch: (boolean, default=False)ask_diff_mode_on_launch: (boolean, default=False)ask_variables_on_launch: (boolean, default=False)ask_limit_on_launch: (boolean, default=False)ask_tags_on_launch: (boolean, default=False)ask_skip_tags_on_launch: (boolean, default=False)ask_job_type_on_launch: (boolean, default=False)ask_verbosity_on_launch: (boolean, default=False)ask_inventory_on_launch: (boolean, default=False)ask_credential_on_launch: (boolean, default=False)survey_enabled: (boolean, default=False)become_enabled: (boolean, default=False)diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=False)allow_simultaneous: (boolean, default=False)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")job_slice_count: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=1)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\norganization.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")
notification_type: (choice, required)
email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with id and disassociate fields to\ndelete the associated notification template.
{\n \"id\": 123,\n \"disassociate\": true\n}\nMake a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\norganization.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this organization.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this organization\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\norganization.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this organization.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this organization\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\norganization.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this organization.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this organization\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\norganization.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this organization.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this organization\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nroles associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nprojects associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of projects\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more project records.
Each project data structure includes the following fields:
\nid: Database ID for this project. (integer)type: Data type for this project. (choice)url: URL for this project. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this project was created. (datetime)modified: Timestamp when this project was last modified. (datetime)name: Name of this project. (string)description: Optional description of this project. (string)local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)scm_type: Specifies the source control system used to store the project. (choice)\"\": Manualgit: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: Remote Archivescm_url: The location where the project is stored. (string)scm_branch: Specific branch, tag or commit to checkout. (string)scm_refspec: For git projects, an additional refspec to fetch. (string)scm_clean: Discard any local changes before syncing the project. (boolean)scm_delete_on_update: Delete the project before syncing. (boolean)credential: (id)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)scm_revision: The last revision fetched by a project update (string)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedok: OKmissing: Missingorganization: The organization used to determine access to this template. (id)scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean)scm_update_cache_timeout: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)last_update_failed: (boolean)last_updated: (datetime)To specify that projects are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following project\nfields to create a new project associated with this\norganization.
\nname: Name of this project. (string, required)description: Optional description of this project. (string, default=\"\")local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=\"\")scm_type: Specifies the source control system used to store the project. (choice)\"\": Manual (default)git: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: Remote Archivescm_url: The location where the project is stored. (string, default=\"\")scm_branch: Specific branch, tag or commit to checkout. (string, default=\"\")scm_refspec: For git projects, an additional refspec to fetch. (string, default=\"\")scm_clean: Discard any local changes before syncing the project. (boolean, default=False)scm_delete_on_update: Delete the project before syncing. (boolean, default=False)credential: (id, default=``)timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)
scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean, default=False)
scm_update_cache_timeout: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=0)allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=False)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")Make a GET request to this resource to retrieve a list of\nteams associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of teams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more team records.
Each team data structure includes the following fields:
\nid: Database ID for this team. (integer)type: Data type for this team. (choice)url: URL for this team. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this team was created. (datetime)modified: Timestamp when this team was last modified. (datetime)name: Name of this team. (string)description: Optional description of this team. (string)organization: (id)To specify that teams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following team\nfields to create a new team associated with this\norganization.
\nname: Name of this team. (string, required)description: Optional description of this team. (string, default=\"\")Make a POST request to this resource with id and disassociate fields to\ndelete the associated team.
{\n \"id\": 123,\n \"disassociate\": true\n}\nMake a GET request to this resource to retrieve a list of\nusers associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following user\nfields to create a new user associated with this\norganization.
\nusername: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)first_name: (string, default=\"\")last_name: (string, default=\"\")email: (string, default=\"\")is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)is_system_auditor: (boolean, default=False)password: Write-only field used to change the password. (string, default=\"\")Make a POST request to this resource with only an id field to associate an\nexisting user with this organization.
Make a POST request to this resource with id and disassociate fields to\nremove the user from this organization\n without deleting the user.
Make a GET request to this resource to retrieve a list of\nworkflow job templates associated with the selected\norganization.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow job templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job template records.
Each workflow job template data structure includes the following fields:
\nid: Database ID for this workflow job template. (integer)type: Data type for this workflow job template. (choice)url: URL for this workflow job template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job template was created. (datetime)modified: Timestamp when this workflow job template was last modified. (datetime)name: Name of this workflow job template. (string)description: Optional description of this workflow job template. (string)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedok: OKmissing: Missingnone: No External Sourceupdating: Updatingextra_vars: (json)organization: The organization used to determine access to this template. (id)survey_enabled: (boolean)allow_simultaneous: (boolean)ask_variables_on_launch: (boolean)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)limit: (string)scm_branch: (string)ask_inventory_on_launch: (boolean)ask_scm_branch_on_launch: (boolean)ask_limit_on_launch: (boolean)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)To specify that workflow job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following workflow job template\nfields to create a new workflow job template associated with this\norganization.
\nname: Name of this workflow job template. (string, required)description: Optional description of this workflow job template. (string, default=\"\")
extra_vars: (json, 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: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)Everything returned here should be considered public / insecure, as\nthis requires no auth and is intended for use by the installer process.
", "operationId":"System Configuration_ping_list", "parameters":[ ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "active_node":"awx", "ha":false, "install_uuid":"00000000-0000-0000-0000-000000000000", "instance_groups":[ ], "instances":[ ], "version":"15.0.1" } } } }, "summary":"Return Some Basic Information About This Instance", "tags":[ "System Configuration" ], "x-internal-id":"api-v2-ping--get", "x-filename-id":"api-v2-ping-get" } }, "/api/v2/project_updates/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nproject updates.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of project updates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more project update records.
Each project update data structure includes the following fields:
\nid: Database ID for this project update. (integer)type: Data type for this project update. (choice)url: URL for this project update. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this project update was created. (datetime)modified: Timestamp when this project update was last modified. (datetime)name: Name of this project update. (string)description: Optional description of this project update. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)scm_type: Specifies the source control system used to store the project. (choice)\"\": Manualgit: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: Remote Archivescm_url: The location where the project is stored. (string)scm_branch: Specific branch, tag or commit to checkout. (string)scm_refspec: For git projects, an additional refspec to fetch. (string)scm_clean: Discard any local changes before syncing the project. (boolean)scm_delete_on_update: Delete the project before syncing. (boolean)credential: (id)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)scm_revision: The SCM Revision discovered by this update for the given project and branch. (string)project: (id)job_type: (choice)run: Runcheck: Checkjob_tags: Parts of the project update playbook that will be run. (string)To specify that project updates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a DELETE request to this resource to delete this project update.
", "operationId":"Project Updates_project_updates_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"Cannot delete running job resource." } }, "description":"" } }, "summary":" Delete a Project Update", "tags":[ "Project Updates" ], "x-internal-id":"api-v2-project_updates-{id}--delete", "x-filename-id":"api-v2-project_updates-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single project update\nrecord containing the following fields:
\nid: Database ID for this project update. (integer)type: Data type for this project update. (choice)url: URL for this project update. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this project update was created. (datetime)modified: Timestamp when this project update was last modified. (datetime)name: Name of this project update. (string)description: Optional description of this project update. (string)local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)scm_type: Specifies the source control system used to store the project. (choice)\"\": Manualgit: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: Remote Archivescm_url: The location where the project is stored. (string)scm_branch: Specific branch, tag or commit to checkout. (string)scm_refspec: For git projects, an additional refspec to fetch. (string)scm_clean: Discard any local changes before syncing the project. (boolean)scm_delete_on_update: Delete the project before syncing. (boolean)credential: (id)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)scm_revision: The SCM Revision discovered by this update for the given project and branch. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_args: (string)job_cwd: (string)job_env: (json)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)result_traceback: (string)event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)project: (id)job_type: (choice)run: Runcheck: Checkjob_tags: Parts of the project update playbook that will be run. (string)host_status_counts: A count of hosts uniquely assigned to each status. (field)playbook_counts: A count of all plays and tasks for the job run. (field)Make a GET request to this resource to determine if the project update can be\ncanceled. The response will include the following field:
\ncan_cancel: Indicates whether this update can be canceled (boolean,\n read-only)Make a POST request to this resource to cancel a pending or running project\nupdate. The response status code will be 202 if successful, or 405 if the\nupdate cannot be canceled.
", "operationId":"Project Updates_project_updates_cancel_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":" Cancel Project Update", "tags":[ "Project Updates" ], "x-internal-id":"api-v2-project_updates-{id}-cancel--get", "x-filename-id":"api-v2-project_updates-id-cancel-get" }, "post":{ "description":"Make a GET request to this resource to determine if the project update can be\ncanceled. The response will include the following field:
\ncan_cancel: Indicates whether this update can be canceled (boolean,\n read-only)Make a POST request to this resource to cancel a pending or running project\nupdate. The response status code will be 202 if successful, or 405 if the\nupdate cannot be canceled.
", "operationId":"Project Updates_project_updates_cancel_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "responses":{ "201":{ "description":"" } }, "summary":" Cancel Project Update", "tags":[ "Project Updates" ], "x-internal-id":"api-v2-project_updates-{id}-cancel--post", "x-filename-id":"api-v2-project_updates-id-cancel-post" } }, "/api/v2/project_updates/{id}/events/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nproject update events associated with the selected\nproject update.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of project update events\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more project update event records.
Each project update event data structure includes the following fields:
\nid: Database ID for this project update event. (integer)type: Data type for this project update event. (choice)url: URL for this project update event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this project update event was created. (datetime)modified: Timestamp when this project update event was last modified. (datetime)event: (choice)runner_on_failed: Host Failedrunner_on_start: Host Startedrunner_on_ok: Host OKrunner_on_error: Host Failurerunner_on_skipped: Host Skippedrunner_on_unreachable: Host Unreachablerunner_on_no_hosts: No Hosts Remainingrunner_on_async_poll: Host Pollingrunner_on_async_ok: Host Async OKrunner_on_async_failed: Host Async Failurerunner_item_on_ok: Item OKrunner_item_on_failed: Item Failedrunner_item_on_skipped: Item Skippedrunner_retry: Host Retryrunner_on_file_diff: File Differenceplaybook_on_start: Playbook Startedplaybook_on_notify: Running Handlersplaybook_on_include: Including Fileplaybook_on_no_hosts_matched: No Hosts Matchedplaybook_on_no_hosts_remaining: No Hosts Remainingplaybook_on_task_start: Task Startedplaybook_on_vars_prompt: Variables Promptedplaybook_on_setup: Gathering Factsplaybook_on_import_for_host: internal: on Import for Hostplaybook_on_not_import_for_host: internal: on Not Import for Hostplaybook_on_play_start: Play Startedplaybook_on_stats: Playbook Completedebug: Debugverbose: Verbosedeprecated: Deprecatedwarning: Warningsystem_warning: System Warningerror: Errorcounter: (integer)event_display: (string)event_data: (json)event_level: (integer)failed: (boolean)changed: (boolean)uuid: (string)host_name: (field)playbook: (string)play: (string)task: (string)role: (string)stdout: (field)start_line: (integer)end_line: (integer)verbosity: (integer)project_update: (id)To specify that project update events are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nproject update.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notifications\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification records.
Each notification data structure includes the following fields:
\nid: Database ID for this notification. (integer)type: Data type for this notification. (choice)url: URL for this notification. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification was created. (datetime)modified: Timestamp when this notification was last modified. (datetime)notification_template: (id)error: (string)status: (choice)pending: Pendingsuccessful: Successfulfailed: Failednotifications_sent: (integer)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhookrecipients: (string)subject: (string)body: Notification body (json)To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\ninventory updates associated with the selected\nproject update.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of inventory updates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more inventory update records.
Each inventory update data structure includes the following fields:
\nid: Database ID for this inventory update. (integer)type: Data type for this inventory update. (choice)url: URL for this inventory update. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory update was created. (datetime)modified: Timestamp when this inventory update was last modified. (datetime)name: Name of this inventory update. (string)description: Optional description of this inventory update. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string)source_script: (id)source_vars: Inventory source variables in YAML or JSON format. (string)credential: Cloud credential to use for inventory updates. (integer)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string)host_filter: Regex where only matching hosts will be imported into Tower. (string)overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)overwrite_vars: Overwrite local variables from remote inventory source. (boolean)custom_virtualenv: (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)verbosity: (choice)0: 0 (WARNING)1: 1 (INFO)2: 2 (DEBUG)inventory: (id)inventory_source: (id)license_error: (boolean)org_host_limit_error: (boolean)source_project_update: Inventory files from this Project Update were used for the inventory update. (id)To specify that inventory updates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve the stdout from running this\nproject update.
\nUse the format query string parameter to specify the output format.
?format=api?format=html?format=txt?format=ansi?format=json?format=txt_download?format=ansi_download(New in Ansible Tower 2.0.0) When using the Browsable API, HTML and JSON\nformats, the start_line and end_line query string parameters can be used\nto specify a range of line numbers to retrieve.
Use dark=1 or dark=0 as a query string parameter to force or disable a\ndark background.
Files over 1.0??MB (configurable)\nwill not display in the browser. Use the txt_download or ansi_download\nformats to download the file directly to view it.
Make a GET request to this resource to retrieve the list of\nprojects.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of projects\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more project records.
Each project data structure includes the following fields:
\nid: Database ID for this project. (integer)type: Data type for this project. (choice)url: URL for this project. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this project was created. (datetime)modified: Timestamp when this project was last modified. (datetime)name: Name of this project. (string)description: Optional description of this project. (string)local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)scm_type: Specifies the source control system used to store the project. (choice)\"\": Manualgit: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: Remote Archivescm_url: The location where the project is stored. (string)scm_branch: Specific branch, tag or commit to checkout. (string)scm_refspec: For git projects, an additional refspec to fetch. (string)scm_clean: Discard any local changes before syncing the project. (boolean)scm_delete_on_update: Delete the project before syncing. (boolean)credential: (id)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)scm_revision: The last revision fetched by a project update (string)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedok: OKmissing: Missingorganization: The organization used to determine access to this template. (id)scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean)scm_update_cache_timeout: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)last_update_failed: (boolean)last_updated: (datetime)To specify that projects are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following project\nfields to create a new project:
\nname: Name of this project. (string, required)description: Optional description of this project. (string, default=\"\")local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=\"\")scm_type: Specifies the source control system used to store the project. (choice)\"\": Manual (default)git: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: Remote Archivescm_url: The location where the project is stored. (string, default=\"\")scm_branch: Specific branch, tag or commit to checkout. (string, default=\"\")scm_refspec: For git projects, an additional refspec to fetch. (string, default=\"\")scm_clean: Discard any local changes before syncing the project. (boolean, default=False)scm_delete_on_update: Delete the project before syncing. (boolean, default=False)credential: (id, default=``)timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)
organization: The organization used to determine access to this template. (id, default=``)
scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean, default=False)scm_update_cache_timeout: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=0)allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=False)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")Make a DELETE request to this resource to delete this project.
", "operationId":"Projects_projects_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}--delete", "x-filename-id":"api-v2-projects-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single project\nrecord containing the following fields:
\nid: Database ID for this project. (integer)type: Data type for this project. (choice)url: URL for this project. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this project was created. (datetime)modified: Timestamp when this project was last modified. (datetime)name: Name of this project. (string)description: Optional description of this project. (string)local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)scm_type: Specifies the source control system used to store the project. (choice)\"\": Manualgit: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: Remote Archivescm_url: The location where the project is stored. (string)scm_branch: Specific branch, tag or commit to checkout. (string)scm_refspec: For git projects, an additional refspec to fetch. (string)scm_clean: Discard any local changes before syncing the project. (boolean)scm_delete_on_update: Delete the project before syncing. (boolean)credential: (id)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)scm_revision: The last revision fetched by a project update (string)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedok: OKmissing: Missingorganization: The organization used to determine access to this template. (id)scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean)scm_update_cache_timeout: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)last_update_failed: (boolean)last_updated: (datetime)Make a PUT or PATCH request to this resource to update this\nproject. The following fields may be modified:
\nname: Name of this project. (string, required)description: Optional description of this project. (string, default=\"\")local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=\"\")scm_type: Specifies the source control system used to store the project. (choice)\"\": Manual (default)git: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: Remote Archivescm_url: The location where the project is stored. (string, default=\"\")scm_branch: Specific branch, tag or commit to checkout. (string, default=\"\")scm_refspec: For git projects, an additional refspec to fetch. (string, default=\"\")scm_clean: Discard any local changes before syncing the project. (boolean, default=False)scm_delete_on_update: Delete the project before syncing. (boolean, default=False)credential: (id, default=``)timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)
organization: The organization used to determine access to this template. (id, default=``)
scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean, default=False)scm_update_cache_timeout: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=0)allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=False)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")For a PATCH request, include only the fields that are being modified.
", "operationId":"Projects_projects_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "name":"foooooo" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "allow_override":false, "created":"2018-02-01T08:00:00.000000Z", "credential":null, "custom_virtualenv":null, "description":"", "id":1, "last_job_failed":false, "last_job_run":null, "last_update_failed":false, "last_updated":null, "local_path":"", "modified":"2018-02-01T08:00:00.000000Z", "name":"foooooo", "next_job_run":null, "organization":1, "related":{ "access_list":"/api/v2/projects/1/access_list/", "activity_stream":"/api/v2/projects/1/activity_stream/", "copy":"/api/v2/projects/1/copy/", "inventory_files":"/api/v2/projects/1/inventories/", "notification_templates_error":"/api/v2/projects/1/notification_templates_error/", "notification_templates_started":"/api/v2/projects/1/notification_templates_started/", "notification_templates_success":"/api/v2/projects/1/notification_templates_success/", "object_roles":"/api/v2/projects/1/object_roles/", "organization":"/api/v2/organizations/1/", "playbooks":"/api/v2/projects/1/playbooks/", "project_updates":"/api/v2/projects/1/project_updates/", "schedules":"/api/v2/projects/1/schedules/", "scm_inventory_sources":"/api/v2/projects/1/scm_inventory_sources/", "teams":"/api/v2/projects/1/teams/", "update":"/api/v2/projects/1/update/" }, "scm_branch":"", "scm_clean":false, "scm_delete_on_update":false, "scm_refspec":"", "scm_revision":"", "scm_type":"", "scm_update_cache_timeout":0, "scm_update_on_launch":false, "scm_url":"", "status":"missing", "summary_fields":{ "object_roles":{ "admin_role":{ "description":"Can manage all aspects of the project", "id":15, "name":"Admin" }, "read_role":{ "description":"May view settings for the project", "id":18, "name":"Read" }, "update_role":{ "description":"May update the project", "id":17, "name":"Update" }, "use_role":{ "description":"Can use the project in a job template", "id":16, "name":"Use" } }, "organization":{ "description":"test-org-desc", "id":1, "name":"test-org" }, "user_capabilities":{ "copy":false, "delete":true, "edit":true, "schedule":false, "start":false } }, "timeout":0, "type":"project", "url":"/api/v2/projects/1/" } } }, "400":{ "examples":{ "application/json":{ "allow_override":[ "One or more job templates depend on branch override behavior for this project (ids: 2)." ] } }, "description":"" } }, "summary":" Update a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}--patch", "x-filename-id":"api-v2-projects-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\nproject. The following fields may be modified:
\nname: Name of this project. (string, required)description: Optional description of this project. (string, default=\"\")local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=\"\")scm_type: Specifies the source control system used to store the project. (choice)\"\": Manual (default)git: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: Remote Archivescm_url: The location where the project is stored. (string, default=\"\")scm_branch: Specific branch, tag or commit to checkout. (string, default=\"\")scm_refspec: For git projects, an additional refspec to fetch. (string, default=\"\")scm_clean: Discard any local changes before syncing the project. (boolean, default=False)scm_delete_on_update: Delete the project before syncing. (boolean, default=False)credential: (id, default=``)timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)
organization: The organization used to determine access to this template. (id, default=``)
scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean, default=False)scm_update_cache_timeout: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=0)allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=False)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string, default=\"\")For a PUT request, include all fields in the request.
", "operationId":"Projects_projects_update_0", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "allow_override":{ "description":"Allow changing the SCM branch or revision in a job template that uses this project.", "type":"boolean" }, "credential":{ "description":"", "type":"integer" }, "custom_virtualenv":{ "description":"Local absolute file path containing a custom Python virtualenv to use", "type":"string" }, "description":{ "description":"", "type":"string" }, "local_path":{ "description":"Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", "type":"string" }, "name":{ "description":"", "type":"string" }, "organization":{ "description":"The organization used to determine access to this template.", "type":"integer" }, "scm_branch":{ "description":"Specific branch, tag or commit to checkout.", "type":"string" }, "scm_clean":{ "description":"Discard any local changes before syncing the project.", "type":"boolean" }, "scm_delete_on_update":{ "description":"Delete the project before syncing.", "type":"boolean" }, "scm_refspec":{ "description":"For git projects, an additional refspec to fetch.", "type":"string" }, "scm_type":{ "description":"Specifies the source control system used to store the project.", "type":"string" }, "scm_update_cache_timeout":{ "description":"The number of seconds after the last project update ran that a new project update will be launched as a job dependency.", "type":"integer" }, "scm_update_on_launch":{ "description":"Update the project when a job is launched that uses the project.", "type":"boolean" }, "scm_url":{ "description":"The location where the project is stored.", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) to run before the task is canceled.", "type":"integer" } }, "required":[ "name" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}--put", "x-filename-id":"api-v2-projects-id-put" } }, "/api/v2/projects/{id}/access_list/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nusers.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nproject.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single project\nrecord containing the following fields:
\ninventory_files: Array of inventory files and directories available within this project, not comprehensive. (json)Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nproject.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this project.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this project\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nproject.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this project.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this project\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nproject.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this project.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this project\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nroles associated with the selected\nproject.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a list of playbooks available\nfor a project.
", "operationId":"Projects_projects_playbooks_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":" Retrieve Project Playbooks", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-playbooks--get", "x-filename-id":"api-v2-projects-id-playbooks-get" } }, "/api/v2/projects/{id}/project_updates/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nproject updates associated with the selected\nproject.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of project updates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more project update records.
Each project update data structure includes the following fields:
\nid: Database ID for this project update. (integer)type: Data type for this project update. (choice)url: URL for this project update. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this project update was created. (datetime)modified: Timestamp when this project update was last modified. (datetime)name: Name of this project update. (string)description: Optional description of this project update. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)scm_type: Specifies the source control system used to store the project. (choice)\"\": Manualgit: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: Remote Archivescm_url: The location where the project is stored. (string)scm_branch: Specific branch, tag or commit to checkout. (string)scm_refspec: For git projects, an additional refspec to fetch. (string)scm_clean: Discard any local changes before syncing the project. (boolean)scm_delete_on_update: Delete the project before syncing. (boolean)credential: (id)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)scm_revision: The SCM Revision discovered by this update for the given project and branch. (string)project: (id)job_type: (choice)run: Runcheck: Checkjob_tags: Parts of the project update playbook that will be run. (string)To specify that project updates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nschedules associated with the selected\nproject.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of schedules\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more schedule records.
Each schedule data structure includes the following fields:
\nrrule: A value representing the schedules iCal recurrence rule. (string)id: Database ID for this schedule. (integer)type: Data type for this schedule. (choice)url: URL for this schedule. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this schedule was created. (datetime)modified: Timestamp when this schedule was last modified. (datetime)name: Name of this schedule. (string)description: Optional description of this schedule. (string)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)unified_job_template: (id)enabled: Enables processing of this schedule. (boolean)dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)next_run: The next time that the scheduled action will run. (datetime)timezone: (field)until: (field)To specify that schedules are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following schedule\nfields to create a new schedule associated with this\nproject.
\nrrule: A value representing the schedules iCal recurrence rule. (string, required)
name: Name of this schedule. (string, required)
description: Optional description of this schedule. (string, default=\"\")extra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)
None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)enabled: Enables processing of this schedule. (boolean, default=True)
POST requests to this resource must include a proper rrule value following\na particular format and conforming to subset of allowed rules.
The following lists the expected format and details of our rrules:
\nHere are some example rrules:
\n\"DTSTART:20500331T055000Z RRULE:FREQ=MINUTELY;INTERVAL=10;COUNT=5\"\n\"DTSTART:20240331T075000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MINUTELY;INTERVAL=1;UNTIL=20230401T075000Z\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=5;BYDAY=MO\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=6\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=4;BYDAY=SU\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR,SA,SU\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=4;BYMONTHDAY=1\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYSETPOS=-1;BYMONTH=8;BYDAY=SU\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;UNTIL=20230401T075000Z;BYDAY=MO,WE,FR\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=HOURLY;INTERVAL=1;UNTIL=20230610T075000Z\"\nMake a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\nproject.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of inventory sources\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more inventory source records.
Each inventory source data structure includes the following fields:
\nid: Database ID for this inventory source. (integer)type: Data type for this inventory source. (choice)url: URL for this inventory source. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this inventory source was created. (datetime)modified: Timestamp when this inventory source was last modified. (datetime)name: Name of this inventory source. (string)description: Optional description of this inventory source. (string)source: (choice)file: File, Directory or Scriptscm: Sourced from a Projectec2: Amazon EC2gce: Google Compute Engineazure_rm: Microsoft Azure Resource Managervmware: VMware vCentersatellite6: Red Hat Satellite 6openstack: OpenStackrhv: Red Hat Virtualizationtower: Ansible Towercustom: Custom Scriptsource_path: (string)source_script: (id)source_vars: Inventory source variables in YAML or JSON format. (string)credential: Cloud credential to use for inventory updates. (integer)enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported into Tower. If the key is not found then the host will be enabled (string)host_filter: Regex where only matching hosts will be imported into Tower. (string)overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)overwrite_vars: Overwrite local variables from remote inventory source. (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)verbosity: (choice)0: 0 (WARNING)1: 1 (INFO)2: 2 (DEBUG)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatednone: No External Sourceinventory: (id)update_on_launch: (boolean)update_cache_timeout: (integer)source_project: Project containing inventory file used as source. (id)update_on_project_update: (boolean)last_update_failed: (boolean)last_updated: (datetime)To specify that inventory sources are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\nteams.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of teams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more team records.
Each team data structure includes the following fields:
\nid: Database ID for this team. (integer)type: Data type for this team. (choice)url: URL for this team. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this team was created. (datetime)modified: Timestamp when this team was last modified. (datetime)name: Name of this team. (string)description: Optional description of this team. (string)organization: (id)To specify that teams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to determine if the project can be updated\nfrom its SCM source. The response will include the following field:
\ncan_update: Flag indicating if this project can be updated (boolean,\n read-only)Make a POST request to this resource to update the project. If the project\ncannot be updated, a 405 status code will be returned.
", "operationId":"Projects_projects_update_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":" Update Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-update--get", "x-filename-id":"api-v2-projects-id-update-get" }, "post":{ "description":"Make a GET request to this resource to determine if the project can be updated\nfrom its SCM source. The response will include the following field:
\ncan_update: Flag indicating if this project can be updated (boolean,\n read-only)Make a POST request to this resource to update the project. If the project\ncannot be updated, a 405 status code will be returned.
", "operationId":"Projects_projects_update_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "responses":{ "201":{ "description":"" } }, "summary":" Update Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-update--post", "x-filename-id":"api-v2-projects-id-update-post" } }, "/api/v2/roles/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nroles.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single role\nrecord containing the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)Make a GET request to this resource to retrieve a list of\nroles associated with the selected\nrole.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\nrole.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nteams associated with the selected\nrole.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of teams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more team records.
Each team data structure includes the following fields:
\nid: Database ID for this team. (integer)type: Data type for this team. (choice)url: URL for this team. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this team was created. (datetime)modified: Timestamp when this team was last modified. (datetime)name: Name of this team. (string)description: Optional description of this team. (string)organization: (id)To specify that teams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following team\nfields to create a new team associated with this\nrole.
\nname: Name of this team. (string, required)description: Optional description of this team. (string, default=\"\")organization: (id, required)Make a POST request to this resource with only an id field to associate an\nexisting team with this role.
Make a POST request to this resource with id and disassociate fields to\nremove the team from this role\n without deleting the team.
Make a GET request to this resource to retrieve a list of\nusers associated with the selected\nrole.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following user\nfields to create a new user associated with this\nrole.
\nusername: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)first_name: (string, default=\"\")last_name: (string, default=\"\")email: (string, default=\"\")is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)is_system_auditor: (boolean, default=False)password: Write-only field used to change the password. (string, default=\"\")Make a POST request to this resource with only an id field to associate an\nexisting user with this role.
Make a POST request to this resource with id and disassociate fields to\nremove the user from this role\n without deleting the user.
Make a GET request to this resource to retrieve the list of\nschedules.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of schedules\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more schedule records.
Each schedule data structure includes the following fields:
\nrrule: A value representing the schedules iCal recurrence rule. (string)id: Database ID for this schedule. (integer)type: Data type for this schedule. (choice)url: URL for this schedule. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this schedule was created. (datetime)modified: Timestamp when this schedule was last modified. (datetime)name: Name of this schedule. (string)description: Optional description of this schedule. (string)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)unified_job_template: (id)enabled: Enables processing of this schedule. (boolean)dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)next_run: The next time that the scheduled action will run. (datetime)timezone: (field)until: (field)To specify that schedules are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\n================\nThe following lists the expected format and details of our rrules:
\nHere are some example rrules:
\n\"DTSTART:20500331T055000Z RRULE:FREQ=MINUTELY;INTERVAL=10;COUNT=5\"\n\"DTSTART:20240331T075000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MINUTELY;INTERVAL=1;UNTIL=20230401T075000Z\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=5;BYDAY=MO\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=6\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=4;BYDAY=SU\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR,SA,SU\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=4;BYMONTHDAY=1\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYSETPOS=-1;BYMONTH=8;BYDAY=SU\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;UNTIL=20230401T075000Z;BYDAY=MO,WE,FR\"\n\"DTSTART:20140331T075000Z RRULE:FREQ=HOURLY;INTERVAL=1;UNTIL=20230610T075000Z\"\nMake a DELETE request to this resource to delete this schedule.
", "operationId":"Schedules_schedules_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete a Schedule", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules-{id}--delete", "x-filename-id":"api-v2-schedules-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single schedule\nrecord containing the following fields:
\nrrule: A value representing the schedules iCal recurrence rule. (string)id: Database ID for this schedule. (integer)type: Data type for this schedule. (choice)url: URL for this schedule. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this schedule was created. (datetime)modified: Timestamp when this schedule was last modified. (datetime)name: Name of this schedule. (string)description: Optional description of this schedule. (string)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)unified_job_template: (id)enabled: Enables processing of this schedule. (boolean)dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)next_run: The next time that the scheduled action will run. (datetime)timezone: (field)until: (field)Make a PUT or PATCH request to this resource to update this\nschedule. The following fields may be modified:
\nrrule: A value representing the schedules iCal recurrence rule. (string, required)
name: Name of this schedule. (string, required)
description: Optional description of this schedule. (string, default=\"\")extra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)unified_job_template: (id, required)enabled: Enables processing of this schedule. (boolean, default=True)For a PATCH request, include only the fields that are being modified.
", "operationId":"Schedules_schedules_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "extra_data":{ "var1":"bar" } } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "created":"2018-02-01T08:00:00.000000Z", "description":"", "diff_mode":null, "dtend":"2015-11-17T05:00:00Z", "dtstart":"2015-11-17T05:00:00Z", "enabled":true, "extra_data":{ "var1":"$encrypted$" }, "id":1, "inventory":null, "job_tags":null, "job_type":null, "limit":null, "modified":"2018-02-01T08:00:00.000000Z", "name":"test sch", "next_run":null, "related":{ "credentials":"/api/v2/schedules/1/credentials/", "inventory":"/api/v2/inventories/1/", "project":"/api/v2/projects/1/", "unified_job_template":"/api/v2/job_templates/2/", "unified_jobs":"/api/v2/schedules/1/jobs/" }, "rrule":"DTSTART:20151117T050000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1", "scm_branch":null, "skip_tags":null, "summary_fields":{ "inventory":{ "description":"", "has_active_failures":false, "has_inventory_sources":false, "hosts_with_active_failures":0, "id":1, "insights_credential_id":null, "inventory_sources_with_failures":0, "kind":"", "name":"test-inv", "organization_id":1, "total_groups":0, "total_hosts":0, "total_inventory_sources":0 }, "unified_job_template":{ "description":"", "id":2, "name":"test-jt", "unified_job_type":"job" }, "user_capabilities":{ "delete":true, "edit":true } }, "timezone":"UTC", "type":"schedule", "unified_job_template":2, "until":"", "url":"/api/v2/schedules/1/", "verbosity":null } } } }, "summary":" Update a Schedule", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules-{id}--patch", "x-filename-id":"api-v2-schedules-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\nschedule. The following fields may be modified:
\nrrule: A value representing the schedules iCal recurrence rule. (string, required)
name: Name of this schedule. (string, required)
description: Optional description of this schedule. (string, default=\"\")extra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)unified_job_template: (id, required)enabled: Enables processing of this schedule. (boolean, default=True)For a PUT request, include all fields in the request.
", "operationId":"Schedules_schedules_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "diff_mode":{ "description":"", "type":"boolean" }, "enabled":{ "description":"Enables processing of this schedule.", "type":"boolean" }, "extra_data":{ "description":"", "type":"string" }, "inventory":{ "description":"Inventory applied as a prompt, assuming job template prompts for inventory", "type":"integer" }, "job_tags":{ "description":"", "type":"string" }, "job_type":{ "description":"", "type":"string" }, "limit":{ "description":"", "type":"string" }, "name":{ "description":"", "type":"string" }, "rrule":{ "description":"A value representing the schedules iCal recurrence rule.", "type":"string" }, "scm_branch":{ "description":"", "type":"string" }, "skip_tags":{ "description":"", "type":"string" }, "unified_job_template":{ "description":"", "type":"integer" }, "verbosity":{ "description":"", "type":"string" } }, "required":[ "rrule", "name", "unified_job_template" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Schedule", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules-{id}--put", "x-filename-id":"api-v2-schedules-id-put" } }, "/api/v2/schedules/{id}/credentials/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nschedule.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: (id)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential\nfields to create a new credential associated with this\nschedule.
\nname: Name of this credential. (string, required)description: Optional description of this credential. (string, default=\"\")organization: (id, default=None)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)
inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
Make a POST request to this resource with only an id field to associate an\nexisting credential with this schedule.
Make a POST request to this resource with id and disassociate fields to\nremove the credential from this schedule\n without deleting the credential.
Make a GET request to this resource to retrieve a list of\nunified jobs associated with the selected\nschedule.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of unified jobs\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more unified job records.
Each unified job data structure includes the following fields:
\nid: Database ID for this unified job. (integer)type: Data type for this unified job. (choice)url: URL for this unified job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this unified job was created. (datetime)modified: Timestamp when this unified job was last modified. (datetime)name: Name of this unified job. (string)description: Optional description of this unified job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)controller_node: The instance that managed the isolated execution environment. (string)To specify that unified jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\nsettings.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of settings\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more setting records.
Each setting data structure includes the following fields:
\nurl: (string)slug: (string)name: (string)To specify that settings are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a DELETE request to this resource to delete this setting.
", "operationId":"Settings_settings_delete", "parameters":[ { "description":"", "in":"path", "name":"category_slug", "required":true, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete a Setting", "tags":[ "Settings" ], "x-internal-id":"api-v2-settings-{category_slug}--delete", "x-filename-id":"api-v2-settings-category_slug-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single setting\nrecord containing the following fields:
\nACTIVITY_STREAM_ENABLED: Enable capturing activity for the activity stream. (boolean)ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC: Enable capturing activity for the activity stream when running inventory sync. (boolean)ORG_ADMINS_CAN_SEE_ALL_USERS: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean)MANAGE_ORGANIZATION_AUTH: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean)TOWER_URL_BASE: This setting is used by services like notifications to render a valid url to the Tower host. (string)REMOTE_HOST_HEADERS: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the Adminstrator guide for more details. (list)PROXY_IP_ALLOWED_LIST: If Tower is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which Tower should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list)LICENSE: The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license. (nested object)REDHAT_USERNAME: This username is used to retrieve license information and to send Automation Analytics (string)REDHAT_PASSWORD: This password is used to retrieve license information and to send Automation Analytics (string)AUTOMATION_ANALYTICS_URL: This setting is used to to configure data collection for the Automation Analytics dashboard (string)INSTALL_UUID: (string)CUSTOM_VENV_PATHS: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list)AD_HOC_COMMANDS: List of modules allowed to be used by ad-hoc jobs. (list)ALLOW_JINJA_IN_EXTRA_VARS: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where Tower users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice)always: Alwaysnever: Nevertemplate: Only On Job Template DefinitionsAWX_PROOT_ENABLED: Isolates an Ansible job from protected parts of the system to prevent exposing sensitive information. (boolean)AWX_PROOT_BASE_PATH: The directory in which Tower will create new temporary directories for job execution and isolation (such as credential files and custom inventory scripts). (string)AWX_PROOT_HIDE_PATHS: Additional paths to hide from isolated processes. Enter one path per line. (list)AWX_PROOT_SHOW_PATHS: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. (list)AWX_ISOLATED_CHECK_INTERVAL: The number of seconds to sleep between status checks for jobs running on isolated instances. (integer)AWX_ISOLATED_LAUNCH_TIMEOUT: The timeout (in seconds) for launching jobs on isolated instances. This includes the time needed to copy source control files (playbooks) to the isolated instance. (integer)AWX_ISOLATED_CONNECTION_TIMEOUT: Ansible SSH connection timeout (in seconds) to use when communicating with isolated instances. Value should be substantially greater than expected network latency. (integer)AWX_ISOLATED_HOST_KEY_CHECKING: When set to True, AWX will enforce strict host key checking for communication with isolated nodes. (boolean)AWX_ISOLATED_KEY_GENERATION: If set, a random RSA key will be generated and distributed to isolated instances. To disable this behavior and manage authentication for isolated instances outside of Tower, disable this setting. (boolean)AWX_ISOLATED_PRIVATE_KEY: The RSA private key for SSH traffic to isolated instances (string)AWX_ISOLATED_PUBLIC_KEY: The RSA public key for SSH traffic to isolated instances (string)AWX_RESOURCE_PROFILING_ENABLED: If set, detailed resource profiling data will be collected on all jobs. This data can be gathered with sosreport. (boolean)AWX_RESOURCE_PROFILING_CPU_POLL_INTERVAL: Interval (in seconds) between polls for cpu usage. Setting this lower than the default will affect playbook performance. (float)AWX_RESOURCE_PROFILING_MEMORY_POLL_INTERVAL: Interval (in seconds) between polls for memory usage. Setting this lower than the default will affect playbook performance. (float)AWX_RESOURCE_PROFILING_PID_POLL_INTERVAL: Interval (in seconds) between polls for PID count. Setting this lower than the default will affect playbook performance. (float)AWX_TASK_ENV: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object)INSIGHTS_TRACKING_STATE: Enables Tower to gather data on automation and send it to Red Hat. (boolean)PROJECT_UPDATE_VVV: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean)AWX_ROLES_ENABLED: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)AWX_COLLECTIONS_ENABLED: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)AWX_SHOW_PLAYBOOK_LINKS: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean)GALAXY_IGNORE_CERTS: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean)STDOUT_MAX_BYTES_DISPLAY: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer)EVENT_STDOUT_MAX_BYTES_DISPLAY: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. stdout will end with ??? when truncated. (integer)SCHEDULE_MAX_JOBS: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer)AWX_ANSIBLE_CALLBACK_PLUGINS: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list)DEFAULT_JOB_TIMEOUT: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer)DEFAULT_INVENTORY_UPDATE_TIMEOUT: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer)DEFAULT_PROJECT_UPDATE_TIMEOUT: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer)ANSIBLE_FACT_CACHE_TIMEOUT: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer)MAX_FORKS: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer)LOG_AGGREGATOR_HOST: Hostname/IP where external logs will be sent to. (string)LOG_AGGREGATOR_PORT: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer)LOG_AGGREGATOR_TYPE: Format messages for the chosen log aggregator. (choice)None: ---------logstashsplunklogglysumologicotherLOG_AGGREGATOR_USERNAME: Username for external log aggregator (if required; HTTP/s only). (string)LOG_AGGREGATOR_PASSWORD: Password or authentication token for external log aggregator (if required; HTTP/s only). (string)LOG_AGGREGATOR_LOGGERS: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs. (list)LOG_AGGREGATOR_INDIVIDUAL_FACTS: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean)LOG_AGGREGATOR_ENABLED: Enable sending logs to external log aggregator. (boolean)LOG_AGGREGATOR_TOWER_UUID: Useful to uniquely identify Tower instances. (string)LOG_AGGREGATOR_PROTOCOL: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)https: HTTPS/HTTPtcp: TCPudp: UDPLOG_AGGREGATOR_TCP_TIMEOUT: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer)LOG_AGGREGATOR_VERIFY_CERT: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, Tower's log handler will verify certificate sent by external log aggregator before establishing connection. (boolean)LOG_AGGREGATOR_LEVEL: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)DEBUGINFOWARNINGERRORCRITICALLOG_AGGREGATOR_MAX_DISK_USAGE_GB: Amount of data to store (in gigabytes) during an outage of the external log aggregator (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting. (integer)LOG_AGGREGATOR_MAX_DISK_USAGE_PATH: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string)LOG_AGGREGATOR_RSYSLOGD_DEBUG: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean)AUTOMATION_ANALYTICS_LAST_GATHER: (datetime)AUTOMATION_ANALYTICS_GATHER_INTERVAL: Interval (in seconds) between data gathering. (integer)SESSION_COOKIE_AGE: Number of seconds that a user is inactive before they will need to login again. (integer)SESSIONS_PER_USER: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer)AUTH_BASIC_ENABLED: Enable HTTP Basic Auth for the API Browser. (boolean)OAUTH2_PROVIDER: Dictionary for customizing OAuth 2 timeouts, available items are ACCESS_TOKEN_EXPIRE_SECONDS, the duration of access tokens in the number of seconds, AUTHORIZATION_CODE_EXPIRE_SECONDS, the duration of authorization codes in the number of seconds, and REFRESH_TOKEN_EXPIRE_SECONDS, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object)ALLOW_OAUTH2_FOR_EXTERNAL_USERS: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean)LOGIN_REDIRECT_OVERRIDE: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the Tower login page. (string)PENDO_TRACKING_STATE: Enable or Disable User Analytics Tracking. (choice)off: Offanonymous: Anonymousdetailed: DetailedCUSTOM_LOGIN_INFO: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string)CUSTOM_LOGO: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string)MAX_UI_JOB_EVENTS: Maximum number of job events for the UI to retrieve within a single request. (integer)UI_LIVE_UPDATES_ENABLED: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean)AUTHENTICATION_BACKENDS: List of authentication backends that are enabled based on license features and other authentication settings. (list)SOCIAL_AUTH_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object)SOCIAL_AUTH_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object)SOCIAL_AUTH_USER_FIELDS: When set to an empty list [], this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list)AUTH_LDAP_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)AUTH_LDAP_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string)AUTH_LDAP_BIND_PASSWORD: Password used to bind LDAP user account. (string)AUTH_LDAP_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)AUTH_LDAP_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)AUTH_LDAP_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list)AUTH_LDAP_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)AUTH_LDAP_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object)AUTH_LDAP_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)AUTH_LDAP_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupTypeNestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object)AUTH_LDAP_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string)AUTH_LDAP_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)AUTH_LDAP_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object)AUTH_LDAP_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object)AUTH_LDAP_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object)AUTH_LDAP_1_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)AUTH_LDAP_1_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string)AUTH_LDAP_1_BIND_PASSWORD: Password used to bind LDAP user account. (string)AUTH_LDAP_1_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)AUTH_LDAP_1_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)AUTH_LDAP_1_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list)AUTH_LDAP_1_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)AUTH_LDAP_1_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object)AUTH_LDAP_1_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)AUTH_LDAP_1_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupTypeNestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_1_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object)AUTH_LDAP_1_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string)AUTH_LDAP_1_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)AUTH_LDAP_1_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object)AUTH_LDAP_1_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object)AUTH_LDAP_1_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object)AUTH_LDAP_2_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)AUTH_LDAP_2_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string)AUTH_LDAP_2_BIND_PASSWORD: Password used to bind LDAP user account. (string)AUTH_LDAP_2_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)AUTH_LDAP_2_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)AUTH_LDAP_2_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list)AUTH_LDAP_2_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)AUTH_LDAP_2_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object)AUTH_LDAP_2_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)AUTH_LDAP_2_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupTypeNestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_2_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object)AUTH_LDAP_2_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string)AUTH_LDAP_2_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)AUTH_LDAP_2_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object)AUTH_LDAP_2_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object)AUTH_LDAP_2_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object)AUTH_LDAP_3_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)AUTH_LDAP_3_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string)AUTH_LDAP_3_BIND_PASSWORD: Password used to bind LDAP user account. (string)AUTH_LDAP_3_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)AUTH_LDAP_3_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)AUTH_LDAP_3_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list)AUTH_LDAP_3_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)AUTH_LDAP_3_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object)AUTH_LDAP_3_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)AUTH_LDAP_3_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupTypeNestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_3_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object)AUTH_LDAP_3_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string)AUTH_LDAP_3_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)AUTH_LDAP_3_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object)AUTH_LDAP_3_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object)AUTH_LDAP_3_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object)AUTH_LDAP_4_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)AUTH_LDAP_4_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string)AUTH_LDAP_4_BIND_PASSWORD: Password used to bind LDAP user account. (string)AUTH_LDAP_4_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)AUTH_LDAP_4_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)AUTH_LDAP_4_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list)AUTH_LDAP_4_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)AUTH_LDAP_4_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object)AUTH_LDAP_4_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)AUTH_LDAP_4_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupTypeNestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_4_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object)AUTH_LDAP_4_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string)AUTH_LDAP_4_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)AUTH_LDAP_4_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object)AUTH_LDAP_4_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object)AUTH_LDAP_4_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object)AUTH_LDAP_5_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)AUTH_LDAP_5_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string)AUTH_LDAP_5_BIND_PASSWORD: Password used to bind LDAP user account. (string)AUTH_LDAP_5_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)AUTH_LDAP_5_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)AUTH_LDAP_5_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list)AUTH_LDAP_5_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)AUTH_LDAP_5_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object)AUTH_LDAP_5_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)AUTH_LDAP_5_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupTypeNestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_5_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object)AUTH_LDAP_5_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string)AUTH_LDAP_5_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)AUTH_LDAP_5_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object)AUTH_LDAP_5_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object)AUTH_LDAP_5_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object)RADIUS_SERVER: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string)RADIUS_PORT: Port of RADIUS server. (integer)RADIUS_SECRET: Shared secret for authenticating to RADIUS server. (string)TACACSPLUS_HOST: Hostname of TACACS+ server. (string)TACACSPLUS_PORT: Port number of TACACS+ server. (integer)TACACSPLUS_SECRET: Shared secret for authenticating to TACACS+ server. (string)TACACSPLUS_SESSION_TIMEOUT: TACACS+ session timeout value in seconds, 0 disables timeout. (integer)TACACSPLUS_AUTH_PROTOCOL: Choose the authentication protocol used by TACACS+ client. (choice)asciipapSOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL: Provide this URL as the callback URL for your application as part of your registration process. Refer to the Ansible Tower documentation for more detail. (string)SOCIAL_AUTH_GOOGLE_OAUTH2_KEY: The OAuth2 key from your web application. (string)SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET: The OAuth2 secret from your web application. (string)SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list)SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the Ansible Tower documentation for more detail. (nested object)SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object)SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object)SOCIAL_AUTH_GITHUB_CALLBACK_URL: Provide this URL as the callback URL for your application as part of your registration process. Refer to the Ansible Tower documentation for more detail. (string)SOCIAL_AUTH_GITHUB_KEY: The OAuth2 key (Client ID) from your GitHub developer application. (string)SOCIAL_AUTH_GITHUB_SECRET: The OAuth2 secret (Client Secret) from your GitHub developer application. (string)SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object)SOCIAL_AUTH_GITHUB_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object)SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL: Provide this URL as the callback URL for your application as part of your registration process. Refer to the Ansible Tower documentation for more detail. (string)SOCIAL_AUTH_GITHUB_ORG_KEY: The OAuth2 key (Client ID) from your GitHub organization application. (string)SOCIAL_AUTH_GITHUB_ORG_SECRET: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)SOCIAL_AUTH_GITHUB_ORG_NAME: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object)SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object)SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)SOCIAL_AUTH_GITHUB_TEAM_KEY: The OAuth2 key (Client ID) from your GitHub organization application. (string)SOCIAL_AUTH_GITHUB_TEAM_SECRET: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)SOCIAL_AUTH_GITHUB_TEAM_ID: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object)SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object)SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL: Provide this URL as the callback URL for your application as part of your registration process. Refer to the Ansible Tower documentation for more detail. (string)SOCIAL_AUTH_AZUREAD_OAUTH2_KEY: The OAuth2 key (Client ID) from your Azure AD application. (string)SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET: The OAuth2 secret (Client Secret) from your Azure AD application. (string)SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object)SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object)SAML_AUTO_CREATE_OBJECTS: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean)SOCIAL_AUTH_SAML_CALLBACK_URL: Register Tower as a service provider (SP) with each identity provider (IdP) you have configured. Provide your SP Entity ID and this ACS URL for your application. (string)SOCIAL_AUTH_SAML_METADATA_URL: If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL. (string)SOCIAL_AUTH_SAML_SP_ENTITY_ID: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for Tower. (string)SOCIAL_AUTH_SAML_SP_PUBLIC_CERT: Create a keypair for Tower to use as a service provider (SP) and include the certificate content here. (string)SOCIAL_AUTH_SAML_SP_PRIVATE_KEY: Create a keypair for Tower to use as a service provider (SP) and include the private key content here. (string)SOCIAL_AUTH_SAML_ORG_INFO: Provide the URL, display name, and the name of your app. Refer to the Ansible Tower documentation for example syntax. (nested object)SOCIAL_AUTH_SAML_TECHNICAL_CONTACT: Provide the name and email address of the technical contact for your service provider. Refer to the Ansible Tower documentation for example syntax. (nested object)SOCIAL_AUTH_SAML_SUPPORT_CONTACT: Provide the name and email address of the support contact for your service provider. Refer to the Ansible Tower documentation for example syntax. (nested object)SOCIAL_AUTH_SAML_ENABLED_IDPS: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object)SOCIAL_AUTH_SAML_SECURITY_CONFIG: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object)SOCIAL_AUTH_SAML_SP_EXTRA: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object)SOCIAL_AUTH_SAML_EXTRA_DATA: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list)SOCIAL_AUTH_SAML_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object)SOCIAL_AUTH_SAML_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object)SOCIAL_AUTH_SAML_ORGANIZATION_ATTR: Used to translate user organization membership into Tower. (nested object)SOCIAL_AUTH_SAML_TEAM_ATTR: Used to translate user team membership into Tower. (nested object)Make a PUT or PATCH request to this resource to update this\nsetting. The following fields may be modified:
\nACTIVITY_STREAM_ENABLED: Enable capturing activity for the activity stream. (boolean, required)ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC: Enable capturing activity for the activity stream when running inventory sync. (boolean, required)ORG_ADMINS_CAN_SEE_ALL_USERS: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean, required)MANAGE_ORGANIZATION_AUTH: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean, required)TOWER_URL_BASE: This setting is used by services like notifications to render a valid url to the Tower host. (string, required)REMOTE_HOST_HEADERS: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the Adminstrator guide for more details. (list, required)PROXY_IP_ALLOWED_LIST: If Tower is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which Tower should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list, required)
REDHAT_USERNAME: This username is used to retrieve license information and to send Automation Analytics (string, default=\"\")
REDHAT_PASSWORD: This password is used to retrieve license information and to send Automation Analytics (string, default=\"\")AUTOMATION_ANALYTICS_URL: This setting is used to to configure data collection for the Automation Analytics dashboard (string, default=\"https://example.com\")
CUSTOM_VENV_PATHS: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list, default=[])
AD_HOC_COMMANDS: List of modules allowed to be used by ad-hoc jobs. (list, default=['command', 'shell', 'yum', 'apt', 'apt_key', 'apt_repository', 'apt_rpm', 'service', 'group', 'user', 'mount', 'ping', 'selinux', 'setup', 'win_ping', 'win_service', 'win_updates', 'win_group', 'win_user'])ALLOW_JINJA_IN_EXTRA_VARS: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where Tower users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice, required)always: Alwaysnever: Nevertemplate: Only On Job Template Definitions (default)AWX_PROOT_ENABLED: Isolates an Ansible job from protected parts of the system to prevent exposing sensitive information. (boolean, required)AWX_PROOT_BASE_PATH: The directory in which Tower will create new temporary directories for job execution and isolation (such as credential files and custom inventory scripts). (string, required)AWX_PROOT_HIDE_PATHS: Additional paths to hide from isolated processes. Enter one path per line. (list, default=[])AWX_PROOT_SHOW_PATHS: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. (list, default=[])AWX_ISOLATED_CHECK_INTERVAL: The number of seconds to sleep between status checks for jobs running on isolated instances. (integer, required)AWX_ISOLATED_LAUNCH_TIMEOUT: The timeout (in seconds) for launching jobs on isolated instances. This includes the time needed to copy source control files (playbooks) to the isolated instance. (integer, required)AWX_ISOLATED_CONNECTION_TIMEOUT: Ansible SSH connection timeout (in seconds) to use when communicating with isolated instances. Value should be substantially greater than expected network latency. (integer, default=10)AWX_ISOLATED_HOST_KEY_CHECKING: When set to True, AWX will enforce strict host key checking for communication with isolated nodes. (boolean, default=False)
AWX_RESOURCE_PROFILING_ENABLED: If set, detailed resource profiling data will be collected on all jobs. This data can be gathered with sosreport. (boolean, default=False)
AWX_RESOURCE_PROFILING_CPU_POLL_INTERVAL: Interval (in seconds) between polls for cpu usage. Setting this lower than the default will affect playbook performance. (float, default=0.25)AWX_RESOURCE_PROFILING_MEMORY_POLL_INTERVAL: Interval (in seconds) between polls for memory usage. Setting this lower than the default will affect playbook performance. (float, default=0.25)AWX_RESOURCE_PROFILING_PID_POLL_INTERVAL: Interval (in seconds) between polls for PID count. Setting this lower than the default will affect playbook performance. (float, default=0.25)AWX_TASK_ENV: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object, default={})INSIGHTS_TRACKING_STATE: Enables Tower to gather data on automation and send it to Red Hat. (boolean, default=False)PROJECT_UPDATE_VVV: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean, required)AWX_ROLES_ENABLED: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=True)AWX_COLLECTIONS_ENABLED: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=True)AWX_SHOW_PLAYBOOK_LINKS: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean, default=False)GALAXY_IGNORE_CERTS: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean, default=False)STDOUT_MAX_BYTES_DISPLAY: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer, required)EVENT_STDOUT_MAX_BYTES_DISPLAY: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. stdout will end with ??? when truncated. (integer, required)SCHEDULE_MAX_JOBS: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer, required)AWX_ANSIBLE_CALLBACK_PLUGINS: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list, default=[])DEFAULT_JOB_TIMEOUT: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer, default=0)DEFAULT_INVENTORY_UPDATE_TIMEOUT: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer, default=0)DEFAULT_PROJECT_UPDATE_TIMEOUT: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer, default=0)ANSIBLE_FACT_CACHE_TIMEOUT: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer, default=0)MAX_FORKS: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer, default=200)LOG_AGGREGATOR_HOST: Hostname/IP where external logs will be sent to. (string, default=\"\")LOG_AGGREGATOR_PORT: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer, default=None)LOG_AGGREGATOR_TYPE: Format messages for the chosen log aggregator. (choice)None: --------- (default)logstashsplunklogglysumologicotherLOG_AGGREGATOR_USERNAME: Username for external log aggregator (if required; HTTP/s only). (string, default=\"\")LOG_AGGREGATOR_PASSWORD: Password or authentication token for external log aggregator (if required; HTTP/s only). (string, default=\"\")LOG_AGGREGATOR_LOGGERS: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs. (list, default=['awx', 'activity_stream', 'job_events', 'system_tracking'])LOG_AGGREGATOR_INDIVIDUAL_FACTS: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean, default=False)LOG_AGGREGATOR_ENABLED: Enable sending logs to external log aggregator. (boolean, default=False)LOG_AGGREGATOR_TOWER_UUID: Useful to uniquely identify Tower instances. (string, default=\"\")LOG_AGGREGATOR_PROTOCOL: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)https: HTTPS/HTTP (default)tcp: TCPudp: UDPLOG_AGGREGATOR_TCP_TIMEOUT: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer, default=5)LOG_AGGREGATOR_VERIFY_CERT: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, Tower's log handler will verify certificate sent by external log aggregator before establishing connection. (boolean, default=True)LOG_AGGREGATOR_LEVEL: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)DEBUGINFO (default)WARNINGERRORCRITICALLOG_AGGREGATOR_MAX_DISK_USAGE_GB: Amount of data to store (in gigabytes) during an outage of the external log aggregator (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting. (integer, default=1)LOG_AGGREGATOR_MAX_DISK_USAGE_PATH: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string, default=\"/var/lib/awx\")LOG_AGGREGATOR_RSYSLOGD_DEBUG: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean, default=False)AUTOMATION_ANALYTICS_LAST_GATHER: (datetime, required)AUTOMATION_ANALYTICS_GATHER_INTERVAL: Interval (in seconds) between data gathering. (integer, default=14400)SESSION_COOKIE_AGE: Number of seconds that a user is inactive before they will need to login again. (integer, required)SESSIONS_PER_USER: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer, required)AUTH_BASIC_ENABLED: Enable HTTP Basic Auth for the API Browser. (boolean, required)OAUTH2_PROVIDER: Dictionary for customizing OAuth 2 timeouts, available items are ACCESS_TOKEN_EXPIRE_SECONDS, the duration of access tokens in the number of seconds, AUTHORIZATION_CODE_EXPIRE_SECONDS, the duration of authorization codes in the number of seconds, and REFRESH_TOKEN_EXPIRE_SECONDS, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object, default={'ACCESS_TOKEN_EXPIRE_SECONDS': 31536000000, 'AUTHORIZATION_CODE_EXPIRE_SECONDS': 600, 'REFRESH_TOKEN_EXPIRE_SECONDS': 2628000})ALLOW_OAUTH2_FOR_EXTERNAL_USERS: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean, default=False)LOGIN_REDIRECT_OVERRIDE: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the Tower login page. (string, default=\"\")
CUSTOM_LOGIN_INFO: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string, default=\"\")
CUSTOM_LOGO: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string, default=\"\")MAX_UI_JOB_EVENTS: Maximum number of job events for the UI to retrieve within a single request. (integer, required)UI_LIVE_UPDATES_ENABLED: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean, required)
SOCIAL_AUTH_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)
SOCIAL_AUTH_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)SOCIAL_AUTH_USER_FIELDS: When set to an empty list [], this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list, default=None)AUTH_LDAP_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=\"\")AUTH_LDAP_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string, default=\"\")AUTH_LDAP_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")AUTH_LDAP_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)AUTH_LDAP_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default={'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30})AUTH_LDAP_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list, default=[])AUTH_LDAP_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=\"\")AUTH_LDAP_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object, default={})AUTH_LDAP_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=[])AUTH_LDAP_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupType (default)NestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')]))AUTH_LDAP_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string, default=\"\")AUTH_LDAP_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=\"\")AUTH_LDAP_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object, default={})AUTH_LDAP_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_1_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=\"\")AUTH_LDAP_1_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string, default=\"\")AUTH_LDAP_1_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")AUTH_LDAP_1_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)AUTH_LDAP_1_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default={'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30})AUTH_LDAP_1_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list, default=[])AUTH_LDAP_1_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=\"\")AUTH_LDAP_1_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object, default={})AUTH_LDAP_1_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=[])AUTH_LDAP_1_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupType (default)NestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_1_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')]))AUTH_LDAP_1_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string, default=\"\")AUTH_LDAP_1_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=\"\")AUTH_LDAP_1_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object, default={})AUTH_LDAP_1_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_1_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_2_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=\"\")AUTH_LDAP_2_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string, default=\"\")AUTH_LDAP_2_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")AUTH_LDAP_2_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)AUTH_LDAP_2_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default={'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30})AUTH_LDAP_2_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list, default=[])AUTH_LDAP_2_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=\"\")AUTH_LDAP_2_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object, default={})AUTH_LDAP_2_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=[])AUTH_LDAP_2_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupType (default)NestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_2_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')]))AUTH_LDAP_2_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string, default=\"\")AUTH_LDAP_2_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=\"\")AUTH_LDAP_2_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object, default={})AUTH_LDAP_2_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_2_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_3_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=\"\")AUTH_LDAP_3_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string, default=\"\")AUTH_LDAP_3_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")AUTH_LDAP_3_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)AUTH_LDAP_3_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default={'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30})AUTH_LDAP_3_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list, default=[])AUTH_LDAP_3_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=\"\")AUTH_LDAP_3_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object, default={})AUTH_LDAP_3_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=[])AUTH_LDAP_3_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupType (default)NestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_3_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')]))AUTH_LDAP_3_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string, default=\"\")AUTH_LDAP_3_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=\"\")AUTH_LDAP_3_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object, default={})AUTH_LDAP_3_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_3_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_4_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=\"\")AUTH_LDAP_4_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string, default=\"\")AUTH_LDAP_4_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")AUTH_LDAP_4_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)AUTH_LDAP_4_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default={'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30})AUTH_LDAP_4_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list, default=[])AUTH_LDAP_4_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=\"\")AUTH_LDAP_4_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object, default={})AUTH_LDAP_4_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=[])AUTH_LDAP_4_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupType (default)NestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_4_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')]))AUTH_LDAP_4_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string, default=\"\")AUTH_LDAP_4_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=\"\")AUTH_LDAP_4_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object, default={})AUTH_LDAP_4_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_4_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_5_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=\"\")AUTH_LDAP_5_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string, default=\"\")AUTH_LDAP_5_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")AUTH_LDAP_5_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)AUTH_LDAP_5_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default={'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30})AUTH_LDAP_5_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list, default=[])AUTH_LDAP_5_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=\"\")AUTH_LDAP_5_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object, default={})AUTH_LDAP_5_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=[])AUTH_LDAP_5_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupType (default)NestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_5_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')]))AUTH_LDAP_5_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string, default=\"\")AUTH_LDAP_5_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=\"\")AUTH_LDAP_5_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object, default={})AUTH_LDAP_5_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_5_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object, default={})RADIUS_SERVER: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string, default=\"\")RADIUS_PORT: Port of RADIUS server. (integer, default=1812)RADIUS_SECRET: Shared secret for authenticating to RADIUS server. (string, default=\"\")TACACSPLUS_HOST: Hostname of TACACS+ server. (string, default=\"\")TACACSPLUS_PORT: Port number of TACACS+ server. (integer, default=49)TACACSPLUS_SECRET: Shared secret for authenticating to TACACS+ server. (string, default=\"\")TACACSPLUS_SESSION_TIMEOUT: TACACS+ session timeout value in seconds, 0 disables timeout. (integer, default=5)TACACSPLUS_AUTH_PROTOCOL: Choose the authentication protocol used by TACACS+ client. (choice)
ascii (default)papSOCIAL_AUTH_GOOGLE_OAUTH2_KEY: The OAuth2 key from your web application. (string, default=\"\")
SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET: The OAuth2 secret from your web application. (string, default=\"\")SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list, default=[])SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the Ansible Tower documentation for more detail. (nested object, default={})SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)
SOCIAL_AUTH_GITHUB_KEY: The OAuth2 key (Client ID) from your GitHub developer application. (string, default=\"\")
SOCIAL_AUTH_GITHUB_SECRET: The OAuth2 secret (Client Secret) from your GitHub developer application. (string, default=\"\")SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)SOCIAL_AUTH_GITHUB_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)
SOCIAL_AUTH_GITHUB_ORG_KEY: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=\"\")
SOCIAL_AUTH_GITHUB_ORG_SECRET: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=\"\")SOCIAL_AUTH_GITHUB_ORG_NAME: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=\"\")SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)
SOCIAL_AUTH_GITHUB_TEAM_KEY: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=\"\")
SOCIAL_AUTH_GITHUB_TEAM_SECRET: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=\"\")SOCIAL_AUTH_GITHUB_TEAM_ID: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=\"\")SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)
SOCIAL_AUTH_AZUREAD_OAUTH2_KEY: The OAuth2 key (Client ID) from your Azure AD application. (string, default=\"\")
SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET: The OAuth2 secret (Client Secret) from your Azure AD application. (string, default=\"\")SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)SAML_AUTO_CREATE_OBJECTS: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean, default=True)
SOCIAL_AUTH_SAML_SP_ENTITY_ID: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for Tower. (string, default=\"\")
SOCIAL_AUTH_SAML_SP_PUBLIC_CERT: Create a keypair for Tower to use as a service provider (SP) and include the certificate content here. (string, required)SOCIAL_AUTH_SAML_SP_PRIVATE_KEY: Create a keypair for Tower to use as a service provider (SP) and include the private key content here. (string, required)SOCIAL_AUTH_SAML_ORG_INFO: Provide the URL, display name, and the name of your app. Refer to the Ansible Tower documentation for example syntax. (nested object, required)SOCIAL_AUTH_SAML_TECHNICAL_CONTACT: Provide the name and email address of the technical contact for your service provider. Refer to the Ansible Tower documentation for example syntax. (nested object, required)SOCIAL_AUTH_SAML_SUPPORT_CONTACT: Provide the name and email address of the support contact for your service provider. Refer to the Ansible Tower documentation for example syntax. (nested object, required)SOCIAL_AUTH_SAML_ENABLED_IDPS: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object, default={})SOCIAL_AUTH_SAML_SECURITY_CONFIG: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object, default={'requestedAuthnContext': False})SOCIAL_AUTH_SAML_SP_EXTRA: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object, default=None)SOCIAL_AUTH_SAML_EXTRA_DATA: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list, default=None)SOCIAL_AUTH_SAML_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)SOCIAL_AUTH_SAML_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)SOCIAL_AUTH_SAML_ORGANIZATION_ATTR: Used to translate user organization membership into Tower. (nested object, default={})SOCIAL_AUTH_SAML_TEAM_ATTR: Used to translate user team membership into Tower. (nested object, default={})For a PATCH request, include only the fields that are being modified.
", "operationId":"Settings_settings_partial_update", "parameters":[ { "description":"", "in":"path", "name":"category_slug", "required":true, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "SOCIAL_AUTH_SAML_ENABLED_IDPS":{ "okta":{ "attr_email":"Email", "attr_first_name":"FirstName", "attr_last_name":"LastName", "attr_user_permanent_id":"login", "attr_username":"login", "entity_id":"http://www.okta.com/abc123", "url":"https://example.okta.com/app/abc123/xyz123/sso/saml", "x509cert":"MIIEogIBAAKCAQEA1T4za6qBbHxFpN5f9eFvA74MFjrsjcp1uvzOaE23AYKMDEJghJ6dqQ7GwHLNIeIeumqDFmODauIzrgSDJTT5+NG30Rr+rRi0zDkrkBAj/AtA+SaVhbzqB6ZSd7LaMly9XAc+82OKlNpuWS9hPmFaSShzDTXRu5RRyvm4NDCAOGDu5hyVR2pV/ffKDNfNkChnqzvRRW9laQcVmliZhlTGn7nPZ+JbjpwEy0nwW+4zoAiEvwnT52N4xTqIcYOnXtGiaf13dh7FkUfYmS0tzF3+h8QRKwtIm4y+sq84R/kr79/0t5aRUpJynNrECajzmArpL4IjXKTPIyUpTKirJgGnCwIDAQABAoIBAC6bbbm2hpsjfkVOpUKkhxMWUqX5MwK6oYjBAIwjkEAwPFPhnh7eXC87H42oidVCCt1LsmMOVQbjcdAzBEb5kTkk/Twi3k8O+1U3maHfJT5NZ2INYNjeNXh+jb/Dw5UGWAzpOIUR2JQ4Oa4cgPCVbppW0O6uOKz6+fWXJv+hKiUoBCC0TiY52iseHJdUOaKNxYRD2IyIzCAxFSd5tZRaARIYDsugXp3E/TdbsVWA7bmjIBOXq+SquTrlB8x7j3B7+Pi09nAJ2U/uV4PHE+/2Fl009ywfmqancvnhwnz+GQ5jjP+gTfghJfbO+Z6M346rS0Vw+osrPgfyudNHlCswHOECgYEA/Cfq25gDP07wo6+wYWbx6LIzj/SSZy/Ux9P8zghQfoZiPoaq7BQBPAzwLNt7JWST8U11LZA8/wo6ch+HSTMk+m5ieVuru2cHxTDqeNlh94eCrNwPJ5ayA5U6LxAuSCTAzp+rv6KQUx1JcKSEHuh+nRYTKvUDE6iA6YtPLO96lLUCgYEA2H5rOPX2M4w1Q9zjol77lplbPRdczXNd0PIzhy8Z2ID65qvmr1nxBG4f2H96ykW8CKLXNvSXreNZ1BhOXc/3Hv+3mm46iitB33gDX4mlV4Jyo/w5IWhUKRyoW6qXquFFsScxRzTrx/9M+aZeRRLdsBk27HavFEg6jrbQ0SleZL8CgYAaM6Op8d/UgkVrHOR9Go9kmK/W85kK8+NuaE7Ksf57R0eKK8AzC9kc/lMuthfTyOG+n0ff1i8gaVWtai1Ko+/hvfqplacAsDIUgYK70AroB8LCZ5ODj5sr2CPVpB7LDFakod7c6O2KVW6+L7oy5AHUHOkc+5y4PDg5DGrLxo68SQKBgAlGoWF3aG0c/MtDk51JZI43U+lyLs++ua5SMlMAeaMFI7rucpvgxqrh7Qthqukvw7a7A22fXUBeFWM5B2KNnpD9c+hyAKAa6l+gzMQzKZpuRGsyS2BbEAAS8kO7M3Rm4o2MmFfstI2FKs8nibJ79HOvIONQ0n+T+K5Utu2/UAQRAoGAFB4fiIyQ0nYzCf18Z4Wvi/qeIOW+UoBonIN3y1h4wruBywINHxFMHx4aVImJ6R09hoJ9D3Mxli3xF/8JIjfTG5fBSGrGnuofl14d/XtRDXbT2uhVXrIkeLL/ojODwwEx0VhxIRUEjPTvEl6AFSRRcBp3KKzQ/cu7ENDY6GTlOUI=" } } } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "SAML_AUTO_CREATE_OBJECTS":true, "SOCIAL_AUTH_SAML_CALLBACK_URL":"https://towerhost/sso/complete/saml/", "SOCIAL_AUTH_SAML_ENABLED_IDPS":{ "okta":{ "attr_email":"Email", "attr_first_name":"FirstName", "attr_last_name":"LastName", "attr_user_permanent_id":"login", "attr_username":"login", "entity_id":"http://www.okta.com/abc123", "url":"https://example.okta.com/app/abc123/xyz123/sso/saml", "x509cert":"MIIEogIBAAKCAQEA1T4za6qBbHxFpN5f9eFvA74MFjrsjcp1uvzOaE23AYKMDEJghJ6dqQ7GwHLNIeIeumqDFmODauIzrgSDJTT5+NG30Rr+rRi0zDkrkBAj/AtA+SaVhbzqB6ZSd7LaMly9XAc+82OKlNpuWS9hPmFaSShzDTXRu5RRyvm4NDCAOGDu5hyVR2pV/ffKDNfNkChnqzvRRW9laQcVmliZhlTGn7nPZ+JbjpwEy0nwW+4zoAiEvwnT52N4xTqIcYOnXtGiaf13dh7FkUfYmS0tzF3+h8QRKwtIm4y+sq84R/kr79/0t5aRUpJynNrECajzmArpL4IjXKTPIyUpTKirJgGnCwIDAQABAoIBAC6bbbm2hpsjfkVOpUKkhxMWUqX5MwK6oYjBAIwjkEAwPFPhnh7eXC87H42oidVCCt1LsmMOVQbjcdAzBEb5kTkk/Twi3k8O+1U3maHfJT5NZ2INYNjeNXh+jb/Dw5UGWAzpOIUR2JQ4Oa4cgPCVbppW0O6uOKz6+fWXJv+hKiUoBCC0TiY52iseHJdUOaKNxYRD2IyIzCAxFSd5tZRaARIYDsugXp3E/TdbsVWA7bmjIBOXq+SquTrlB8x7j3B7+Pi09nAJ2U/uV4PHE+/2Fl009ywfmqancvnhwnz+GQ5jjP+gTfghJfbO+Z6M346rS0Vw+osrPgfyudNHlCswHOECgYEA/Cfq25gDP07wo6+wYWbx6LIzj/SSZy/Ux9P8zghQfoZiPoaq7BQBPAzwLNt7JWST8U11LZA8/wo6ch+HSTMk+m5ieVuru2cHxTDqeNlh94eCrNwPJ5ayA5U6LxAuSCTAzp+rv6KQUx1JcKSEHuh+nRYTKvUDE6iA6YtPLO96lLUCgYEA2H5rOPX2M4w1Q9zjol77lplbPRdczXNd0PIzhy8Z2ID65qvmr1nxBG4f2H96ykW8CKLXNvSXreNZ1BhOXc/3Hv+3mm46iitB33gDX4mlV4Jyo/w5IWhUKRyoW6qXquFFsScxRzTrx/9M+aZeRRLdsBk27HavFEg6jrbQ0SleZL8CgYAaM6Op8d/UgkVrHOR9Go9kmK/W85kK8+NuaE7Ksf57R0eKK8AzC9kc/lMuthfTyOG+n0ff1i8gaVWtai1Ko+/hvfqplacAsDIUgYK70AroB8LCZ5ODj5sr2CPVpB7LDFakod7c6O2KVW6+L7oy5AHUHOkc+5y4PDg5DGrLxo68SQKBgAlGoWF3aG0c/MtDk51JZI43U+lyLs++ua5SMlMAeaMFI7rucpvgxqrh7Qthqukvw7a7A22fXUBeFWM5B2KNnpD9c+hyAKAa6l+gzMQzKZpuRGsyS2BbEAAS8kO7M3Rm4o2MmFfstI2FKs8nibJ79HOvIONQ0n+T+K5Utu2/UAQRAoGAFB4fiIyQ0nYzCf18Z4Wvi/qeIOW+UoBonIN3y1h4wruBywINHxFMHx4aVImJ6R09hoJ9D3Mxli3xF/8JIjfTG5fBSGrGnuofl14d/XtRDXbT2uhVXrIkeLL/ojODwwEx0VhxIRUEjPTvEl6AFSRRcBp3KKzQ/cu7ENDY6GTlOUI=" } }, "SOCIAL_AUTH_SAML_EXTRA_DATA":null, "SOCIAL_AUTH_SAML_METADATA_URL":"https://towerhost/sso/metadata/saml/", "SOCIAL_AUTH_SAML_ORGANIZATION_ATTR":{ }, "SOCIAL_AUTH_SAML_ORGANIZATION_MAP":null, "SOCIAL_AUTH_SAML_ORG_INFO":{ }, "SOCIAL_AUTH_SAML_SECURITY_CONFIG":{ "requestedAuthnContext":false }, "SOCIAL_AUTH_SAML_SP_ENTITY_ID":"", "SOCIAL_AUTH_SAML_SP_EXTRA":null, "SOCIAL_AUTH_SAML_SP_PRIVATE_KEY":"", "SOCIAL_AUTH_SAML_SP_PUBLIC_CERT":"", "SOCIAL_AUTH_SAML_SUPPORT_CONTACT":{ }, "SOCIAL_AUTH_SAML_TEAM_ATTR":{ }, "SOCIAL_AUTH_SAML_TEAM_MAP":null, "SOCIAL_AUTH_SAML_TECHNICAL_CONTACT":{ } } } }, "400":{ "examples":{ "application/json":{ "CUSTOM_LOGO":[ "Invalid base64-encoded data in data URL." ] } }, "description":"" } }, "summary":" Update a Setting", "tags":[ "Settings" ], "x-internal-id":"api-v2-settings-{category_slug}--patch", "x-filename-id":"api-v2-settings-category_slug-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\nsetting. The following fields may be modified:
\nACTIVITY_STREAM_ENABLED: Enable capturing activity for the activity stream. (boolean, required)ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC: Enable capturing activity for the activity stream when running inventory sync. (boolean, required)ORG_ADMINS_CAN_SEE_ALL_USERS: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean, required)MANAGE_ORGANIZATION_AUTH: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean, required)TOWER_URL_BASE: This setting is used by services like notifications to render a valid url to the Tower host. (string, required)REMOTE_HOST_HEADERS: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the Adminstrator guide for more details. (list, required)PROXY_IP_ALLOWED_LIST: If Tower is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which Tower should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list, required)
REDHAT_USERNAME: This username is used to retrieve license information and to send Automation Analytics (string, default=\"\")
REDHAT_PASSWORD: This password is used to retrieve license information and to send Automation Analytics (string, default=\"\")AUTOMATION_ANALYTICS_URL: This setting is used to to configure data collection for the Automation Analytics dashboard (string, default=\"https://example.com\")
CUSTOM_VENV_PATHS: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list, default=[])
AD_HOC_COMMANDS: List of modules allowed to be used by ad-hoc jobs. (list, default=['command', 'shell', 'yum', 'apt', 'apt_key', 'apt_repository', 'apt_rpm', 'service', 'group', 'user', 'mount', 'ping', 'selinux', 'setup', 'win_ping', 'win_service', 'win_updates', 'win_group', 'win_user'])ALLOW_JINJA_IN_EXTRA_VARS: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where Tower users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice, required)always: Alwaysnever: Nevertemplate: Only On Job Template Definitions (default)AWX_PROOT_ENABLED: Isolates an Ansible job from protected parts of the system to prevent exposing sensitive information. (boolean, required)AWX_PROOT_BASE_PATH: The directory in which Tower will create new temporary directories for job execution and isolation (such as credential files and custom inventory scripts). (string, required)AWX_PROOT_HIDE_PATHS: Additional paths to hide from isolated processes. Enter one path per line. (list, default=[])AWX_PROOT_SHOW_PATHS: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. (list, default=[])AWX_ISOLATED_CHECK_INTERVAL: The number of seconds to sleep between status checks for jobs running on isolated instances. (integer, required)AWX_ISOLATED_LAUNCH_TIMEOUT: The timeout (in seconds) for launching jobs on isolated instances. This includes the time needed to copy source control files (playbooks) to the isolated instance. (integer, required)AWX_ISOLATED_CONNECTION_TIMEOUT: Ansible SSH connection timeout (in seconds) to use when communicating with isolated instances. Value should be substantially greater than expected network latency. (integer, default=10)AWX_ISOLATED_HOST_KEY_CHECKING: When set to True, AWX will enforce strict host key checking for communication with isolated nodes. (boolean, default=False)
AWX_RESOURCE_PROFILING_ENABLED: If set, detailed resource profiling data will be collected on all jobs. This data can be gathered with sosreport. (boolean, default=False)
AWX_RESOURCE_PROFILING_CPU_POLL_INTERVAL: Interval (in seconds) between polls for cpu usage. Setting this lower than the default will affect playbook performance. (float, default=0.25)AWX_RESOURCE_PROFILING_MEMORY_POLL_INTERVAL: Interval (in seconds) between polls for memory usage. Setting this lower than the default will affect playbook performance. (float, default=0.25)AWX_RESOURCE_PROFILING_PID_POLL_INTERVAL: Interval (in seconds) between polls for PID count. Setting this lower than the default will affect playbook performance. (float, default=0.25)AWX_TASK_ENV: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object, default={})INSIGHTS_TRACKING_STATE: Enables Tower to gather data on automation and send it to Red Hat. (boolean, default=False)PROJECT_UPDATE_VVV: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean, required)AWX_ROLES_ENABLED: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=True)AWX_COLLECTIONS_ENABLED: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=True)AWX_SHOW_PLAYBOOK_LINKS: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean, default=False)GALAXY_IGNORE_CERTS: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean, default=False)STDOUT_MAX_BYTES_DISPLAY: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer, required)EVENT_STDOUT_MAX_BYTES_DISPLAY: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. stdout will end with ??? when truncated. (integer, required)SCHEDULE_MAX_JOBS: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer, required)AWX_ANSIBLE_CALLBACK_PLUGINS: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list, default=[])DEFAULT_JOB_TIMEOUT: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer, default=0)DEFAULT_INVENTORY_UPDATE_TIMEOUT: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer, default=0)DEFAULT_PROJECT_UPDATE_TIMEOUT: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer, default=0)ANSIBLE_FACT_CACHE_TIMEOUT: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer, default=0)MAX_FORKS: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer, default=200)LOG_AGGREGATOR_HOST: Hostname/IP where external logs will be sent to. (string, default=\"\")LOG_AGGREGATOR_PORT: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer, default=None)LOG_AGGREGATOR_TYPE: Format messages for the chosen log aggregator. (choice)None: --------- (default)logstashsplunklogglysumologicotherLOG_AGGREGATOR_USERNAME: Username for external log aggregator (if required; HTTP/s only). (string, default=\"\")LOG_AGGREGATOR_PASSWORD: Password or authentication token for external log aggregator (if required; HTTP/s only). (string, default=\"\")LOG_AGGREGATOR_LOGGERS: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs. (list, default=['awx', 'activity_stream', 'job_events', 'system_tracking'])LOG_AGGREGATOR_INDIVIDUAL_FACTS: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean, default=False)LOG_AGGREGATOR_ENABLED: Enable sending logs to external log aggregator. (boolean, default=False)LOG_AGGREGATOR_TOWER_UUID: Useful to uniquely identify Tower instances. (string, default=\"\")LOG_AGGREGATOR_PROTOCOL: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)https: HTTPS/HTTP (default)tcp: TCPudp: UDPLOG_AGGREGATOR_TCP_TIMEOUT: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer, default=5)LOG_AGGREGATOR_VERIFY_CERT: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, Tower's log handler will verify certificate sent by external log aggregator before establishing connection. (boolean, default=True)LOG_AGGREGATOR_LEVEL: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)DEBUGINFO (default)WARNINGERRORCRITICALLOG_AGGREGATOR_MAX_DISK_USAGE_GB: Amount of data to store (in gigabytes) during an outage of the external log aggregator (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting. (integer, default=1)LOG_AGGREGATOR_MAX_DISK_USAGE_PATH: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string, default=\"/var/lib/awx\")LOG_AGGREGATOR_RSYSLOGD_DEBUG: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean, default=False)AUTOMATION_ANALYTICS_LAST_GATHER: (datetime, required)AUTOMATION_ANALYTICS_GATHER_INTERVAL: Interval (in seconds) between data gathering. (integer, default=14400)SESSION_COOKIE_AGE: Number of seconds that a user is inactive before they will need to login again. (integer, required)SESSIONS_PER_USER: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer, required)AUTH_BASIC_ENABLED: Enable HTTP Basic Auth for the API Browser. (boolean, required)OAUTH2_PROVIDER: Dictionary for customizing OAuth 2 timeouts, available items are ACCESS_TOKEN_EXPIRE_SECONDS, the duration of access tokens in the number of seconds, AUTHORIZATION_CODE_EXPIRE_SECONDS, the duration of authorization codes in the number of seconds, and REFRESH_TOKEN_EXPIRE_SECONDS, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object, default={'ACCESS_TOKEN_EXPIRE_SECONDS': 31536000000, 'AUTHORIZATION_CODE_EXPIRE_SECONDS': 600, 'REFRESH_TOKEN_EXPIRE_SECONDS': 2628000})ALLOW_OAUTH2_FOR_EXTERNAL_USERS: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean, default=False)LOGIN_REDIRECT_OVERRIDE: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the Tower login page. (string, default=\"\")
CUSTOM_LOGIN_INFO: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string, default=\"\")
CUSTOM_LOGO: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string, default=\"\")MAX_UI_JOB_EVENTS: Maximum number of job events for the UI to retrieve within a single request. (integer, required)UI_LIVE_UPDATES_ENABLED: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean, required)
SOCIAL_AUTH_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)
SOCIAL_AUTH_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)SOCIAL_AUTH_USER_FIELDS: When set to an empty list [], this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list, default=None)AUTH_LDAP_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=\"\")AUTH_LDAP_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string, default=\"\")AUTH_LDAP_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")AUTH_LDAP_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)AUTH_LDAP_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default={'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30})AUTH_LDAP_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list, default=[])AUTH_LDAP_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=\"\")AUTH_LDAP_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object, default={})AUTH_LDAP_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=[])AUTH_LDAP_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupType (default)NestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')]))AUTH_LDAP_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string, default=\"\")AUTH_LDAP_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=\"\")AUTH_LDAP_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object, default={})AUTH_LDAP_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_1_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=\"\")AUTH_LDAP_1_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string, default=\"\")AUTH_LDAP_1_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")AUTH_LDAP_1_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)AUTH_LDAP_1_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default={'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30})AUTH_LDAP_1_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list, default=[])AUTH_LDAP_1_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=\"\")AUTH_LDAP_1_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object, default={})AUTH_LDAP_1_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=[])AUTH_LDAP_1_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupType (default)NestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_1_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')]))AUTH_LDAP_1_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string, default=\"\")AUTH_LDAP_1_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=\"\")AUTH_LDAP_1_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object, default={})AUTH_LDAP_1_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_1_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_2_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=\"\")AUTH_LDAP_2_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string, default=\"\")AUTH_LDAP_2_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")AUTH_LDAP_2_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)AUTH_LDAP_2_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default={'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30})AUTH_LDAP_2_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list, default=[])AUTH_LDAP_2_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=\"\")AUTH_LDAP_2_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object, default={})AUTH_LDAP_2_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=[])AUTH_LDAP_2_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupType (default)NestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_2_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')]))AUTH_LDAP_2_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string, default=\"\")AUTH_LDAP_2_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=\"\")AUTH_LDAP_2_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object, default={})AUTH_LDAP_2_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_2_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_3_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=\"\")AUTH_LDAP_3_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string, default=\"\")AUTH_LDAP_3_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")AUTH_LDAP_3_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)AUTH_LDAP_3_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default={'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30})AUTH_LDAP_3_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list, default=[])AUTH_LDAP_3_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=\"\")AUTH_LDAP_3_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object, default={})AUTH_LDAP_3_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=[])AUTH_LDAP_3_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupType (default)NestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_3_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')]))AUTH_LDAP_3_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string, default=\"\")AUTH_LDAP_3_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=\"\")AUTH_LDAP_3_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object, default={})AUTH_LDAP_3_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_3_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_4_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=\"\")AUTH_LDAP_4_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string, default=\"\")AUTH_LDAP_4_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")AUTH_LDAP_4_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)AUTH_LDAP_4_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default={'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30})AUTH_LDAP_4_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list, default=[])AUTH_LDAP_4_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=\"\")AUTH_LDAP_4_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object, default={})AUTH_LDAP_4_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=[])AUTH_LDAP_4_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupType (default)NestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_4_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')]))AUTH_LDAP_4_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string, default=\"\")AUTH_LDAP_4_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=\"\")AUTH_LDAP_4_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object, default={})AUTH_LDAP_4_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_4_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_5_SERVER_URI: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=\"\")AUTH_LDAP_5_BIND_DN: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the Ansible Tower documentation for example syntax. (string, default=\"\")AUTH_LDAP_5_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")AUTH_LDAP_5_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)AUTH_LDAP_5_CONNECTION_OPTIONS: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default={'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30})AUTH_LDAP_5_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details. (list, default=[])AUTH_LDAP_5_USER_DN_TEMPLATE: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=\"\")AUTH_LDAP_5_USER_ATTR_MAP: Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details. (nested object, default={})AUTH_LDAP_5_GROUP_SEARCH: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=[])AUTH_LDAP_5_GROUP_TYPE: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)PosixGroupTypeGroupOfNamesTypeGroupOfUniqueNamesTypeActiveDirectoryGroupTypeOrganizationalRoleGroupTypeMemberDNGroupType (default)NestedGroupOfNamesTypeNestedGroupOfUniqueNamesTypeNestedActiveDirectoryGroupTypeNestedOrganizationalRoleGroupTypeNestedMemberDNGroupTypePosixUIDGroupTypeAUTH_LDAP_5_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')]))AUTH_LDAP_5_REQUIRE_GROUP: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login via Tower. Only one require group is supported. (string, default=\"\")AUTH_LDAP_5_DENY_GROUP: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=\"\")AUTH_LDAP_5_USER_FLAGS_BY_GROUP: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail. (nested object, default={})AUTH_LDAP_5_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation. (nested object, default={})AUTH_LDAP_5_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation. (nested object, default={})RADIUS_SERVER: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string, default=\"\")RADIUS_PORT: Port of RADIUS server. (integer, default=1812)RADIUS_SECRET: Shared secret for authenticating to RADIUS server. (string, default=\"\")TACACSPLUS_HOST: Hostname of TACACS+ server. (string, default=\"\")TACACSPLUS_PORT: Port number of TACACS+ server. (integer, default=49)TACACSPLUS_SECRET: Shared secret for authenticating to TACACS+ server. (string, default=\"\")TACACSPLUS_SESSION_TIMEOUT: TACACS+ session timeout value in seconds, 0 disables timeout. (integer, default=5)TACACSPLUS_AUTH_PROTOCOL: Choose the authentication protocol used by TACACS+ client. (choice)
ascii (default)papSOCIAL_AUTH_GOOGLE_OAUTH2_KEY: The OAuth2 key from your web application. (string, default=\"\")
SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET: The OAuth2 secret from your web application. (string, default=\"\")SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list, default=[])SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the Ansible Tower documentation for more detail. (nested object, default={})SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)
SOCIAL_AUTH_GITHUB_KEY: The OAuth2 key (Client ID) from your GitHub developer application. (string, default=\"\")
SOCIAL_AUTH_GITHUB_SECRET: The OAuth2 secret (Client Secret) from your GitHub developer application. (string, default=\"\")SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)SOCIAL_AUTH_GITHUB_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)
SOCIAL_AUTH_GITHUB_ORG_KEY: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=\"\")
SOCIAL_AUTH_GITHUB_ORG_SECRET: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=\"\")SOCIAL_AUTH_GITHUB_ORG_NAME: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=\"\")SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)
SOCIAL_AUTH_GITHUB_TEAM_KEY: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=\"\")
SOCIAL_AUTH_GITHUB_TEAM_SECRET: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=\"\")SOCIAL_AUTH_GITHUB_TEAM_ID: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=\"\")SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)
SOCIAL_AUTH_AZUREAD_OAUTH2_KEY: The OAuth2 key (Client ID) from your Azure AD application. (string, default=\"\")
SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET: The OAuth2 secret (Client Secret) from your Azure AD application. (string, default=\"\")SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)SAML_AUTO_CREATE_OBJECTS: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean, default=True)
SOCIAL_AUTH_SAML_SP_ENTITY_ID: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for Tower. (string, default=\"\")
SOCIAL_AUTH_SAML_SP_PUBLIC_CERT: Create a keypair for Tower to use as a service provider (SP) and include the certificate content here. (string, required)SOCIAL_AUTH_SAML_SP_PRIVATE_KEY: Create a keypair for Tower to use as a service provider (SP) and include the private key content here. (string, required)SOCIAL_AUTH_SAML_ORG_INFO: Provide the URL, display name, and the name of your app. Refer to the Ansible Tower documentation for example syntax. (nested object, required)SOCIAL_AUTH_SAML_TECHNICAL_CONTACT: Provide the name and email address of the technical contact for your service provider. Refer to the Ansible Tower documentation for example syntax. (nested object, required)SOCIAL_AUTH_SAML_SUPPORT_CONTACT: Provide the name and email address of the support contact for your service provider. Refer to the Ansible Tower documentation for example syntax. (nested object, required)SOCIAL_AUTH_SAML_ENABLED_IDPS: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object, default={})SOCIAL_AUTH_SAML_SECURITY_CONFIG: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object, default={'requestedAuthnContext': False})SOCIAL_AUTH_SAML_SP_EXTRA: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object, default=None)SOCIAL_AUTH_SAML_EXTRA_DATA: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list, default=None)SOCIAL_AUTH_SAML_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which Tower organizations based on their\nusername and email address. Configuration details are available in the Ansible\nTower documentation. (nested object, default=None)SOCIAL_AUTH_SAML_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in Tower documentation. (nested object, default=None)SOCIAL_AUTH_SAML_ORGANIZATION_ATTR: Used to translate user organization membership into Tower. (nested object, default={})SOCIAL_AUTH_SAML_TEAM_ATTR: Used to translate user team membership into Tower. (nested object, default={})For a PUT request, include all fields in the request.
", "operationId":"Settings_settings_update", "parameters":[ { "description":"", "in":"path", "name":"category_slug", "required":true, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "LOG_AGGREGATOR_ENABLED":true, "LOG_AGGREGATOR_HOST":"https://localhost", "LOG_AGGREGATOR_INDIVIDUAL_FACTS":false, "LOG_AGGREGATOR_LEVEL":"INFO", "LOG_AGGREGATOR_LOGGERS":[ "awx", "activity_stream", "job_events", "system_tracking" ], "LOG_AGGREGATOR_MAX_DISK_USAGE_GB":1, "LOG_AGGREGATOR_MAX_DISK_USAGE_PATH":"/var/lib/awx", "LOG_AGGREGATOR_PASSWORD":"", "LOG_AGGREGATOR_PORT":null, "LOG_AGGREGATOR_PROTOCOL":"https", "LOG_AGGREGATOR_RSYSLOGD_DEBUG":false, "LOG_AGGREGATOR_TCP_TIMEOUT":5, "LOG_AGGREGATOR_TOWER_UUID":"", "LOG_AGGREGATOR_TYPE":"other", "LOG_AGGREGATOR_USERNAME":"", "LOG_AGGREGATOR_VERIFY_CERT":true } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "LOG_AGGREGATOR_ENABLED":true, "LOG_AGGREGATOR_HOST":"https://localhost", "LOG_AGGREGATOR_INDIVIDUAL_FACTS":false, "LOG_AGGREGATOR_LEVEL":"INFO", "LOG_AGGREGATOR_LOGGERS":[ "awx", "activity_stream", "job_events", "system_tracking" ], "LOG_AGGREGATOR_MAX_DISK_USAGE_GB":1, "LOG_AGGREGATOR_MAX_DISK_USAGE_PATH":"/var/lib/awx", "LOG_AGGREGATOR_PASSWORD":"", "LOG_AGGREGATOR_PORT":null, "LOG_AGGREGATOR_PROTOCOL":"https", "LOG_AGGREGATOR_RSYSLOGD_DEBUG":false, "LOG_AGGREGATOR_TCP_TIMEOUT":5, "LOG_AGGREGATOR_TOWER_UUID":"", "LOG_AGGREGATOR_TYPE":"other", "LOG_AGGREGATOR_USERNAME":"", "LOG_AGGREGATOR_VERIFY_CERT":true } } }, "400":{ "examples":{ "application/json":{ "__all__":[ "Cannot enable log aggregator without providing type." ] } }, "description":"" } }, "summary":" Update a Setting", "tags":[ "Settings" ], "x-internal-id":"api-v2-settings-{category_slug}--put", "x-filename-id":"api-v2-settings-category_slug-put" } }, "/api/v2/system_job_templates/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nsystem job templates.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of system job templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more system job template records.
Each system job template data structure includes the following fields:
\nid: Database ID for this system job template. (integer)type: Data type for this system job template. (choice)url: URL for this system job template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this system job template was created. (datetime)modified: Timestamp when this system job template was last modified. (datetime)name: Name of this system job template. (string)description: Optional description of this system job template. (string)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedok: OKmissing: Missingnone: No External Sourceupdating: Updatingjob_type: (choice)\"\": ---------cleanup_jobs: Remove jobs older than a certain number of dayscleanup_activitystream: Remove activity stream entries older than a certain number of dayscleanup_sessions: Removes expired browser sessions from the databasecleanup_tokens: Removes expired OAuth 2 access tokens and refresh tokensTo specify that system job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single system job template\nrecord containing the following fields:
\nid: Database ID for this system job template. (integer)type: Data type for this system job template. (choice)url: URL for this system job template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this system job template was created. (datetime)modified: Timestamp when this system job template was last modified. (datetime)name: Name of this system job template. (string)description: Optional description of this system job template. (string)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedok: OKmissing: Missingnone: No External Sourceupdating: Updatingjob_type: (choice)\"\": ---------cleanup_jobs: Remove jobs older than a certain number of dayscleanup_activitystream: Remove activity stream entries older than a certain number of dayscleanup_sessions: Removes expired browser sessions from the databasecleanup_tokens: Removes expired OAuth 2 access tokens and refresh tokensMake a GET request to this resource to retrieve a list of\nsystem jobs associated with the selected\nsystem job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of system jobs\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more system job records.
Each system job data structure includes the following fields:
\nid: Database ID for this system job. (integer)type: Data type for this system job. (choice)url: URL for this system job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this system job was created. (datetime)modified: Timestamp when this system job was last modified. (datetime)name: Name of this system job. (string)description: Optional description of this system job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)system_job_template: (id)job_type: (choice)\"\": ---------cleanup_jobs: Remove jobs older than a certain number of dayscleanup_activitystream: Remove activity stream entries older than a certain number of dayscleanup_sessions: Removes expired browser sessions from the databasecleanup_tokens: Removes expired OAuth 2 access tokens and refresh tokensextra_vars: (string)result_stdout: (field)To specify that system jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource to launch the system job template.
\nVariables specified inside of the parameter extra_vars are passed to the\nsystem job task as command line parameters. These tasks can be run manually\non the host system via the awx-manage command.
For example on cleanup_jobs and cleanup_activitystream:
{\"extra_vars\": {\"days\": 30}}
Which will act on data older than 30 days.
\nFor cleanup_activitystream and cleanup_jobs commands, providing\n\"dry_run\": true inside of extra_vars will show items that will be\nremoved without deleting them.
Each individual system job task has its own default values, which are\napplicable either when running it from the command line or launching its\nsystem job template with empty extra_vars.
cleanup_activitystream: days=90cleanup_jobs: days=90If successful, the response status code will be 202. If the job cannot be\nlaunched, a 405 status code will be returned.
", "operationId":"System Job Templates_system_job_templates_launch_list", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A page number within the paginated result set.", "in":"query", "name":"page", "required":false, "type":"integer" }, { "description":"Number of results to return per page.", "in":"query", "name":"page_size", "required":false, "type":"integer" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":"Launch a Job Template", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates-{id}-launch--get", "x-filename-id":"api-v2-system_job_templates-id-launch-get" }, "post":{ "description":"Make a POST request to this resource to launch the system job template.
\nVariables specified inside of the parameter extra_vars are passed to the\nsystem job task as command line parameters. These tasks can be run manually\non the host system via the awx-manage command.
For example on cleanup_jobs and cleanup_activitystream:
{\"extra_vars\": {\"days\": 30}}
Which will act on data older than 30 days.
\nFor cleanup_activitystream and cleanup_jobs commands, providing\n\"dry_run\": true inside of extra_vars will show items that will be\nremoved without deleting them.
Each individual system job task has its own default values, which are\napplicable either when running it from the command line or launching its\nsystem job template with empty extra_vars.
cleanup_activitystream: days=90cleanup_jobs: days=90If successful, the response status code will be 202. If the job cannot be\nlaunched, a 405 status code will be returned.
", "operationId":"System Job Templates_system_job_templates_launch_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "responses":{ "201":{ "description":"" } }, "summary":"Launch a Job Template", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates-{id}-launch--post", "x-filename-id":"api-v2-system_job_templates-id-launch-post" } }, "/api/v2/system_job_templates/{id}/notification_templates_error/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nsystem job template.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this system job template.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this system job template\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nsystem job template.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this system job template.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this system job template\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nsystem job template.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this system job template.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this system job template\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nsystem job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of schedules\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more schedule records.
Each schedule data structure includes the following fields:
\nrrule: A value representing the schedules iCal recurrence rule. (string)id: Database ID for this schedule. (integer)type: Data type for this schedule. (choice)url: URL for this schedule. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this schedule was created. (datetime)modified: Timestamp when this schedule was last modified. (datetime)name: Name of this schedule. (string)description: Optional description of this schedule. (string)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)unified_job_template: (id)enabled: Enables processing of this schedule. (boolean)dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)next_run: The next time that the scheduled action will run. (datetime)timezone: (field)until: (field)To specify that schedules are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following schedule\nfields to create a new schedule associated with this\nsystem job template.
\nrrule: A value representing the schedules iCal recurrence rule. (string, required)
name: Name of this schedule. (string, required)
description: Optional description of this schedule. (string, default=\"\")extra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)
None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)enabled: Enables processing of this schedule. (boolean, default=True)
Make a GET request to this resource to retrieve the list of\nsystem jobs.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of system jobs\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more system job records.
Each system job data structure includes the following fields:
\nid: Database ID for this system job. (integer)type: Data type for this system job. (choice)url: URL for this system job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this system job was created. (datetime)modified: Timestamp when this system job was last modified. (datetime)name: Name of this system job. (string)description: Optional description of this system job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)system_job_template: (id)job_type: (choice)\"\": ---------cleanup_jobs: Remove jobs older than a certain number of dayscleanup_activitystream: Remove activity stream entries older than a certain number of dayscleanup_sessions: Removes expired browser sessions from the databasecleanup_tokens: Removes expired OAuth 2 access tokens and refresh tokensextra_vars: (string)result_stdout: (field)To specify that system jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a DELETE request to this resource to delete this system job.
", "operationId":"System Jobs_system_jobs_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"Cannot delete running job resource." } }, "description":"" } }, "summary":" Delete a System Job", "tags":[ "System Jobs" ], "x-internal-id":"api-v2-system_jobs-{id}--delete", "x-filename-id":"api-v2-system_jobs-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:
\nid: Database ID for this system job. (integer)type: Data type for this system job. (choice)url: URL for this system job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this system job was created. (datetime)modified: Timestamp when this system job was last modified. (datetime)name: Name of this system job. (string)description: Optional description of this system job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_args: (string)job_cwd: (string)job_env: (json)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)result_traceback: (string)event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)system_job_template: (id)job_type: (choice)\"\": ---------cleanup_jobs: Remove jobs older than a certain number of dayscleanup_activitystream: Remove activity stream entries older than a certain number of dayscleanup_sessions: Removes expired browser sessions from the databasecleanup_tokens: Removes expired OAuth 2 access tokens and refresh tokensextra_vars: (string)result_stdout: (field)Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:
\ncan_cancel: (boolean)Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:
\ncan_cancel: (boolean)Make a GET request to this resource to retrieve a list of\nsystem job events associated with the selected\nsystem job.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of system job events\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more system job event records.
Each system job event data structure includes the following fields:
\nid: Database ID for this system job event. (integer)type: Data type for this system job event. (choice)url: URL for this system job event. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this system job event was created. (datetime)modified: Timestamp when this system job event was last modified. (datetime)event: (field)counter: (integer)event_display: (string)event_data: (json)failed: (field)changed: (field)uuid: (string)stdout: (string)start_line: (integer)end_line: (integer)verbosity: (integer)system_job: (id)To specify that system job events are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nsystem job.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notifications\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification records.
Each notification data structure includes the following fields:
\nid: Database ID for this notification. (integer)type: Data type for this notification. (choice)url: URL for this notification. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification was created. (datetime)modified: Timestamp when this notification was last modified. (datetime)notification_template: (id)error: (string)status: (choice)pending: Pendingsuccessful: Successfulfailed: Failednotifications_sent: (integer)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhookrecipients: (string)subject: (string)body: Notification body (json)To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\nteams.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of teams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more team records.
Each team data structure includes the following fields:
\nid: Database ID for this team. (integer)type: Data type for this team. (choice)url: URL for this team. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this team was created. (datetime)modified: Timestamp when this team was last modified. (datetime)name: Name of this team. (string)description: Optional description of this team. (string)organization: (id)To specify that teams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following team\nfields to create a new team:
\nname: Name of this team. (string, required)description: Optional description of this team. (string, default=\"\")organization: (id, required)Make a DELETE request to this resource to delete this team.
", "operationId":"Teams_teams_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}--delete", "x-filename-id":"api-v2-teams-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single team\nrecord containing the following fields:
\nid: Database ID for this team. (integer)type: Data type for this team. (choice)url: URL for this team. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this team was created. (datetime)modified: Timestamp when this team was last modified. (datetime)name: Name of this team. (string)description: Optional description of this team. (string)organization: (id)Make a PUT or PATCH request to this resource to update this\nteam. The following fields may be modified:
\nname: Name of this team. (string, required)description: Optional description of this team. (string, default=\"\")organization: (id, required)For a PATCH request, include only the fields that are being modified.
", "operationId":"Teams_teams_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "name":{ "description":"", "type":"string" }, "organization":{ "description":"", "type":"integer" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}--patch", "x-filename-id":"api-v2-teams-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\nteam. The following fields may be modified:
\nname: Name of this team. (string, required)description: Optional description of this team. (string, default=\"\")organization: (id, required)For a PUT request, include all fields in the request.
", "operationId":"Teams_teams_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "name":{ "description":"", "type":"string" }, "organization":{ "description":"", "type":"integer" } }, "required":[ "name", "organization" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}--put", "x-filename-id":"api-v2-teams-id-put" } }, "/api/v2/teams/{id}/access_list/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nusers.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nteam.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nteam.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential\nfields to create a new credential associated with this\nteam.
\nname: Name of this credential. (string, required)description: Optional description of this credential. (string, default=\"\")credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)
inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
Make a GET request to this resource to retrieve a list of\nroles associated with the selected\nteam.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nprojects associated with the selected\nteam.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of projects\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more project records.
Each project data structure includes the following fields:
\nid: Database ID for this project. (integer)type: Data type for this project. (choice)url: URL for this project. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this project was created. (datetime)modified: Timestamp when this project was last modified. (datetime)name: Name of this project. (string)description: Optional description of this project. (string)local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)scm_type: Specifies the source control system used to store the project. (choice)\"\": Manualgit: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: Remote Archivescm_url: The location where the project is stored. (string)scm_branch: Specific branch, tag or commit to checkout. (string)scm_refspec: For git projects, an additional refspec to fetch. (string)scm_clean: Discard any local changes before syncing the project. (boolean)scm_delete_on_update: Delete the project before syncing. (boolean)credential: (id)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)scm_revision: The last revision fetched by a project update (string)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedok: OKmissing: Missingorganization: The organization used to determine access to this template. (id)scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean)scm_update_cache_timeout: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)last_update_failed: (boolean)last_updated: (datetime)To specify that projects are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of roles associated with the selected team.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource to add or remove a role from this team. The following fields may be modified:
\nid: The Role ID to add to the team. (int, required)disassociate: Provide if you want to remove the role. (any value, optional)Make a GET request to this resource to retrieve a list of\nusers associated with the selected\nteam.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following user\nfields to create a new user associated with this\nteam.
\nusername: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)first_name: (string, default=\"\")last_name: (string, default=\"\")email: (string, default=\"\")is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)is_system_auditor: (boolean, default=False)password: Write-only field used to change the password. (string, default=\"\")Make a POST request to this resource with only an id field to associate an\nexisting user with this team.
Make a POST request to this resource with id and disassociate fields to\nremove the user from this team\n without deleting the user.
Make a GET request to this resource to retrieve the list of\naccess tokens.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of access tokens\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more access token records.
Each access token data structure includes the following fields:
\nid: Database ID for this access token. (integer)type: Data type for this access token. (choice)url: URL for this access token. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this access token was created. (datetime)modified: Timestamp when this access token was last modified. (datetime)description: Optional description of this access token. (string)user: The user representing the token owner (id)token: (string)refresh_token: (field)application: (id)expires: (datetime)scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)To specify that access tokens are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following access token\nfields to create a new access token:
\ndescription: Optional description of this access token. (string, default=\"\")
application: (id, default=``)
scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")
Make a DELETE request to this resource to delete this access token.
", "operationId":"Authentication_tokens_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete an Access Token", "tags":[ "Authentication" ], "x-internal-id":"api-v2-tokens-{id}--delete", "x-filename-id":"api-v2-tokens-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single access token\nrecord containing the following fields:
\nid: Database ID for this access token. (integer)type: Data type for this access token. (choice)url: URL for this access token. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this access token was created. (datetime)modified: Timestamp when this access token was last modified. (datetime)description: Optional description of this access token. (string)user: The user representing the token owner (id)token: (string)refresh_token: (field)application: (id)expires: (datetime)scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)Make a PUT or PATCH request to this resource to update this\naccess token. The following fields may be modified:
\ndescription: Optional description of this access token. (string, default=\"\")
scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")
For a PATCH request, include only the fields that are being modified.
", "operationId":"Authentication_tokens_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "scope":"write" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "application":1, "created":"2018-02-01T08:00:00.000000Z", "description":"", "expires":"2018-02-01T08:00:00.000000Z", "id":1, "modified":"2018-02-01T08:00:00.000000Z", "refresh_token":"************", "related":{ "activity_stream":"/api/v2/tokens/1/activity_stream/", "application":"/api/v2/applications/1/", "user":"/api/v2/users/1/" }, "scope":"write", "summary_fields":{ "application":{ "id":1, "name":"test app" }, "user":{ "first_name":"", "id":1, "last_name":"", "username":"admin" } }, "token":"************", "type":"o_auth2_access_token", "url":"/api/v2/tokens/1/", "user":1 } } } }, "summary":" Update an Access Token", "tags":[ "Authentication" ], "x-internal-id":"api-v2-tokens-{id}--patch", "x-filename-id":"api-v2-tokens-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\naccess token. The following fields may be modified:
\ndescription: Optional description of this access token. (string, default=\"\")
scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")
For a PUT request, include all fields in the request.
", "operationId":"Authentication_tokens_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "scope":{ "description":"Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", "type":"string" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update an Access Token", "tags":[ "Authentication" ], "x-internal-id":"api-v2-tokens-{id}--put", "x-filename-id":"api-v2-tokens-id-put" } }, "/api/v2/tokens/{id}/activity_stream/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\naccess token.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\nunified job templates.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of unified job templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more unified job template records.
Each unified job template data structure includes the following fields:
\nid: Database ID for this unified job template. (integer)type: Data type for this unified job template. (choice)url: URL for this unified job template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this unified job template was created. (datetime)modified: Timestamp when this unified job template was last modified. (datetime)name: Name of this unified job template. (string)description: Optional description of this unified job template. (string)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedok: OKmissing: Missingnone: No External Sourceupdating: UpdatingTo specify that unified job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\nunified jobs.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of unified jobs\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more unified job records.
Each unified job data structure includes the following fields:
\nid: Database ID for this unified job. (integer)type: Data type for this unified job. (choice)url: URL for this unified job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this unified job was created. (datetime)modified: Timestamp when this unified job was last modified. (datetime)name: Name of this unified job. (string)description: Optional description of this unified job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)controller_node: The instance that managed the isolated execution environment. (string)To specify that unified jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\nusers.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following user\nfields to create a new user:
\nusername: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)first_name: (string, default=\"\")last_name: (string, default=\"\")email: (string, default=\"\")is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)is_system_auditor: (boolean, default=False)password: Write-only field used to change the password. (string, default=\"\")Make a DELETE request to this resource to delete this user.
", "operationId":"Users_users_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}--delete", "x-filename-id":"api-v2-users-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single user\nrecord containing the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)Make a PUT or PATCH request to this resource to update this\nuser. The following fields may be modified:
\nusername: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)first_name: (string, default=\"\")last_name: (string, default=\"\")email: (string, default=\"\")is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)is_system_auditor: (boolean, default=False)password: Write-only field used to change the password. (string, default=\"\")For a PATCH request, include only the fields that are being modified.
", "operationId":"Users_users_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "last_login":"2018-02-01T08:00:00.000000Z" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "auth":[ ], "created":"2018-02-01T08:00:00.000000Z", "email":"", "external_account":null, "first_name":"", "id":1, "is_superuser":true, "is_system_auditor":false, "last_login":null, "last_name":"", "ldap_dn":"", "related":{ "access_list":"/api/v2/users/1/access_list/", "activity_stream":"/api/v2/users/1/activity_stream/", "admin_of_organizations":"/api/v2/users/1/admin_of_organizations/", "authorized_tokens":"/api/v2/users/1/authorized_tokens/", "credentials":"/api/v2/users/1/credentials/", "organizations":"/api/v2/users/1/organizations/", "personal_tokens":"/api/v2/users/1/personal_tokens/", "projects":"/api/v2/users/1/projects/", "roles":"/api/v2/users/1/roles/", "teams":"/api/v2/users/1/teams/", "tokens":"/api/v2/users/1/tokens/" }, "summary_fields":{ "user_capabilities":{ "delete":false, "edit":true } }, "type":"user", "url":"/api/v2/users/1/", "username":"admin" } } } }, "summary":" Update a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}--patch", "x-filename-id":"api-v2-users-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\nuser. The following fields may be modified:
\nusername: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)first_name: (string, default=\"\")last_name: (string, default=\"\")email: (string, default=\"\")is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)is_system_auditor: (boolean, default=False)password: Write-only field used to change the password. (string, default=\"\")For a PUT request, include all fields in the request.
", "operationId":"Users_users_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "email":{ "description":"", "type":"string" }, "first_name":{ "description":"", "type":"string" }, "is_superuser":{ "description":"Designates that this user has all permissions without explicitly assigning them.", "type":"boolean" }, "is_system_auditor":{ "description":"", "type":"boolean" }, "last_name":{ "description":"", "type":"string" }, "password":{ "description":"Write-only field used to change the password.", "type":"string" }, "username":{ "description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type":"string" } }, "required":[ "username" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}--put", "x-filename-id":"api-v2-users-id-put" } }, "/api/v2/users/{id}/access_list/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nusers.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nuser.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\norganizations of which the selected\nuser is an admin.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of organizations\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more organization records.
Each organization data structure includes the following fields:
\nid: Database ID for this organization. (integer)type: Data type for this organization. (choice)url: URL for this organization. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this organization was created. (datetime)modified: Timestamp when this organization was last modified. (datetime)name: Name of this organization. (string)description: Optional description of this organization. (string)max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)To specify that organizations are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\napplications.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of applications\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more application records.
Each application data structure includes the following fields:
\nid: Database ID for this application. (integer)type: Data type for this application. (choice)url: URL for this application. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this application was created. (datetime)modified: Timestamp when this application was last modified. (datetime)name: Name of this application. (string)description: Optional description of this application. (string)client_id: (string)client_secret: Used for more stringent verification of access to an application when creating a token. (string)client_type: Set to Public or Confidential depending on how secure the client device is. (choice)confidential: Confidentialpublic: Publicredirect_uris: Allowed URIs list, space separated (string)authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice)authorization-code: Authorization codepassword: Resource owner password-basedskip_authorization: Set True to skip authorization step for completely trusted applications. (boolean)organization: Organization containing this application. (id)To specify that applications are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following application\nfields to create a new application:
\nname: Name of this application. (string, required)description: Optional description of this application. (string, default=\"\")
client_type: Set to Public or Confidential depending on how secure the client device is. (choice, required)
confidential: Confidentialpublic: Publicredirect_uris: Allowed URIs list, space separated (string, default=\"\")authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice, required)authorization-code: Authorization codepassword: Resource owner password-basedskip_authorization: Set True to skip authorization step for completely trusted applications. (boolean, default=False)organization: Organization containing this application. (id, required)Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of access tokens\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more access token records.
Each access token data structure includes the following fields:
\nid: Database ID for this access token. (integer)type: Data type for this access token. (choice)url: URL for this access token. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this access token was created. (datetime)modified: Timestamp when this access token was last modified. (datetime)description: Optional description of this access token. (string)user: The user representing the token owner (id)token: (string)refresh_token: (field)application: (id)expires: (datetime)scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)To specify that access tokens are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following access token\nfields to create a new access token associated with this\nuser.
\ndescription: Optional description of this access token. (string, default=\"\")
application: (id, required)
scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")
Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nuser.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential\nfields to create a new credential associated with this\nuser.
\nname: Name of this credential. (string, required)description: Optional description of this credential. (string, default=\"\")credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)
inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
Make a GET request to this resource to retrieve a list of\norganizations associated with the selected\nuser.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of organizations\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more organization records.
Each organization data structure includes the following fields:
\nid: Database ID for this organization. (integer)type: Data type for this organization. (choice)url: URL for this organization. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this organization was created. (datetime)modified: Timestamp when this organization was last modified. (datetime)name: Name of this organization. (string)description: Optional description of this organization. (string)max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)To specify that organizations are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of access tokens\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more access token records.
Each access token data structure includes the following fields:
\nid: Database ID for this access token. (integer)type: Data type for this access token. (choice)url: URL for this access token. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this access token was created. (datetime)modified: Timestamp when this access token was last modified. (datetime)description: Optional description of this access token. (string)user: The user representing the token owner (id)token: (string)refresh_token: (field)application: (id)expires: (datetime)scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)To specify that access tokens are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following access token\nfields to create a new access token associated with this\nuser.
\ndescription: Optional description of this access token. (string, default=\"\")
scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")
Make a GET request to this resource to retrieve a list of\nprojects associated with the selected\nuser.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of projects\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more project records.
Each project data structure includes the following fields:
\nid: Database ID for this project. (integer)type: Data type for this project. (choice)url: URL for this project. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this project was created. (datetime)modified: Timestamp when this project was last modified. (datetime)name: Name of this project. (string)description: Optional description of this project. (string)local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)scm_type: Specifies the source control system used to store the project. (choice)\"\": Manualgit: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: Remote Archivescm_url: The location where the project is stored. (string)scm_branch: Specific branch, tag or commit to checkout. (string)scm_refspec: For git projects, an additional refspec to fetch. (string)scm_clean: Discard any local changes before syncing the project. (boolean)scm_delete_on_update: Delete the project before syncing. (boolean)credential: (id)timeout: The amount of time (in seconds) to run before the task is canceled. (integer)scm_revision: The last revision fetched by a project update (string)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedok: OKmissing: Missingorganization: The organization used to determine access to this template. (id)scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean)scm_update_cache_timeout: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)last_update_failed: (boolean)last_updated: (datetime)To specify that projects are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of roles associated with the selected user.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource to add or remove a role from this user. The following fields may be modified:
\nid: The Role ID to add to the user. (int, required)disassociate: Provide if you want to remove the role. (any value, optional)Make a GET request to this resource to retrieve a list of\nteams associated with the selected\nuser.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of teams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more team records.
Each team data structure includes the following fields:
\nid: Database ID for this team. (integer)type: Data type for this team. (choice)url: URL for this team. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this team was created. (datetime)modified: Timestamp when this team was last modified. (datetime)name: Name of this team. (string)description: Optional description of this team. (string)organization: (id)To specify that teams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of access tokens\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more access token records.
Each access token data structure includes the following fields:
\nid: Database ID for this access token. (integer)type: Data type for this access token. (choice)url: URL for this access token. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this access token was created. (datetime)modified: Timestamp when this access token was last modified. (datetime)description: Optional description of this access token. (string)user: The user representing the token owner (id)token: (string)refresh_token: (field)application: (id)expires: (datetime)scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)To specify that access tokens are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following access token\nfields to create a new access token associated with this\nuser.
\ndescription: Optional description of this access token. (string, default=\"\")
application: (id, default=``)
scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")
Make a DELETE request to this resource to delete this workflow approval template.
", "operationId":"Workflow Approval Templates_workflow_approval_templates_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete a Workflow Approval Template", "tags":[ "Workflow Approval Templates" ], "x-internal-id":"api-v2-workflow_approval_templates-{id}--delete", "x-filename-id":"api-v2-workflow_approval_templates-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single workflow approval template\nrecord containing the following fields:
\nid: Database ID for this workflow approval template. (integer)type: Data type for this workflow approval template. (choice)url: URL for this workflow approval template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow approval template was created. (datetime)modified: Timestamp when this workflow approval template was last modified. (datetime)name: Name of this workflow approval template. (string)description: Optional description of this workflow approval template. (string)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedok: OKmissing: Missingnone: No External Sourceupdating: Updatingtimeout: The amount of time (in seconds) before the approval node expires and fails. (integer)Make a PUT or PATCH request to this resource to update this\nworkflow approval template. The following fields may be modified:
\nname: Name of this workflow approval template. (string, required)description: Optional description of this workflow approval template. (string, default=\"\")
timeout: The amount of time (in seconds) before the approval node expires and fails. (integer, default=0)
For a PATCH request, include only the fields that are being modified.
", "operationId":"Workflow Approval Templates_workflow_approval_templates_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "name":{ "description":"", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) before the approval node expires and fails.", "type":"integer" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Workflow Approval Template", "tags":[ "Workflow Approval Templates" ], "x-internal-id":"api-v2-workflow_approval_templates-{id}--patch", "x-filename-id":"api-v2-workflow_approval_templates-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\nworkflow approval template. The following fields may be modified:
\nname: Name of this workflow approval template. (string, required)description: Optional description of this workflow approval template. (string, default=\"\")
timeout: The amount of time (in seconds) before the approval node expires and fails. (integer, default=0)
For a PUT request, include all fields in the request.
", "operationId":"Workflow Approval Templates_workflow_approval_templates_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "description":{ "description":"", "type":"string" }, "name":{ "description":"", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) before the approval node expires and fails.", "type":"integer" } }, "required":[ "name" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Workflow Approval Template", "tags":[ "Workflow Approval Templates" ], "x-internal-id":"api-v2-workflow_approval_templates-{id}--put", "x-filename-id":"api-v2-workflow_approval_templates-id-put" } }, "/api/v2/workflow_approval_templates/{id}/approvals/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nworkflow approvals associated with the selected\nworkflow approval template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow approvals\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow approval records.
Each workflow approval data structure includes the following fields:
\nid: Database ID for this workflow approval. (integer)type: Data type for this workflow approval. (choice)url: URL for this workflow approval. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow approval was created. (datetime)modified: Timestamp when this workflow approval was last modified. (datetime)name: Name of this workflow approval. (string)description: Optional description of this workflow approval. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)can_approve_or_deny: (field)approval_expiration: (field)timed_out: (boolean)To specify that workflow approvals are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\nworkflow approvals.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow approvals\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow approval records.
Each workflow approval data structure includes the following fields:
\nid: Database ID for this workflow approval. (integer)type: Data type for this workflow approval. (choice)url: URL for this workflow approval. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow approval was created. (datetime)modified: Timestamp when this workflow approval was last modified. (datetime)name: Name of this workflow approval. (string)description: Optional description of this workflow approval. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)can_approve_or_deny: (field)approval_expiration: (field)timed_out: (boolean)To specify that workflow approvals are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following workflow approval\nfields to create a new workflow approval:
\nname: Name of this workflow approval. (string, required)description: Optional description of this workflow approval. (string, default=\"\")Make a DELETE request to this resource to delete this workflow approval.
", "operationId":"Workflow Approvals_workflow_approvals_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete a Workflow Approval", "tags":[ "Workflow Approvals" ], "x-internal-id":"api-v2-workflow_approvals-{id}--delete", "x-filename-id":"api-v2-workflow_approvals-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:
\nid: Database ID for this workflow approval. (integer)type: Data type for this workflow approval. (choice)url: URL for this workflow approval. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow approval was created. (datetime)modified: Timestamp when this workflow approval was last modified. (datetime)name: Name of this workflow approval. (string)description: Optional description of this workflow approval. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_args: (string)job_cwd: (string)job_env: (json)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)result_traceback: (string)event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)can_approve_or_deny: (field)approval_expiration: (field)timed_out: (boolean)Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:
", "operationId":"Workflow Approvals_workflow_approvals_approve_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":" Retrieve a Workflow Approval", "tags":[ "Workflow Approvals" ], "x-internal-id":"api-v2-workflow_approvals-{id}-approve--get", "x-filename-id":"api-v2-workflow_approvals-id-approve-get" }, "post":{ "description":"Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:
", "operationId":"Workflow Approvals_workflow_approvals_approve_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "201":{ "description":"" }, "400":{ "examples":{ "application/json":{ "error":"This workflow step has already been approved or denied." } }, "description":"" } }, "summary":" Retrieve a Workflow Approval", "tags":[ "Workflow Approvals" ], "x-internal-id":"api-v2-workflow_approvals-{id}-approve--post", "x-filename-id":"api-v2-workflow_approvals-id-approve-post" } }, "/api/v2/workflow_approvals/{id}/deny/":{ "get":{ "description":"Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:
", "operationId":"Workflow Approvals_workflow_approvals_deny_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":" Retrieve a Workflow Approval", "tags":[ "Workflow Approvals" ], "x-internal-id":"api-v2-workflow_approvals-{id}-deny--get", "x-filename-id":"api-v2-workflow_approvals-id-deny-get" }, "post":{ "description":"Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:
", "operationId":"Workflow Approvals_workflow_approvals_deny_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "201":{ "description":"" }, "400":{ "examples":{ "application/json":{ "error":"This workflow step has already been approved or denied." } }, "description":"" } }, "summary":" Retrieve a Workflow Approval", "tags":[ "Workflow Approvals" ], "x-internal-id":"api-v2-workflow_approvals-{id}-deny--post", "x-filename-id":"api-v2-workflow_approvals-id-deny-post" } }, "/api/v2/workflow_job_nodes/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nworkflow job nodes.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow job nodes\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job node records.
Each workflow job node data structure includes the following fields:
\nid: Database ID for this workflow job node. (integer)type: Data type for this workflow job node. (choice)url: URL for this workflow job node. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job node was created. (datetime)modified: Timestamp when this workflow job node was last modified. (datetime)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)job: (id)workflow_job: (id)unified_job_template: (id)success_nodes: (field)failure_nodes: (field)always_nodes: (field)all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)do_not_run: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)To specify that workflow job nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake GET request to this resource to retrieve a single workflow job node\nrecord containing the following fields:
\nid: Database ID for this workflow job node. (integer)type: Data type for this workflow job node. (choice)url: URL for this workflow job node. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job node was created. (datetime)modified: Timestamp when this workflow job node was last modified. (datetime)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)job: (id)workflow_job: (id)unified_job_template: (id)success_nodes: (field)failure_nodes: (field)always_nodes: (field)all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)do_not_run: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job node.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow job nodes\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job node records.
Each workflow job node data structure includes the following fields:
\nid: Database ID for this workflow job node. (integer)type: Data type for this workflow job node. (choice)url: URL for this workflow job node. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job node was created. (datetime)modified: Timestamp when this workflow job node was last modified. (datetime)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)job: (id)workflow_job: (id)unified_job_template: (id)success_nodes: (field)failure_nodes: (field)always_nodes: (field)all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)do_not_run: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)To specify that workflow job nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nworkflow job node.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: (id)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job node.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow job nodes\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job node records.
Each workflow job node data structure includes the following fields:
\nid: Database ID for this workflow job node. (integer)type: Data type for this workflow job node. (choice)url: URL for this workflow job node. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job node was created. (datetime)modified: Timestamp when this workflow job node was last modified. (datetime)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)job: (id)workflow_job: (id)unified_job_template: (id)success_nodes: (field)failure_nodes: (field)always_nodes: (field)all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)do_not_run: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)To specify that workflow job nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job node.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow job nodes\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job node records.
Each workflow job node data structure includes the following fields:
\nid: Database ID for this workflow job node. (integer)type: Data type for this workflow job node. (choice)url: URL for this workflow job node. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job node was created. (datetime)modified: Timestamp when this workflow job node was last modified. (datetime)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)job: (id)workflow_job: (id)unified_job_template: (id)success_nodes: (field)failure_nodes: (field)always_nodes: (field)all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)do_not_run: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)To specify that workflow job nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve the list of\nworkflow job template nodes.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow job template nodes\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job template node records.
Each workflow job template node data structure includes the following fields:
\nid: Database ID for this workflow job template node. (integer)type: Data type for this workflow job template node. (choice)url: URL for this workflow job template node. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job template node was created. (datetime)modified: Timestamp when this workflow job template node was last modified. (datetime)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)workflow_job_template: (id)unified_job_template: (id)success_nodes: (field)failure_nodes: (field)always_nodes: (field)all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)To specify that workflow job template nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following workflow job template node\nfields to create a new workflow job template node:
\nextra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)workflow_job_template: (id, required)unified_job_template: (id, default=``)
all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=False)
identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\")Make a DELETE request to this resource to delete this workflow job template node.
", "operationId":"Workflow Job Template Nodes_workflow_job_template_nodes_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}--delete", "x-filename-id":"api-v2-workflow_job_template_nodes-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:
\nid: Database ID for this workflow job template node. (integer)type: Data type for this workflow job template node. (choice)url: URL for this workflow job template node. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job template node was created. (datetime)modified: Timestamp when this workflow job template node was last modified. (datetime)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)workflow_job_template: (id)unified_job_template: (id)success_nodes: (field)failure_nodes: (field)always_nodes: (field)all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)Make a PUT or PATCH request to this resource to update this\nworkflow job template node. The following fields may be modified:
\nextra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)workflow_job_template: (id, required)unified_job_template: (id, default=``)
all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=False)
identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\")For a PATCH request, include only the fields that are being modified.
", "operationId":"Workflow Job Template Nodes_workflow_job_template_nodes_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "all_parents_must_converge":{ "description":"If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node", "type":"boolean" }, "diff_mode":{ "description":"", "type":"boolean" }, "extra_data":{ "description":"", "type":"string" }, "identifier":{ "description":"An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", "type":"string" }, "inventory":{ "description":"Inventory applied as a prompt, assuming job template prompts for inventory", "type":"integer" }, "job_tags":{ "description":"", "type":"string" }, "job_type":{ "description":"", "type":"string" }, "limit":{ "description":"", "type":"string" }, "scm_branch":{ "description":"", "type":"string" }, "skip_tags":{ "description":"", "type":"string" }, "unified_job_template":{ "description":"", "type":"integer" }, "verbosity":{ "description":"", "type":"string" }, "workflow_job_template":{ "description":"", "type":"string" } }, "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}--patch", "x-filename-id":"api-v2-workflow_job_template_nodes-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\nworkflow job template node. The following fields may be modified:
\nextra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)workflow_job_template: (id, required)unified_job_template: (id, default=``)
all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=False)
identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\")For a PUT request, include all fields in the request.
", "operationId":"Workflow Job Template Nodes_workflow_job_template_nodes_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "all_parents_must_converge":{ "description":"If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node", "type":"boolean" }, "diff_mode":{ "description":"", "type":"boolean" }, "extra_data":{ "description":"", "type":"string" }, "identifier":{ "description":"An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", "type":"string" }, "inventory":{ "description":"Inventory applied as a prompt, assuming job template prompts for inventory", "type":"integer" }, "job_tags":{ "description":"", "type":"string" }, "job_type":{ "description":"", "type":"string" }, "limit":{ "description":"", "type":"string" }, "scm_branch":{ "description":"", "type":"string" }, "skip_tags":{ "description":"", "type":"string" }, "unified_job_template":{ "description":"", "type":"integer" }, "verbosity":{ "description":"", "type":"string" }, "workflow_job_template":{ "description":"", "type":"string" } }, "required":[ "workflow_job_template" ], "type":"object" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}--put", "x-filename-id":"api-v2-workflow_job_template_nodes-id-put" } }, "/api/v2/workflow_job_template_nodes/{id}/always_nodes/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow job template nodes\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job template node records.
Each workflow job template node data structure includes the following fields:
\nid: Database ID for this workflow job template node. (integer)type: Data type for this workflow job template node. (choice)url: URL for this workflow job template node. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job template node was created. (datetime)modified: Timestamp when this workflow job template node was last modified. (datetime)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)workflow_job_template: (id)unified_job_template: (id)success_nodes: (field)failure_nodes: (field)always_nodes: (field)all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)To specify that workflow job template nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following workflow job template node\nfields to create a new workflow job template node associated with this\nworkflow job template node.
\nextra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)workflow_job_template: (id, required)unified_job_template: (id, default=``)
all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=False)
identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\")Make a POST request to this resource with only an id field to associate an\nexisting workflow job template node with this workflow job template node.
Make a POST request to this resource with id and disassociate fields to\nremove the workflow job template node from this workflow job template node\n without deleting the workflow job template node.
Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:
\ntimeout: The amount of time (in seconds) before the approval node expires and fails. (integer)name: Name of this workflow approval template. (string)description: Optional description of this workflow approval template. (string)Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:
\ntimeout: The amount of time (in seconds) before the approval node expires and fails. (integer)name: Name of this workflow approval template. (string)description: Optional description of this workflow approval template. (string)Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nworkflow job template node.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of credentials\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more credential records.
Each credential data structure includes the following fields:
\nid: Database ID for this credential. (integer)type: Data type for this credential. (choice)url: URL for this credential. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this credential was created. (datetime)modified: Timestamp when this credential was last modified. (datetime)name: Name of this credential. (string)description: Optional description of this credential. (string)organization: (id)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id)managed_by_tower: (boolean)inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)kind: (field)cloud: (field)kubernetes: (field)To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following credential\nfields to create a new credential associated with this\nworkflow job template node.
\nname: Name of this credential. (string, required)description: Optional description of this credential. (string, default=\"\")organization: (id, default=None)credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)
inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json, default={})
Make a POST request to this resource with only an id field to associate an\nexisting credential with this workflow job template node.
Make a POST request to this resource with id and disassociate fields to\nremove the credential from this workflow job template node\n without deleting the credential.
Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow job template nodes\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job template node records.
Each workflow job template node data structure includes the following fields:
\nid: Database ID for this workflow job template node. (integer)type: Data type for this workflow job template node. (choice)url: URL for this workflow job template node. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job template node was created. (datetime)modified: Timestamp when this workflow job template node was last modified. (datetime)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)workflow_job_template: (id)unified_job_template: (id)success_nodes: (field)failure_nodes: (field)always_nodes: (field)all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)To specify that workflow job template nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following workflow job template node\nfields to create a new workflow job template node associated with this\nworkflow job template node.
\nextra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)workflow_job_template: (id, required)unified_job_template: (id, default=``)
all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=False)
identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\")Make a POST request to this resource with only an id field to associate an\nexisting workflow job template node with this workflow job template node.
Make a POST request to this resource with id and disassociate fields to\nremove the workflow job template node from this workflow job template node\n without deleting the workflow job template node.
Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow job template nodes\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job template node records.
Each workflow job template node data structure includes the following fields:
\nid: Database ID for this workflow job template node. (integer)type: Data type for this workflow job template node. (choice)url: URL for this workflow job template node. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job template node was created. (datetime)modified: Timestamp when this workflow job template node was last modified. (datetime)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)workflow_job_template: (id)unified_job_template: (id)success_nodes: (field)failure_nodes: (field)always_nodes: (field)all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)To specify that workflow job template nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following workflow job template node\nfields to create a new workflow job template node associated with this\nworkflow job template node.
\nextra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)workflow_job_template: (id, required)unified_job_template: (id, default=``)
all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=False)
identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\")Make a POST request to this resource with only an id field to associate an\nexisting workflow job template node with this workflow job template node.
Make a POST request to this resource with id and disassociate fields to\nremove the workflow job template node from this workflow job template node\n without deleting the workflow job template node.
Make a GET request to this resource to retrieve the list of\nworkflow job templates.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow job templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job template records.
Each workflow job template data structure includes the following fields:
\nid: Database ID for this workflow job template. (integer)type: Data type for this workflow job template. (choice)url: URL for this workflow job template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job template was created. (datetime)modified: Timestamp when this workflow job template was last modified. (datetime)name: Name of this workflow job template. (string)description: Optional description of this workflow job template. (string)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedok: OKmissing: Missingnone: No External Sourceupdating: Updatingextra_vars: (json)organization: The organization used to determine access to this template. (id)survey_enabled: (boolean)allow_simultaneous: (boolean)ask_variables_on_launch: (boolean)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)limit: (string)scm_branch: (string)ask_inventory_on_launch: (boolean)ask_scm_branch_on_launch: (boolean)ask_limit_on_launch: (boolean)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)To specify that workflow job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following workflow job template\nfields to create a new workflow job template:
\nname: 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: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)Make a DELETE request to this resource to delete this workflow job template.
", "operationId":"Workflow Job Templates_workflow_job_templates_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"" } }, "summary":" Delete a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}--delete", "x-filename-id":"api-v2-workflow_job_templates-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single workflow job template\nrecord containing the following fields:
\nid: Database ID for this workflow job template. (integer)type: Data type for this workflow job template. (choice)url: URL for this workflow job template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job template was created. (datetime)modified: Timestamp when this workflow job template was last modified. (datetime)name: Name of this workflow job template. (string)description: Optional description of this workflow job template. (string)last_job_run: (datetime)last_job_failed: (boolean)next_job_run: (datetime)status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Cancelednever updated: Never Updatedok: OKmissing: Missingnone: No External Sourceupdating: Updatingextra_vars: (json)organization: The organization used to determine access to this template. (id)survey_enabled: (boolean)allow_simultaneous: (boolean)ask_variables_on_launch: (boolean)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)limit: (string)scm_branch: (string)ask_inventory_on_launch: (boolean)ask_scm_branch_on_launch: (boolean)ask_limit_on_launch: (boolean)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)Make a PUT or PATCH request to this resource to update this\nworkflow job template. The following fields may be modified:
\nname: 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: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)For a PATCH request, include only the fields that are being modified.
", "operationId":"Workflow Job Templates_workflow_job_templates_partial_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "example":{ "name":"foooooo" } } } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "allow_simultaneous":false, "ask_inventory_on_launch":false, "ask_limit_on_launch":false, "ask_scm_branch_on_launch":false, "ask_variables_on_launch":false, "created":"2018-02-01T08:00:00.000000Z", "description":"", "extra_vars":"", "id":1, "inventory":null, "last_job_failed":false, "last_job_run":null, "limit":null, "modified":"2018-02-01T08:00:00.000000Z", "name":"foooooo", "next_job_run":null, "organization":1, "related":{ "access_list":"/api/v2/workflow_job_templates/1/access_list/", "activity_stream":"/api/v2/workflow_job_templates/1/activity_stream/", "copy":"/api/v2/workflow_job_templates/1/copy/", "labels":"/api/v2/workflow_job_templates/1/labels/", "launch":"/api/v2/workflow_job_templates/1/launch/", "notification_templates_approvals":"/api/v2/workflow_job_templates/1/notification_templates_approvals/", "notification_templates_error":"/api/v2/workflow_job_templates/1/notification_templates_error/", "notification_templates_started":"/api/v2/workflow_job_templates/1/notification_templates_started/", "notification_templates_success":"/api/v2/workflow_job_templates/1/notification_templates_success/", "object_roles":"/api/v2/workflow_job_templates/1/object_roles/", "organization":"/api/v2/organizations/1/", "schedules":"/api/v2/workflow_job_templates/1/schedules/", "survey_spec":"/api/v2/workflow_job_templates/1/survey_spec/", "webhook_key":"/api/v2/workflow_job_templates/1/webhook_key/", "webhook_receiver":"", "workflow_jobs":"/api/v2/workflow_job_templates/1/workflow_jobs/", "workflow_nodes":"/api/v2/workflow_job_templates/1/workflow_nodes/" }, "scm_branch":null, "status":"never updated", "summary_fields":{ "labels":{ "count":0, "results":[ ] }, "object_roles":{ "admin_role":{ "description":"Can manage all aspects of the workflow job template", "id":15, "name":"Admin" }, "approval_role":{ "description":"Can approve or deny a workflow approval node", "id":18, "name":"Approve" }, "execute_role":{ "description":"May run the workflow job template", "id":16, "name":"Execute" }, "read_role":{ "description":"May view settings for the workflow job template", "id":17, "name":"Read" } }, "organization":{ "description":"test-org-desc", "id":1, "name":"test-org" }, "recent_jobs":[ ], "user_capabilities":{ "copy":true, "delete":true, "edit":true, "schedule":true, "start":true } }, "survey_enabled":false, "type":"workflow_job_template", "url":"/api/v2/workflow_job_templates/1/", "webhook_credential":null, "webhook_service":"" } } } }, "summary":" Update a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}--patch", "x-filename-id":"api-v2-workflow_job_templates-id-patch" }, "put":{ "consumes":[ "application/json" ], "description":"Make a PUT or PATCH request to this resource to update this\nworkflow job template. The following fields may be modified:
\nname: 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: GitHubgitlab: GitLabwebhook_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.
", "operationId":"Workflow Job Templates_workflow_job_templates_update", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" }, { "in":"body", "name":"data", "schema":{ "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" } } ], "responses":{ "200":{ "description":"" } }, "summary":" Update a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}--put", "x-filename-id":"api-v2-workflow_job_templates-id-put" } }, "/api/v2/workflow_job_templates/{id}/access_list/":{ "get":{ "description":"Make a GET request to this resource to retrieve the list of\nusers.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of users\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more user records.
Each user data structure includes the following fields:
\nid: Database ID for this user. (integer)type: Data type for this user. (choice)url: URL for this user. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this user was created. (datetime)username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)first_name: (string)last_name: (string)email: (string)is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)is_system_auditor: (boolean)
ldap_dn: (string)
last_login: (datetime)external_account: Set if the account is managed by an external service (field)To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=username\nPrefix the field name with a dash - to sort in reverse:
?order_by=-username\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=username,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nworkflow job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to determine if the current user has\npermission to copy the workflow job template and whether any linked\ntemplates or prompted fields will be ignored due to permissions problems.\nThe response will include the following fields:
\ncan_copy: Flag indicating whether the active user has permission to make\n a copy of this workflow job template, provides same content as the\n workflow job template detail view summary_fields.user_capabilities.copy\n (boolean, read-only)can_copy_without_user_input: Flag indicating if the user should be\n prompted for confirmation before the copy is executed (boolean, read-only)templates_unable_to_copy: List of node ids of nodes that have a related\n job template, project, or inventory that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)inventories_unable_to_copy: List of node ids of nodes that have a related\n prompted inventory that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)credentials_unable_to_copy: List of node ids of nodes that have a related\n prompted credential that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)Make a POST request to this endpoint to save a copy of this\nworkflow job template. No POST data is accepted for this action.
\nIf successful, the response status code will be 201. The response body will\ncontain serialized data about the new workflow job template, which will be\nsimilar to the original workflow job template, but with an additional @\nand a timestamp in the name.
All workflow nodes and connections in the original will also exist in the\ncopy. The nodes will be missing related resources if the user did not have\naccess to use them.
", "operationId":"Workflow Job Templates_workflow_job_templates_copy_list", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A page number within the paginated result set.", "in":"query", "name":"page", "required":false, "type":"integer" }, { "description":"Number of results to return per page.", "in":"query", "name":"page_size", "required":false, "type":"integer" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":"Copy a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-copy--get", "x-filename-id":"api-v2-workflow_job_templates-id-copy-get" }, "post":{ "consumes":[ "application/json" ], "description":"Make a GET request to this resource to determine if the current user has\npermission to copy the workflow job template and whether any linked\ntemplates or prompted fields will be ignored due to permissions problems.\nThe response will include the following fields:
\ncan_copy: Flag indicating whether the active user has permission to make\n a copy of this workflow job template, provides same content as the\n workflow job template detail view summary_fields.user_capabilities.copy\n (boolean, read-only)can_copy_without_user_input: Flag indicating if the user should be\n prompted for confirmation before the copy is executed (boolean, read-only)templates_unable_to_copy: List of node ids of nodes that have a related\n job template, project, or inventory that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)inventories_unable_to_copy: List of node ids of nodes that have a related\n prompted inventory that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)credentials_unable_to_copy: List of node ids of nodes that have a related\n prompted credential that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)Make a POST request to this endpoint to save a copy of this\nworkflow job template. No POST data is accepted for this action.
\nIf successful, the response status code will be 201. The response body will\ncontain serialized data about the new workflow job template, which will be\nsimilar to the original workflow job template, but with an additional @\nand a timestamp in the name.
All workflow nodes and connections in the original will also exist in the\ncopy. The nodes will be missing related resources if the user did not have\naccess to use them.
", "operationId":"Workflow Job Templates_workflow_job_templates_copy_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "name":{ "description":"", "type":"string" } }, "required":[ "name" ], "type":"object" } } ], "responses":{ "201":{ "description":"" } }, "summary":"Copy a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-copy--post", "x-filename-id":"api-v2-workflow_job_templates-id-copy-post" } }, "/api/v2/workflow_job_templates/{id}/github/":{ "post":{ "operationId":"Workflow Job Templates_workflow_job_templates_github_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "responses":{ "201":{ "description":"" } }, "tags":[ "Workflow Job Templates" ], "summary":"Workflow Job Templates Github Create", "x-internal-id":"api-v2-workflow_job_templates-{id}-github--post", "x-filename-id":"api-v2-workflow_job_templates-id-github-post" } }, "/api/v2/workflow_job_templates/{id}/gitlab/":{ "post":{ "operationId":"Workflow Job Templates_workflow_job_templates_gitlab_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "responses":{ "201":{ "description":"" } }, "tags":[ "Workflow Job Templates" ], "summary":"Workflow Job Templates Gitlab Create", "x-internal-id":"api-v2-workflow_job_templates-{id}-gitlab--post", "x-filename-id":"api-v2-workflow_job_templates-id-gitlab-post" } }, "/api/v2/workflow_job_templates/{id}/labels/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of labels\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more label records.
Each label data structure includes the following fields:
\nid: Database ID for this label. (integer)type: Data type for this label. (choice)url: URL for this label. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this label was created. (datetime)modified: Timestamp when this label was last modified. (datetime)name: Name of this label. (string)organization: Organization this label belongs to. (id)To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following label\nfields to create a new label associated with this\nworkflow job template.
\nname: Name of this label. (string, required)organization: Organization this label belongs to. (id, required)Make a POST request to this resource with only an id field to associate an\nexisting label with this workflow job template.
Make a POST request to this resource with id and disassociate fields to\nremove the label from this workflow job template\n.
Labels not associated with any other resources are deleted. A label can become disassociated with a resource as a result of 3 events.
\nMake a GET request to this resource to determine if the workflow_job_template\ncan be launched and whether any passwords are required to launch the\nworkflow_job_template. The response will include the following fields:
\ncan_start_without_user_input: Flag indicating if the workflow_job_template\n can be launched without user-input (boolean, read-only)variables_needed_to_start: Required variable names required to launch the\n workflow_job_template (array, read-only)survey_enabled: Flag indicating whether the workflow_job_template has an\n enabled survey (boolean, read-only)extra_vars: Text which is the extra_vars field of this workflow_job_template\n (text, read-only)node_templates_missing: List of node ids of all nodes that have a\n null unified_job_template, which will cause their branches to stop\n execution (list, read-only)node_prompts_rejected: List of node ids of all nodes that have\n specified a field that will be rejected because its unified_job_template\n does not allow prompting for this field, this will not halt execution of\n the branch but the field will be ignored (list, read-only)workflow_job_template_data: JSON object listing general information of\n this workflow_job_template (JSON object, read-only)Make a POST request to this resource to launch the workflow_job_template. If any\ncredential, inventory, project or extra variables (extra_vars) are required, they\nmust be passed via POST data, with extra_vars given as a YAML or JSON string and\nescaped parentheses.
\nIf successful, the response status code will be 201. If any required passwords\nare not provided, a 400 status code will be returned. If the workflow job cannot\nbe launched, a 405 status code will be returned. If the provided credential or\ninventory are not allowed to be used by the user, then a 403 status code will\nbe returned.
", "operationId":"Workflow Job Templates_workflow_job_templates_launch_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":"Launch a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-launch--get", "x-filename-id":"api-v2-workflow_job_templates-id-launch-get" }, "post":{ "consumes":[ "application/json" ], "description":"Make a GET request to this resource to determine if the workflow_job_template\ncan be launched and whether any passwords are required to launch the\nworkflow_job_template. The response will include the following fields:
\ncan_start_without_user_input: Flag indicating if the workflow_job_template\n can be launched without user-input (boolean, read-only)variables_needed_to_start: Required variable names required to launch the\n workflow_job_template (array, read-only)survey_enabled: Flag indicating whether the workflow_job_template has an\n enabled survey (boolean, read-only)extra_vars: Text which is the extra_vars field of this workflow_job_template\n (text, read-only)node_templates_missing: List of node ids of all nodes that have a\n null unified_job_template, which will cause their branches to stop\n execution (list, read-only)node_prompts_rejected: List of node ids of all nodes that have\n specified a field that will be rejected because its unified_job_template\n does not allow prompting for this field, this will not halt execution of\n the branch but the field will be ignored (list, read-only)workflow_job_template_data: JSON object listing general information of\n this workflow_job_template (JSON object, read-only)Make a POST request to this resource to launch the workflow_job_template. If any\ncredential, inventory, project or extra variables (extra_vars) are required, they\nmust be passed via POST data, with extra_vars given as a YAML or JSON string and\nescaped parentheses.
\nIf successful, the response status code will be 201. If any required passwords\nare not provided, a 400 status code will be returned. If the workflow job cannot\nbe launched, a 405 status code will be returned. If the provided credential or\ninventory are not allowed to be used by the user, then a 403 status code will\nbe returned.
", "operationId":"Workflow Job Templates_workflow_job_templates_launch_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "in":"body", "name":"data", "schema":{ "properties":{ "ask_limit_on_launch":{ "description":"", "type":"boolean" }, "ask_scm_branch_on_launch":{ "description":"", "type":"boolean" }, "extra_vars":{ "description":"", "type":"string" }, "inventory":{ "description":"", "type":"integer" }, "limit":{ "description":"", "type":"string" }, "scm_branch":{ "description":"", "type":"string" } }, "type":"object" } } ], "produces":[ "application/json" ], "responses":{ "201":{ "description":"", "examples":{ "application/json":{ "allow_simultaneous":false, "canceled_on":null, "created":"2018-02-01T08:00:00.000000Z", "description":"", "elapsed":0, "extra_vars":"{}", "failed":false, "finished":null, "id":1, "ignored_fields":{ }, "inventory":null, "is_sliced_job":false, "job_args":"", "job_cwd":"", "job_env":{ }, "job_explanation":"", "job_template":null, "launch_type":"manual", "limit":null, "modified":"2018-02-01T08:00:00.000000Z", "name":"foobar", "related":{ "activity_stream":"/api/v2/workflow_jobs/1/activity_stream/", "cancel":"/api/v2/workflow_jobs/1/cancel/", "labels":"/api/v2/workflow_jobs/1/labels/", "notifications":"/api/v2/workflow_jobs/1/notifications/", "relaunch":"/api/v2/workflow_jobs/1/relaunch/", "unified_job_template":"/api/v2/workflow_job_templates/3/", "workflow_job_template":"/api/v2/workflow_job_templates/3/", "workflow_nodes":"/api/v2/workflow_jobs/1/workflow_nodes/" }, "result_traceback":"", "scm_branch":null, "started":null, "status":"pending", "summary_fields":{ "labels":{ "count":0, "results":[ ] }, "unified_job_template":{ "description":"", "id":3, "name":"foobar", "unified_job_type":"workflow_job" }, "user_capabilities":{ "delete":true, "start":true }, "workflow_job_template":{ "description":"", "id":3, "name":"foobar" } }, "type":"workflow_job", "unified_job_template":3, "url":"/api/v2/workflow_jobs/1/", "webhook_credential":null, "webhook_guid":"", "webhook_service":"", "workflow_job":1, "workflow_job_template":3 } } }, "400":{ "examples":{ "application/json":{ "inventory":[ "The inventory associated with this Workflow is being deleted." ] } }, "description":"" } }, "summary":"Launch a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-launch--post", "x-filename-id":"api-v2-workflow_job_templates-id-launch-post" } }, "/api/v2/workflow_job_templates/{id}/notification_templates_approvals/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nworkflow job template.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this workflow job template.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this workflow job template\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nworkflow job template.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this workflow job template.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this workflow job template\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nworkflow job template.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this workflow job template.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this workflow job template\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notification templates\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification template records.
Each notification template data structure includes the following fields:
\nid: Database ID for this notification template. (integer)type: Data type for this notification template. (choice)url: URL for this notification template. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification template was created. (datetime)modified: Timestamp when this notification template was last modified. (datetime)name: Name of this notification template. (string)description: Optional description of this notification template. (string)organization: (id)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json)messages: Optional custom messages for notification template. (json)To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nworkflow job template.
\nname: Name of this notification template. (string, required)description: Optional description of this notification template. (string, default=\"\")organization: (id, required)notification_type: (choice, required)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhooknotification_configuration: (json, default={})messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})Make a POST request to this resource with only an id field to associate an\nexisting notification template with this workflow job template.
Make a POST request to this resource with id and disassociate fields to\nremove the notification template from this workflow job template\n without deleting the notification template.
Make a GET request to this resource to retrieve a list of\nroles associated with the selected\nworkflow job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of roles\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more role records.
Each role data structure includes the following fields:
\nid: Database ID for this role. (integer)type: Data type for this role. (choice)url: URL for this role. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)name: Name of this role. (field)description: Optional description of this role. (field)To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nschedules associated with the selected\nworkflow job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of schedules\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more schedule records.
Each schedule data structure includes the following fields:
\nrrule: A value representing the schedules iCal recurrence rule. (string)id: Database ID for this schedule. (integer)type: Data type for this schedule. (choice)url: URL for this schedule. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this schedule was created. (datetime)modified: Timestamp when this schedule was last modified. (datetime)name: Name of this schedule. (string)description: Optional description of this schedule. (string)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)unified_job_template: (id)enabled: Enables processing of this schedule. (boolean)dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)next_run: The next time that the scheduled action will run. (datetime)timezone: (field)until: (field)To specify that schedules are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this resource with the following schedule\nfields to create a new schedule associated with this\nworkflow job template.
\nrrule: A value representing the schedules iCal recurrence rule. (string, required)
name: Name of this schedule. (string, required)
description: Optional description of this schedule. (string, default=\"\")extra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)
None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)enabled: Enables processing of this schedule. (boolean, default=True)
Here is an example survey specification:
\n{\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \"type\": \"text\",\n \"question_name\": \"example question\",\n \"question_description\": \"What is your favorite color?\",\n \"variable\": \"favorite_color\",\n \"required\": false,\n \"default\": \"blue\"\n }\n ]\n}\nname and description are required elements at the beginning of the survey specification. spec must be a\nlist of survey items.
Within each survey item type must be one of:
Each item must contain a question_name and question_description field that describes the survey question itself.\nThe variable elements of each survey items represents the key that will be given to the playbook when the workflow job template\nis launched. It will contain the value as a result of the survey.
Here is a more comprehensive example showing the various question types and their acceptable parameters:
\n{\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \"type\": \"text\",\n \"question_name\": \"cantbeshort\",\n \"question_description\": \"What is a long answer\",\n \"variable\": \"long_answer\",\n \"choices\": \"\",\n \"min\": 5,\n \"max\": \"\",\n \"required\": false,\n \"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \"type\": \"text\",\n \"question_name\": \"cantbelong\",\n \"question_description\": \"What is a short answer\",\n \"variable\": \"short_answer\",\n \"choices\": \"\",\n \"min\": \"\",\n \"max\": 7,\n \"required\": false,\n \"default\": \"leeloo\"\n },\n {\n \"type\": \"text\",\n \"question_name\": \"reqd\",\n \"question_description\": \"I should be required\",\n \"variable\": \"reqd_answer\",\n \"choices\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"required\": true,\n \"default\": \"NOT OPTIONAL\"\n },\n {\n \"type\": \"multiplechoice\",\n \"question_name\": \"achoice\",\n \"question_description\": \"Need one of these\",\n \"variable\": \"single_choice\",\n \"choices\": [\"one\", \"two\"],\n \"min\": \"\",\n \"max\": \"\",\n \"required\": false,\n \"default\": \"one\"\n },\n {\n \"type\": \"multiselect\",\n \"question_name\": \"mchoice\",\n \"question_description\": \"Can have multiples of these\",\n \"variable\": \"multi_choice\",\n \"choices\": [\"one\", \"two\", \"three\"],\n \"min\": \"\",\n \"max\": \"\",\n \"required\": false,\n \"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n}\nHere is an example survey specification:
\n{\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \"type\": \"text\",\n \"question_name\": \"example question\",\n \"question_description\": \"What is your favorite color?\",\n \"variable\": \"favorite_color\",\n \"required\": false,\n \"default\": \"blue\"\n }\n ]\n}\nname and description are required elements at the beginning of the survey specification. spec must be a\nlist of survey items.
Within each survey item type must be one of:
Each item must contain a question_name and question_description field that describes the survey question itself.\nThe variable elements of each survey items represents the key that will be given to the playbook when the workflow job template\nis launched. It will contain the value as a result of the survey.
Here is a more comprehensive example showing the various question types and their acceptable parameters:
\n{\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \"type\": \"text\",\n \"question_name\": \"cantbeshort\",\n \"question_description\": \"What is a long answer\",\n \"variable\": \"long_answer\",\n \"choices\": \"\",\n \"min\": 5,\n \"max\": \"\",\n \"required\": false,\n \"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \"type\": \"text\",\n \"question_name\": \"cantbelong\",\n \"question_description\": \"What is a short answer\",\n \"variable\": \"short_answer\",\n \"choices\": \"\",\n \"min\": \"\",\n \"max\": 7,\n \"required\": false,\n \"default\": \"leeloo\"\n },\n {\n \"type\": \"text\",\n \"question_name\": \"reqd\",\n \"question_description\": \"I should be required\",\n \"variable\": \"reqd_answer\",\n \"choices\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"required\": true,\n \"default\": \"NOT OPTIONAL\"\n },\n {\n \"type\": \"multiplechoice\",\n \"question_name\": \"achoice\",\n \"question_description\": \"Need one of these\",\n \"variable\": \"single_choice\",\n \"choices\": [\"one\", \"two\"],\n \"min\": \"\",\n \"max\": \"\",\n \"required\": false,\n \"default\": \"one\"\n },\n {\n \"type\": \"multiselect\",\n \"question_name\": \"mchoice\",\n \"question_description\": \"Can have multiples of these\",\n \"variable\": \"multi_choice\",\n \"choices\": [\"one\", \"two\", \"three\"],\n \"min\": \"\",\n \"max\": \"\",\n \"required\": false,\n \"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n}\nHere is an example survey specification:
\n{\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \"type\": \"text\",\n \"question_name\": \"example question\",\n \"question_description\": \"What is your favorite color?\",\n \"variable\": \"favorite_color\",\n \"required\": false,\n \"default\": \"blue\"\n }\n ]\n}\nname and description are required elements at the beginning of the survey specification. spec must be a\nlist of survey items.
Within each survey item type must be one of:
Each item must contain a question_name and question_description field that describes the survey question itself.\nThe variable elements of each survey items represents the key that will be given to the playbook when the workflow job template\nis launched. It will contain the value as a result of the survey.
Here is a more comprehensive example showing the various question types and their acceptable parameters:
\n{\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \"type\": \"text\",\n \"question_name\": \"cantbeshort\",\n \"question_description\": \"What is a long answer\",\n \"variable\": \"long_answer\",\n \"choices\": \"\",\n \"min\": 5,\n \"max\": \"\",\n \"required\": false,\n \"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \"type\": \"text\",\n \"question_name\": \"cantbelong\",\n \"question_description\": \"What is a short answer\",\n \"variable\": \"short_answer\",\n \"choices\": \"\",\n \"min\": \"\",\n \"max\": 7,\n \"required\": false,\n \"default\": \"leeloo\"\n },\n {\n \"type\": \"text\",\n \"question_name\": \"reqd\",\n \"question_description\": \"I should be required\",\n \"variable\": \"reqd_answer\",\n \"choices\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"required\": true,\n \"default\": \"NOT OPTIONAL\"\n },\n {\n \"type\": \"multiplechoice\",\n \"question_name\": \"achoice\",\n \"question_description\": \"Need one of these\",\n \"variable\": \"single_choice\",\n \"choices\": [\"one\", \"two\"],\n \"min\": \"\",\n \"max\": \"\",\n \"required\": false,\n \"default\": \"one\"\n },\n {\n \"type\": \"multiselect\",\n \"question_name\": \"mchoice\",\n \"question_description\": \"Can have multiples of these\",\n \"variable\": \"multi_choice\",\n \"choices\": [\"one\", \"two\", \"three\"],\n \"min\": \"\",\n \"max\": \"\",\n \"required\": false,\n \"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n}\nMake a GET request to this resource to retrieve a list of\nworkflow jobs associated with the selected\nworkflow job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow jobs\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job records.
Each workflow job data structure includes the following fields:
\nid: Database ID for this workflow job. (integer)type: Data type for this workflow job. (choice)url: URL for this workflow job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job was created. (datetime)modified: Timestamp when this workflow job was last modified. (datetime)name: Name of this workflow job. (string)description: Optional description of this workflow job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)workflow_job_template: (id)extra_vars: (json)allow_simultaneous: (boolean)job_template: If automatically created for a sliced job run, the job template the workflow job was created from. (id)is_sliced_job: (boolean)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)limit: (string)scm_branch: (string)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)webhook_guid: Unique identifier of the event that triggered this webhook (string)To specify that workflow jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nWorkflow nodes reference templates to execute and define the ordering\nin which to execute them. After a job in this workflow finishes,\nthe subsequent actions are to:
\nThe workflow job is marked as successful if all of the jobs running as\na part of the workflow job have completed, and the workflow job has not\nbeen canceled. Even if a job within the workflow has failed, the workflow\njob will not be marked as failed.
Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow job template nodes\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job template node records.
Each workflow job template node data structure includes the following fields:
\nid: Database ID for this workflow job template node. (integer)type: Data type for this workflow job template node. (choice)url: URL for this workflow job template node. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job template node was created. (datetime)modified: Timestamp when this workflow job template node was last modified. (datetime)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)workflow_job_template: (id)unified_job_template: (id)success_nodes: (field)failure_nodes: (field)always_nodes: (field)all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)To specify that workflow job template nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nWorkflow nodes reference templates to execute and define the ordering\nin which to execute them. After a job in this workflow finishes,\nthe subsequent actions are to:
\nThe workflow job is marked as successful if all of the jobs running as\na part of the workflow job have completed, and the workflow job has not\nbeen canceled. Even if a job within the workflow has failed, the workflow\njob will not be marked as failed.
Make a POST request to this resource with the following workflow job template node\nfields to create a new workflow job template node associated with this\nworkflow job template.
\nextra_data: (json, default={})inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)scm_branch: (string, default=\"\")job_type: (choice)None: --------- (default)\"\": ---------run: Runcheck: Checkjob_tags: (string, default=\"\")skip_tags: (string, default=\"\")limit: (string, default=\"\")diff_mode: (boolean, default=None)verbosity: (choice)
None: --------- (default)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)unified_job_template: (id, default=``)
all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=False)
identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\")Make a GET request to this resource to retrieve the list of\nworkflow jobs.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow jobs\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job records.
Each workflow job data structure includes the following fields:
\nid: Database ID for this workflow job. (integer)type: Data type for this workflow job. (choice)url: URL for this workflow job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job was created. (datetime)modified: Timestamp when this workflow job was last modified. (datetime)name: Name of this workflow job. (string)description: Optional description of this workflow job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)workflow_job_template: (id)extra_vars: (json)allow_simultaneous: (boolean)job_template: If automatically created for a sliced job run, the job template the workflow job was created from. (id)is_sliced_job: (boolean)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)limit: (string)scm_branch: (string)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)webhook_guid: Unique identifier of the event that triggered this webhook (string)To specify that workflow jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a DELETE request to this resource to delete this workflow job.
", "operationId":"Workflow Jobs_workflow_jobs_delete", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "204":{ "description":"" }, "403":{ "examples":{ "application/json":{ "detail":"Cannot delete running job resource." } }, "description":"" } }, "summary":" Delete a Workflow Job", "tags":[ "Workflow Jobs" ], "x-internal-id":"api-v2-workflow_jobs-{id}--delete", "x-filename-id":"api-v2-workflow_jobs-id-delete" }, "get":{ "description":"Make GET request to this resource to retrieve a single workflow job\nrecord containing the following fields:
\nid: Database ID for this workflow job. (integer)type: Data type for this workflow job. (choice)url: URL for this workflow job. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job was created. (datetime)modified: Timestamp when this workflow job was last modified. (datetime)name: Name of this workflow job. (string)description: Optional description of this workflow job. (string)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Updatestatus: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceledfailed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_args: (string)job_cwd: (string)job_env: (json)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)result_traceback: (string)workflow_job_template: (id)extra_vars: (json)allow_simultaneous: (boolean)job_template: If automatically created for a sliced job run, the job template the workflow job was created from. (id)is_sliced_job: (boolean)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)limit: (string)scm_branch: (string)webhook_service: Service that webhook requests will be accepted from (choice)\"\": ---------github: GitHubgitlab: GitLabwebhook_credential: Personal Access Token for posting back the status to the service API (id)webhook_guid: Unique identifier of the event that triggered this webhook (string)Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nworkflow job.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of activity streams\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more activity stream records.
Each activity stream data structure includes the following fields:
\nid: Database ID for this activity stream. (integer)type: Data type for this activity stream. (choice)url: URL for this activity stream. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)timestamp: (datetime)operation: The action taken with respect to the given object(s). (choice)create: Entity Createdupdate: Entity Updateddelete: Entity Deletedassociate: Entity Associated with another Entitydisassociate: Entity was Disassociated with another Entitychanges: A summary of the new and changed values when an object is created, updated, or deleted (json)object1: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)object_association: When present, shows the field name of the role or relationship that changed. (field)action_node: The cluster node the activity took place on. (string)object_type: When present, shows the model on which the role or relationship was defined. (field)To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to determine if the workflow job can be\ncanceled. The response will include the following field:
\ncan_cancel: Indicates whether this workflow job is in a state that can\n be canceled (boolean, read-only)Make a POST request to this endpoint to submit a request to cancel a pending\nor running workflow job. The response status code will be 202 if the\nrequest to cancel was successfully submitted, or 405 if the workflow job\ncannot be canceled.
", "operationId":"Workflow Jobs_workflow_jobs_cancel_read", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":" Cancel Workflow Job", "tags":[ "Workflow Jobs" ], "x-internal-id":"api-v2-workflow_jobs-{id}-cancel--get", "x-filename-id":"api-v2-workflow_jobs-id-cancel-get" }, "post":{ "description":"Make a GET request to this resource to determine if the workflow job can be\ncanceled. The response will include the following field:
\ncan_cancel: Indicates whether this workflow job is in a state that can\n be canceled (boolean, read-only)Make a POST request to this endpoint to submit a request to cancel a pending\nor running workflow job. The response status code will be 202 if the\nrequest to cancel was successfully submitted, or 405 if the workflow job\ncannot be canceled.
", "operationId":"Workflow Jobs_workflow_jobs_cancel_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "responses":{ "201":{ "description":"" } }, "summary":" Cancel Workflow Job", "tags":[ "Workflow Jobs" ], "x-internal-id":"api-v2-workflow_jobs-{id}-cancel--post", "x-filename-id":"api-v2-workflow_jobs-id-cancel-post" } }, "/api/v2/workflow_jobs/{id}/labels/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of labels\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more label records.
Each label data structure includes the following fields:
\nid: Database ID for this label. (integer)type: Data type for this label. (choice)url: URL for this label. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this label was created. (datetime)modified: Timestamp when this label was last modified. (datetime)name: Name of this label. (string)organization: Organization this label belongs to. (id)To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nworkflow job.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of notifications\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more notification records.
Each notification data structure includes the following fields:
\nid: Database ID for this notification. (integer)type: Data type for this notification. (choice)url: URL for this notification. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this notification was created. (datetime)modified: Timestamp when this notification was last modified. (datetime)notification_template: (id)error: (string)status: (choice)pending: Pendingsuccessful: Successfulfailed: Failednotifications_sent: (integer)notification_type: (choice)email: Emailgrafana: Grafanairc: IRCmattermost: Mattermostpagerduty: Pagerdutyrocketchat: Rocket.Chatslack: Slacktwilio: Twiliowebhook: Webhookrecipients: (string)subject: (string)body: Notification body (json)To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nMake a POST request to this endpoint to launch a workflow job identical to the parent workflow job. This will spawn jobs, project updates, or inventory updates based on the unified job templates referenced in the workflow nodes in the workflow job. No POST data is accepted for this action.
\nIf successful, the response status code will be 201 and serialized data of the new workflow job will be returned.
", "operationId":"Workflow Jobs_workflow_jobs_relaunch_list", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" }, { "description":"A page number within the paginated result set.", "in":"query", "name":"page", "required":false, "type":"integer" }, { "description":"Number of results to return per page.", "in":"query", "name":"page_size", "required":false, "type":"integer" }, { "description":"A search term.", "in":"query", "name":"search", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"" } }, "summary":"Relaunch a Workflow Job", "tags":[ "Workflow Jobs" ], "x-internal-id":"api-v2-workflow_jobs-{id}-relaunch--get", "x-filename-id":"api-v2-workflow_jobs-id-relaunch-get" }, "post":{ "description":"Make a POST request to this endpoint to launch a workflow job identical to the parent workflow job. This will spawn jobs, project updates, or inventory updates based on the unified job templates referenced in the workflow nodes in the workflow job. No POST data is accepted for this action.
\nIf successful, the response status code will be 201 and serialized data of the new workflow job will be returned.
", "operationId":"Workflow Jobs_workflow_jobs_relaunch_create", "parameters":[ { "description":"", "in":"path", "name":"id", "required":true, "type":"string" } ], "responses":{ "201":{ "description":"" } }, "summary":"Relaunch a Workflow Job", "tags":[ "Workflow Jobs" ], "x-internal-id":"api-v2-workflow_jobs-{id}-relaunch--post", "x-filename-id":"api-v2-workflow_jobs-id-relaunch-post" } }, "/api/v2/workflow_jobs/{id}/workflow_nodes/":{ "get":{ "description":"Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job.
\nThe resulting data structure contains:
\n{\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\nThe count field indicates the total number of workflow job nodes\nfound for the given query. The next and previous fields provides links to\nadditional results if there are more than will fit on a single page. The\nresults list contains zero or more workflow job node records.
Each workflow job node data structure includes the following fields:
\nid: Database ID for this workflow job node. (integer)type: Data type for this workflow job node. (choice)url: URL for this workflow job node. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this workflow job node was created. (datetime)modified: Timestamp when this workflow job node was last modified. (datetime)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------\"\": ---------run: Runcheck: Checkjob_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)job: (id)workflow_job: (id)unified_job_template: (id)success_nodes: (field)failure_nodes: (field)always_nodes: (field)all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)do_not_run: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)To specify that workflow job nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.
?order_by=name\nPrefix the field name with a dash - to sort in reverse:
?order_by=-name\nMultiple sorting fields may be specified by separating the field names with a\ncomma ,:
?order_by=name,some_other_field\nUse the page_size query string parameter to change the number of results\nreturned for each request. Use the page query string parameter to retrieve\na particular page of results.
?page_size=100&page=2\nThe previous and next links returned with the results will set these query\nstring parameters automatically.
Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.
?search=findme\n(Added in Ansible Tower 3.1.0) Search across related fields:
\n?related__search=findme\nREST API endpoints for Activity Streams
" }, { "name":"Ad Hoc Command Events", "description":"REST API endpoints for Ad Hoc Command Events
" }, { "name":"Ad Hoc Commands", "description":"REST API endpoints for Ad Hoc Commands
" }, { "name":"Authentication", "description":"REST API endpoints for Authentication
" }, { "name":"Credential Input Sources", "description":"REST API endpoints for Credential Input Sources
" }, { "name":"Credential Types", "description":"REST API endpoints for Credential Types
" }, { "name":"Credentials", "description":"REST API endpoints for Credentials
" }, { "name":"Custom Inventory Scripts", "description":"REST API endpoints for Custom Inventory Scripts
" }, { "name":"Dashboard", "description":"REST API endpoints for Dashboard
" }, { "name":"Groups", "description":"REST API endpoints for Groups
" }, { "name":"Hosts", "description":"REST API endpoints for Hosts
" }, { "name":"Instance Groups", "description":"REST API endpoints for Instance Groups
" }, { "name":"Instances", "description":"REST API endpoints for Instances
" }, { "name":"Inventories", "description":"REST API endpoints for Inventories
" }, { "name":"Inventory Sources", "description":"REST API endpoints for Inventory Sources
" }, { "name":"Inventory Updates", "description":"REST API endpoints for Inventory Updates
" }, { "name":"Job Events", "description":"REST API endpoints for Job Events
" }, { "name":"Job Host Summaries", "description":"REST API endpoints for Job Host Summaries
" }, { "name":"Job Templates", "description":"REST API endpoints for Job Templates
" }, { "name":"Jobs", "description":"REST API endpoints for Jobs
" }, { "name":"Labels", "description":"REST API endpoints for Labels
" }, { "name":"Metrics", "description":"REST API endpoints for Metrics
" }, { "name":"Notification Templates", "description":"REST API endpoints for Notification Templates
" }, { "name":"Notifications", "description":"REST API endpoints for Notifications
" }, { "name":"Organizations", "description":"REST API endpoints for Organizations
" }, { "name":"Project Updates", "description":"REST API endpoints for Project Updates
" }, { "name":"Projects", "description":"REST API endpoints for Projects
" }, { "name":"Roles", "description":"REST API endpoints for Roles
" }, { "name":"Schedules", "description":"REST API endpoints for Schedules
" }, { "name":"Settings", "description":"REST API endpoints for Settings
" }, { "name":"System Configuration", "description":"REST API endpoints for System Configuration
" }, { "name":"System Job Templates", "description":"REST API endpoints for System Job Templates
" }, { "name":"System Jobs", "description":"REST API endpoints for System Jobs
" }, { "name":"Teams", "description":"REST API endpoints for Teams
" }, { "name":"Unified Job Templates", "description":"REST API endpoints for Unified Job Templates
" }, { "name":"Unified Jobs", "description":"REST API endpoints for Unified Jobs
" }, { "name":"Users", "description":"REST API endpoints for Users
" }, { "name":"Versioning", "description":"REST API endpoints for Versioning
" }, { "name":"Workflow Approval Templates", "description":"REST API endpoints for Workflow Approval Templates
" }, { "name":"Workflow Approvals", "description":"REST API endpoints for Workflow Approvals
" }, { "name":"Workflow Job Nodes", "description":"REST API endpoints for Workflow Job Nodes
" }, { "name":"Workflow Job Template Nodes", "description":"REST API endpoints for Workflow Job Template Nodes
" }, { "name":"Workflow Job Templates", "description":"REST API endpoints for Workflow Job Templates
" }, { "name":"Workflow Jobs", "description":"REST API endpoints for Workflow Jobs
" } ] }