{ "basePath":"/", "consumes":[ "application/json" ], "definitions":{ "ActivityStream":{ "properties":{ "action_node":{ "description":"The cluster node the activity took place on.", "minLength":"1", "readOnly":true, "title":"Action node", "type":"string" }, "changes":{ "description":"A summary of the new and changed values when an object is created, updated, or deleted", "readOnly":true, "title":"Changes", "type":"string" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "object1":{ "description":"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.", "minLength":"1", "title":"Object1", "type":"string", "x-nullable":true }, "object2":{ "description":"Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with.", "minLength":"1", "title":"Object2", "type":"string", "x-nullable":true }, "object_association":{ "description":"When present, shows the field name of the role or relationship that changed.", "readOnly":true, "title":"Object association", "type":"string" }, "object_type":{ "description":"When present, shows the model on which the role or relationship was defined.", "readOnly":true, "title":"Object type", "type":"string" }, "operation":{ "description":"The action taken with respect to the given object(s).", "enum":[ "create", "update", "delete", "associate", "disassociate" ], "title":"Operation", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timestamp":{ "format":"date-time", "readOnly":true, "title":"Timestamp", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "operation", "object1", "object2" ], "type":"object" }, "AdHocCommandCancel":{ "properties":{ "can_cancel":{ "readOnly":true, "title":"Can cancel", "type":"boolean" } }, "type":"object" }, "AdHocCommandDetail":{ "properties":{ "become_enabled":{ "title":"Become enabled", "type":"boolean", "x-nullable":true }, "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "controller_node":{ "description":"The instance that managed the execution environment.", "minLength":"1", "readOnly":true, "title":"Controller node", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential":{ "title":"Credential", "type":"integer", "x-nullable":true }, "diff_mode":{ "title":"Diff mode", "type":"boolean", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "event_processing_finished":{ "description":"Indicates whether all of the events generated by this unified job have been saved to the database.", "readOnly":true, "title":"Event processing finished", "type":"boolean" }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "execution_node":{ "description":"The node the job executed on.", "minLength":"1", "readOnly":true, "title":"Execution node", "type":"string" }, "extra_vars":{ "title":"Extra vars", "type":"string", "x-nullable":true }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "forks":{ "minimum":"0", "title":"Forks", "type":"integer" }, "host_status_counts":{ "description":"Playbook stats from the Ansible playbook_on_stats event.", "readOnly":true, "title":"Host status counts", "type":"object", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory":{ "title":"Inventory", "type":"integer", "x-nullable":true }, "job_args":{ "minLength":"1", "readOnly":true, "title":"Job args", "type":"string" }, "job_cwd":{ "minLength":"1", "readOnly":true, "title":"Job cwd", "type":"string" }, "job_env":{ "readOnly":true, "title":"Job env", "type":"object" }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "job_type":{ "default":"run", "enum":[ "run", "check" ], "title":"Job type", "type":"string", "x-nullable":true }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "module_args":{ "title":"Module args", "type":"string", "x-nullable":true }, "module_name":{ "default":"command", "enum":[ "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" ], "title":"Module name", "type":"string" }, "name":{ "minLength":"1", "readOnly":true, "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "result_traceback":{ "minLength":"1", "readOnly":true, "title":"Result traceback", "type":"string" }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "verbosity":{ "enum":[ "0", "1", "2", "3", "4", "5" ], "title":"Verbosity", "type":"integer" }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "type":"object" }, "AdHocCommandEvent":{ "properties":{ "ad_hoc_command":{ "readOnly":true, "title":"Ad hoc command", "type":"string" }, "changed":{ "readOnly":true, "title":"Changed", "type":"boolean" }, "counter":{ "minimum":"0", "readOnly":true, "title":"Counter", "type":"integer" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "end_line":{ "minimum":"0", "readOnly":true, "title":"End line", "type":"integer" }, "event":{ "enum":[ "runner_on_failed", "runner_on_ok", "runner_on_unreachable", "runner_on_skipped", "debug", "verbose", "deprecated", "warning", "system_warning", "error" ], "title":"Event", "type":"string", "x-nullable":true }, "event_data":{ "title":"Event data", "type":"object" }, "event_display":{ "minLength":"1", "readOnly":true, "title":"Event display", "type":"string" }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "host":{ "readOnly":true, "title":"Host", "type":"integer", "x-nullable":true }, "host_name":{ "minLength":"1", "readOnly":true, "title":"Host name", "type":"string" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "start_line":{ "minimum":"0", "readOnly":true, "title":"Start line", "type":"integer" }, "stdout":{ "minLength":"1", "readOnly":true, "title":"Stdout", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "uuid":{ "minLength":"1", "readOnly":true, "title":"Uuid", "type":"string" }, "verbosity":{ "minimum":"0", "readOnly":true, "title":"Verbosity", "type":"integer" } }, "required":[ "event" ], "type":"object" }, "AdHocCommandList":{ "properties":{ "become_enabled":{ "title":"Become enabled", "type":"boolean", "x-nullable":true }, "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "controller_node":{ "description":"The instance that managed the execution environment.", "minLength":"1", "readOnly":true, "title":"Controller node", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential":{ "title":"Credential", "type":"integer", "x-nullable":true }, "diff_mode":{ "title":"Diff mode", "type":"boolean", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "execution_node":{ "description":"The node the job executed on.", "minLength":"1", "readOnly":true, "title":"Execution node", "type":"string" }, "extra_vars":{ "title":"Extra vars", "type":"string", "x-nullable":true }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "forks":{ "minimum":"0", "title":"Forks", "type":"integer" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory":{ "title":"Inventory", "type":"integer", "x-nullable":true }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "job_type":{ "default":"run", "enum":[ "run", "check" ], "title":"Job type", "type":"string", "x-nullable":true }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "module_args":{ "title":"Module args", "type":"string", "x-nullable":true }, "module_name":{ "default":"command", "enum":[ "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" ], "title":"Module name", "type":"string" }, "name":{ "minLength":"1", "readOnly":true, "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "verbosity":{ "enum":[ "0", "1", "2", "3", "4", "5" ], "title":"Verbosity", "type":"integer" }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "type":"object" }, "AdHocCommandRelaunch":{ "properties":{ }, "type":"object" }, "AnsibleFacts":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name" ], "type":"object" }, "BulkHost":{ "properties":{ "description":{ "title":"Description", "type":"string", "x-nullable":true }, "enabled":{ "default":true, "description":"Is this host online and available for running jobs?", "title":"Enabled", "type":"boolean", "x-nullable":true }, "instance_id":{ "description":"The value used by the remote inventory source to uniquely identify the host", "maxLength":"1024", "title":"Instance id", "type":"string", "x-nullable":true }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "variables":{ "description":"Host variables in JSON or YAML format.", "title":"Variables", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "BulkHostCreate":{ "properties":{ "hosts":{ "description":"List of hosts to be created, JSON. e.g. [{\"name\": \"example.com\"}, {\"name\": \"127.0.0.1\"}]", "items":{ "$ref":"#/definitions/BulkHost" }, "maxItems":"100000", "type":"array" }, "inventory":{ "description":"Primary Key ID of inventory to add hosts to.", "title":"Inventory", "type":"integer" } }, "required":[ "inventory", "hosts" ], "type":"object" }, "BulkHostDelete":{ "properties":{ "hosts":{ "description":"List of hosts ids to be deleted, e.g. [105, 130, 131, 200]", "items":{ "type":"string", "x-nullable":true }, "maxItems":"100000", "type":"array" } }, "required":[ "hosts" ], "type":"object" }, "BulkJobLaunch":{ "properties":{ "description":{ "minLength":"1", "title":"Description", "type":"string" }, "extra_vars":{ "title":"Extra vars", "type":"object" }, "inventory":{ "title":"Inventory", "type":"integer" }, "job_tags":{ "minLength":"1", "title":"Job tags", "type":"string" }, "jobs":{ "description":"List of jobs to be launched, JSON. e.g. [{\"unified_job_template\": 7}, {\"unified_job_template\": 10}]", "items":{ "$ref":"#/definitions/BulkJobNode" }, "type":"array" }, "limit":{ "minLength":"1", "title":"Limit", "type":"string" }, "name":{ "default":"Bulk Job Launch", "maxLength":"512", "title":"Name", "type":"string" }, "organization":{ "description":"Inherit permissions from this organization. If not provided, a organization the user is a member of will be selected automatically.", "title":"Organization", "type":"integer", "x-nullable":true }, "scm_branch":{ "minLength":"1", "title":"Scm branch", "type":"string" }, "skip_tags":{ "minLength":"1", "title":"Skip tags", "type":"string" } }, "required":[ "jobs" ], "type":"object" }, "BulkJobNode":{ "description":"List of jobs to be launched, JSON. e.g. [{\"unified_job_template\": 7}, {\"unified_job_template\": 10}]", "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", "title":"All parents must converge", "type":"boolean", "x-nullable":true }, "always_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credentials":{ "items":{ "minimum":"1", "type":"integer" }, "type":"array" }, "diff_mode":{ "title":"Diff mode", "type":"boolean", "x-nullable":true }, "do_not_run":{ "description":"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.", "title":"Do not run", "type":"boolean", "x-nullable":true }, "execution_environment":{ "minimum":"1", "title":"Execution environment", "type":"integer" }, "extra_data":{ "title":"Extra data", "type":"object" }, "failure_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "forks":{ "minimum":"0", "title":"Forks", "type":"integer", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "identifier":{ "description":"An identifier coresponding to the workflow job template node that this node was created from.", "maxLength":"512", "title":"Identifier", "type":"string", "x-nullable":true }, "instance_groups":{ "items":{ "minimum":"1", "type":"integer" }, "type":"array" }, "inventory":{ "minimum":"1", "title":"Inventory", "type":"integer" }, "job":{ "title":"Job", "type":"integer", "x-nullable":true }, "job_slice_count":{ "minimum":"0", "title":"Job slice count", "type":"integer", "x-nullable":true }, "job_tags":{ "title":"Job tags", "type":"string", "x-nullable":true }, "job_type":{ "enum":[ "run", "check" ], "title":"Job type", "type":"string", "x-nullable":true }, "labels":{ "items":{ "minimum":"1", "type":"integer" }, "type":"array" }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "title":"Scm branch", "type":"string", "x-nullable":true }, "skip_tags":{ "title":"Skip tags", "type":"string", "x-nullable":true }, "success_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "title":"Timeout", "type":"integer", "x-nullable":true }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "description":"Primary key of the template for this job, can be a job template or inventory source.", "minimum":"1", "title":"Unified job template", "type":"integer" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "verbosity":{ "enum":[ "0", "1", "2", "3", "4", "5" ], "title":"Verbosity", "type":"string", "x-nullable":true }, "workflow_job":{ "title":"Workflow job", "type":"string", "x-nullable":true } }, "required":[ "unified_job_template" ], "type":"object" }, "ConstructedInventory":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "has_active_failures":{ "description":"This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed.", "readOnly":true, "title":"Has active failures", "type":"boolean" }, "has_inventory_sources":{ "description":"This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources.", "readOnly":true, "title":"Has inventory sources", "type":"boolean" }, "hosts_with_active_failures":{ "description":"This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures.", "minimum":"0", "readOnly":true, "title":"Hosts with active failures", "type":"integer" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory_sources_with_failures":{ "description":"Number of external inventory sources in this inventory with failures.", "minimum":"0", "readOnly":true, "title":"Inventory sources with failures", "type":"integer" }, "kind":{ "description":"Kind of inventory being represented.", "enum":[ "", "smart", "constructed" ], "readOnly":true, "title":"Kind", "type":"string", "x-nullable":true }, "limit":{ "description":"The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory.", "title":"Limit", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "organization":{ "description":"Organization containing this inventory.", "title":"Organization", "type":"integer", "x-nullable":true }, "pending_deletion":{ "description":"Flag indicating the inventory is being deleted.", "readOnly":true, "title":"Pending deletion", "type":"boolean" }, "prevent_instance_group_fallback":{ "description":"If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.", "title":"Prevent instance group fallback", "type":"boolean", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "source_vars":{ "description":"The source_vars for the related auto-created inventory source, special to constructed inventory.", "title":"Source vars", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "total_groups":{ "description":"This field is deprecated and will be removed in a future release. Total number of groups in this inventory.", "minimum":"0", "readOnly":true, "title":"Total groups", "type":"integer" }, "total_hosts":{ "description":"This field is deprecated and will be removed in a future release. Total number of hosts in this inventory.", "minimum":"0", "readOnly":true, "title":"Total hosts", "type":"integer" }, "total_inventory_sources":{ "description":"Total number of external inventory sources configured within this inventory.", "minimum":"0", "readOnly":true, "title":"Total inventory sources", "type":"integer" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "update_cache_timeout":{ "description":"The cache timeout for the related auto-created inventory source, special to constructed inventory", "minimum":"0", "title":"Update cache timeout", "type":"integer", "x-nullable":true }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "variables":{ "description":"Inventory variables in JSON or YAML format.", "title":"Variables", "type":"string", "x-nullable":true }, "verbosity":{ "description":"The verbosity level for the related auto-created inventory source, special to constructed inventory", "maximum":"2", "minimum":"0", "title":"Verbosity", "type":"integer", "x-nullable":true } }, "required":[ "name", "organization" ], "type":"object" }, "Copy":{ "properties":{ "name":{ "minLength":"1", "title":"Name", "type":"string" } }, "required":[ "name" ], "type":"object" }, "Credential":{ "properties":{ "cloud":{ "readOnly":true, "title":"Cloud", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential_type":{ "description":"Specify the type of credential you want to create. Refer to the documentation for details on each type.", "title":"Credential Type", "type":"integer" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inputs":{ "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", "title":"Inputs", "type":"object" }, "kind":{ "readOnly":true, "title":"Kind", "type":"string" }, "kubernetes":{ "readOnly":true, "title":"Kubernetes", "type":"string" }, "managed":{ "readOnly":true, "title":"Managed", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "organization":{ "title":"Organization", "type":"integer", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name", "credential_type" ], "type":"object" }, "CredentialInputSource":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "input_field_name":{ "maxLength":"1024", "minLength":"1", "title":"Input field name", "type":"string", "x-nullable":true }, "metadata":{ "title":"Metadata", "type":"object" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "source_credential":{ "title":"Source credential", "type":"integer", "x-nullable":true }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "target_credential":{ "title":"Target credential", "type":"integer", "x-nullable":true }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "input_field_name", "target_credential", "source_credential" ], "type":"object" }, "CredentialSerializerCreate":{ "properties":{ "cloud":{ "readOnly":true, "title":"Cloud", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential_type":{ "description":"Specify the type of credential you want to create. Refer to the documentation for details on each type.", "title":"Credential Type", "type":"integer" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inputs":{ "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", "title":"Inputs", "type":"object" }, "kind":{ "readOnly":true, "title":"Kind", "type":"string" }, "kubernetes":{ "readOnly":true, "title":"Kubernetes", "type":"string" }, "managed":{ "readOnly":true, "title":"Managed", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "organization":{ "description":"Inherit permissions from organization roles. If provided on creation, do not give either user or team.", "title":"Organization", "type":"integer", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "team":{ "description":"Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.", "title":"Team", "type":"integer", "x-nullable":true }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "user":{ "description":"Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.", "title":"User", "type":"integer", "x-nullable":true } }, "required":[ "name", "credential_type" ], "type":"object" }, "CredentialType":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "injectors":{ "description":"Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.", "title":"Injectors", "type":"object" }, "inputs":{ "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", "title":"Inputs", "type":"object" }, "kind":{ "enum":[ "ssh", "vault", "net", "scm", "cloud", "registry", "token", "insights", "external", "kubernetes", "galaxy", "cryptography" ], "title":"Kind", "type":"string", "x-nullable":true }, "managed":{ "readOnly":true, "title":"Managed", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "namespace":{ "minLength":"1", "readOnly":true, "title":"Namespace", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name", "kind" ], "type":"object" }, "Empty":{ "properties":{ }, "type":"object" }, "ExecutionEnvironment":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential":{ "title":"Credential", "type":"integer", "x-nullable":true }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "image":{ "description":"The full image location, including the container registry, image name, and version tag.", "maxLength":"1024", "minLength":"1", "title":"Image location", "type":"string", "x-nullable":true }, "managed":{ "readOnly":true, "title":"Managed", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "organization":{ "description":"The organization used to determine access to this execution environment.", "title":"Organization", "type":"integer", "x-nullable":true }, "pull":{ "description":"Pull image before running?", "enum":[ "always", "missing", "never" ], "title":"Pull", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name", "image" ], "type":"object" }, "Group":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory":{ "title":"Inventory", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "variables":{ "description":"Group variables in JSON or YAML format.", "title":"Variables", "type":"string", "x-nullable":true } }, "required":[ "name", "inventory" ], "type":"object" }, "GroupTree":{ "properties":{ "children":{ "readOnly":true, "title":"Children", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory":{ "title":"Inventory", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "variables":{ "description":"Group variables in JSON or YAML format.", "title":"Variables", "type":"string", "x-nullable":true } }, "required":[ "name", "inventory" ], "type":"object" }, "GroupVariableData":{ "properties":{ "variables":{ "description":"Group variables in JSON or YAML format.", "title":"Variables", "type":"string", "x-nullable":true } }, "type":"object" }, "Host":{ "properties":{ "ansible_facts_modified":{ "description":"The date and time ansible_facts was last modified.", "format":"date-time", "readOnly":true, "title":"Ansible facts modified", "type":"string", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "enabled":{ "default":true, "description":"Is this host online and available for running jobs?", "title":"Enabled", "type":"boolean", "x-nullable":true }, "has_active_failures":{ "readOnly":true, "title":"Has active failures", "type":"string" }, "has_inventory_sources":{ "readOnly":true, "title":"Has inventory sources", "type":"string" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "instance_id":{ "description":"The value used by the remote inventory source to uniquely identify the host", "maxLength":"1024", "title":"Instance id", "type":"string", "x-nullable":true }, "inventory":{ "title":"Inventory", "type":"integer" }, "last_job":{ "readOnly":true, "title":"Last job", "type":"string", "x-nullable":true }, "last_job_host_summary":{ "readOnly":true, "title":"Last job host summary", "type":"integer", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "variables":{ "description":"Host variables in JSON or YAML format.", "title":"Variables", "type":"string", "x-nullable":true } }, "required":[ "name", "inventory" ], "type":"object" }, "HostMetric":{ "properties":{ "automated_counter":{ "description":"How many times was the host automated", "title":"Automated counter", "type":"integer" }, "deleted":{ "description":"Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption", "title":"Deleted", "type":"boolean", "x-nullable":true }, "deleted_counter":{ "description":"How many times was the host deleted", "title":"Deleted counter", "type":"integer" }, "first_automation":{ "description":"When the host was first automated against", "format":"date-time", "readOnly":true, "title":"First automation", "type":"string" }, "hostname":{ "maxLength":"512", "minLength":"1", "title":"Hostname", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "last_automation":{ "description":"When the host was last automated against", "format":"date-time", "title":"Last automation", "type":"string" }, "last_deleted":{ "description":"When the host was last deleted", "format":"date-time", "title":"Last deleted", "type":"string", "x-nullable":true }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "used_in_inventories":{ "description":"How many inventories contain this host", "title":"Used in inventories", "type":"integer", "x-nullable":true } }, "required":[ "hostname", "last_automation" ], "type":"object" }, "HostMetricSummaryMonthly":{ "properties":{ "date":{ "format":"date", "readOnly":true, "title":"Date", "type":"string" }, "hosts_added":{ "description":"How many hosts were added in the associated month, consuming more license capacity", "readOnly":true, "title":"Hosts added", "type":"integer" }, "hosts_deleted":{ "description":"How many hosts were deleted in the associated month, freeing the license capacity", "readOnly":true, "title":"Hosts deleted", "type":"integer" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "indirectly_managed_hosts":{ "description":"Manually entered number indirectly managed hosts for a certain month", "readOnly":true, "title":"Indirectly managed hosts", "type":"integer" }, "license_capacity":{ "description":"'License capacity as max. number of unique hosts", "readOnly":true, "title":"License capacity", "type":"integer" }, "license_consumed":{ "description":"How many unique hosts are consumed from the license", "readOnly":true, "title":"License consumed", "type":"integer" } }, "type":"object" }, "HostVariableData":{ "properties":{ "variables":{ "description":"Host variables in JSON or YAML format.", "title":"Variables", "type":"string", "x-nullable":true } }, "type":"object" }, "Instance":{ "properties":{ "capacity":{ "minimum":"0", "readOnly":true, "title":"Capacity", "type":"integer" }, "capacity_adjustment":{ "default":"1.00", "format":"decimal", "title":"Capacity adjustment", "type":"string" }, "consumed_capacity":{ "readOnly":true, "title":"Consumed capacity", "type":"string" }, "cpu":{ "format":"decimal", "readOnly":true, "title":"Cpu", "type":"string" }, "cpu_capacity":{ "readOnly":true, "title":"Cpu capacity", "type":"integer" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "enabled":{ "default":true, "title":"Enabled", "type":"boolean", "x-nullable":true }, "errors":{ "description":"Any error details from the last health check.", "minLength":"1", "readOnly":true, "title":"Errors", "type":"string" }, "health_check_pending":{ "readOnly":true, "title":"Health check pending", "type":"string" }, "health_check_started":{ "description":"The last time a health check was initiated on this instance.", "format":"date-time", "readOnly":true, "title":"Health check started", "type":"string", "x-nullable":true }, "hostname":{ "maxLength":"250", "minLength":"1", "title":"Hostname", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "ip_address":{ "minLength":"1", "readOnly":true, "title":"Ip address", "type":"string", "x-nullable":true }, "jobs_running":{ "description":"Count of jobs in the running or waiting state that are targeted for this instance", "readOnly":true, "title":"Jobs running", "type":"integer" }, "jobs_total":{ "description":"Count of all jobs that target this instance", "readOnly":true, "title":"Jobs total", "type":"integer" }, "last_health_check":{ "description":"Last time a health check was ran on this instance to refresh cpu, memory, and capacity.", "format":"date-time", "readOnly":true, "title":"Last health check", "type":"string", "x-nullable":true }, "last_seen":{ "description":"Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes.", "format":"date-time", "readOnly":true, "title":"Last seen", "type":"string", "x-nullable":true }, "listener_port":{ "description":"Port that Receptor will listen for incoming connections on.", "maximum":"65535", "minimum":"0", "title":"Listener port", "type":"integer", "x-nullable":true }, "managed_by_policy":{ "default":true, "title":"Managed by policy", "type":"boolean", "x-nullable":true }, "mem_capacity":{ "readOnly":true, "title":"Mem capacity", "type":"integer" }, "memory":{ "description":"Total system memory of this instance in bytes.", "readOnly":true, "title":"Memory", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "node_state":{ "default":"installed", "description":"Indicates the current life cycle stage of this instance.", "enum":[ "provisioning", "provision-fail", "installed", "ready", "unavailable", "deprovisioning", "deprovision-fail" ], "title":"Node state", "type":"string", "x-nullable":true }, "node_type":{ "default":"execution", "description":"Role that this node plays in the mesh.", "enum":[ "control", "execution", "hybrid", "hop" ], "title":"Node type", "type":"string", "x-nullable":true }, "peers":{ "items":{ "type":"string" }, "type":"array", "uniqueItems":true }, "peers_from_control_nodes":{ "description":"If True, control plane cluster nodes should automatically peer to it.", "title":"Peers from control nodes", "type":"boolean", "x-nullable":true }, "percent_capacity_remaining":{ "readOnly":true, "title":"Percent capacity remaining", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "uuid":{ "minLength":"1", "readOnly":true, "title":"Uuid", "type":"string", "x-nullable":true }, "version":{ "minLength":"1", "readOnly":true, "title":"Version", "type":"string", "x-nullable":true } }, "required":[ "hostname" ], "type":"object" }, "InstanceGroup":{ "properties":{ "capacity":{ "readOnly":true, "title":"Capacity", "type":"string" }, "consumed_capacity":{ "readOnly":true, "title":"Consumed capacity", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential":{ "title":"Credential", "type":"integer", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "instances":{ "readOnly":true, "title":"Instances", "type":"string" }, "is_container_group":{ "description":"Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.", "title":"Is container group", "type":"boolean" }, "jobs_running":{ "readOnly":true, "title":"Jobs running", "type":"string" }, "jobs_total":{ "description":"Count of all jobs that target this instance group", "readOnly":true, "title":"Jobs total", "type":"integer" }, "max_concurrent_jobs":{ "description":"Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.", "minimum":"0", "title":"Max Concurrent Jobs", "type":"integer" }, "max_forks":{ "description":"Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.", "minimum":"0", "title":"Max Forks", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"250", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "percent_capacity_remaining":{ "readOnly":true, "title":"Percent capacity remaining", "type":"string" }, "pod_spec_override":{ "title":"Pod spec override", "type":"string", "x-nullable":true }, "policy_instance_list":{ "description":"List of exact-match Instances that will be assigned to this group", "items":{ "minLength":"1", "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.", "minimum":"0", "title":"Policy Instance Minimum", "type":"integer" }, "policy_instance_percentage":{ "description":"Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.", "maximum":"100", "minimum":"0", "title":"Policy Instance Percentage", "type":"integer" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name" ], "type":"object" }, "InstanceHealthCheck":{ "properties":{ "capacity":{ "readOnly":true, "title":"Capacity", "type":"integer" }, "cpu":{ "format":"decimal", "readOnly":true, "title":"Cpu", "type":"string" }, "cpu_capacity":{ "readOnly":true, "title":"Cpu capacity", "type":"integer" }, "errors":{ "description":"Any error details from the last health check.", "minLength":"1", "readOnly":true, "title":"Errors", "type":"string" }, "hostname":{ "minLength":"1", "readOnly":true, "title":"Hostname", "type":"string", "x-nullable":true }, "ip_address":{ "minLength":"1", "readOnly":true, "title":"Ip address", "type":"string", "x-nullable":true }, "last_health_check":{ "description":"Last time a health check was ran on this instance to refresh cpu, memory, and capacity.", "format":"date-time", "readOnly":true, "title":"Last health check", "type":"string", "x-nullable":true }, "mem_capacity":{ "readOnly":true, "title":"Mem capacity", "type":"integer" }, "memory":{ "description":"Total system memory of this instance in bytes.", "readOnly":true, "title":"Memory", "type":"integer" }, "uuid":{ "minLength":"1", "readOnly":true, "title":"Uuid", "type":"string", "x-nullable":true }, "version":{ "minLength":"1", "readOnly":true, "title":"Version", "type":"string", "x-nullable":true } }, "type":"object" }, "Inventory":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "has_active_failures":{ "description":"This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed.", "readOnly":true, "title":"Has active failures", "type":"boolean" }, "has_inventory_sources":{ "description":"This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources.", "readOnly":true, "title":"Has inventory sources", "type":"boolean" }, "host_filter":{ "description":"Filter that will be applied to the hosts of this inventory.", "title":"Host filter", "type":"string", "x-nullable":true }, "hosts_with_active_failures":{ "description":"This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures.", "minimum":"0", "readOnly":true, "title":"Hosts with active failures", "type":"integer" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory_sources_with_failures":{ "description":"Number of external inventory sources in this inventory with failures.", "minimum":"0", "readOnly":true, "title":"Inventory sources with failures", "type":"integer" }, "kind":{ "description":"Kind of inventory being represented.", "enum":[ "", "smart", "constructed" ], "title":"Kind", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "organization":{ "description":"Organization containing this inventory.", "title":"Organization", "type":"integer", "x-nullable":true }, "pending_deletion":{ "description":"Flag indicating the inventory is being deleted.", "readOnly":true, "title":"Pending deletion", "type":"boolean" }, "prevent_instance_group_fallback":{ "description":"If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.", "title":"Prevent instance group fallback", "type":"boolean", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "total_groups":{ "description":"This field is deprecated and will be removed in a future release. Total number of groups in this inventory.", "minimum":"0", "readOnly":true, "title":"Total groups", "type":"integer" }, "total_hosts":{ "description":"This field is deprecated and will be removed in a future release. Total number of hosts in this inventory.", "minimum":"0", "readOnly":true, "title":"Total hosts", "type":"integer" }, "total_inventory_sources":{ "description":"Total number of external inventory sources configured within this inventory.", "minimum":"0", "readOnly":true, "title":"Total inventory sources", "type":"integer" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "variables":{ "description":"Inventory variables in JSON or YAML format.", "title":"Variables", "type":"string", "x-nullable":true } }, "required":[ "name", "organization" ], "type":"object" }, "InventoryScript":{ "properties":{ }, "type":"object" }, "InventorySource":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential":{ "description":"Cloud credential to use for inventory updates.", "minimum":"1", "title":"Credential", "type":"integer", "x-nullable":true }, "custom_virtualenv":{ "description":"Local absolute file path containing a custom Python virtualenv to use", "minLength":"1", "readOnly":true, "title":"Custom virtualenv", "type":"string", "x-nullable":true }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "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. If the key is not found then the host will be enabled", "title":"Enabled value", "type":"string", "x-nullable":true }, "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)", "title":"Enabled var", "type":"string", "x-nullable":true }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "host_filter":{ "description":"This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.", "title":"Host filter", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory":{ "title":"Inventory", "type":"integer", "x-nullable":true }, "last_job_failed":{ "readOnly":true, "title":"Last job failed", "type":"boolean" }, "last_job_run":{ "format":"date-time", "readOnly":true, "title":"Last job run", "type":"string", "x-nullable":true }, "last_update_failed":{ "readOnly":true, "title":"Last update failed", "type":"boolean" }, "last_updated":{ "format":"date-time", "readOnly":true, "title":"Last updated", "type":"string" }, "limit":{ "description":"Enter host, group or pattern match", "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "next_job_run":{ "format":"date-time", "readOnly":true, "title":"Next job run", "type":"string", "x-nullable":true }, "overwrite":{ "description":"Overwrite local groups and hosts from remote inventory source.", "title":"Overwrite", "type":"boolean", "x-nullable":true }, "overwrite_vars":{ "description":"Overwrite local variables from remote inventory source.", "title":"Overwrite vars", "type":"boolean", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "description":"Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.", "maxLength":"1024", "title":"Scm branch", "type":"string", "x-nullable":true }, "source":{ "enum":[ "file", "constructed", "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights" ], "title":"Source", "type":"string", "x-nullable":true }, "source_path":{ "maxLength":"1024", "title":"Source path", "type":"string", "x-nullable":true }, "source_project":{ "description":"Project containing inventory file used as source.", "title":"Source project", "type":"string", "x-nullable":true }, "source_vars":{ "description":"Inventory source variables in YAML or JSON format.", "title":"Source vars", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "none" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) to run before the task is canceled.", "title":"Timeout", "type":"integer" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "update_cache_timeout":{ "minimum":"0", "title":"Update cache timeout", "type":"integer" }, "update_on_launch":{ "title":"Update on launch", "type":"boolean", "x-nullable":true }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "verbosity":{ "default":"1", "enum":[ "0", "1", "2" ], "title":"Verbosity", "type":"integer" } }, "required":[ "name", "inventory" ], "type":"object" }, "InventorySourceUpdate":{ "properties":{ "can_update":{ "readOnly":true, "title":"Can update", "type":"boolean" } }, "type":"object" }, "InventoryUpdateCancel":{ "properties":{ "can_cancel":{ "readOnly":true, "title":"Can cancel", "type":"boolean" } }, "type":"object" }, "InventoryUpdateDetail":{ "properties":{ "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "controller_node":{ "description":"The instance that managed the execution environment.", "minLength":"1", "readOnly":true, "title":"Controller node", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential":{ "description":"Cloud credential to use for inventory updates.", "minimum":"1", "title":"Credential", "type":"integer", "x-nullable":true }, "custom_virtualenv":{ "readOnly":true, "title":"Custom virtualenv", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "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. If the key is not found then the host will be enabled", "title":"Enabled value", "type":"string", "x-nullable":true }, "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)", "title":"Enabled var", "type":"string", "x-nullable":true }, "event_processing_finished":{ "description":"Indicates whether all of the events generated by this unified job have been saved to the database.", "readOnly":true, "title":"Event processing finished", "type":"boolean" }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "execution_node":{ "description":"The node the job executed on.", "minLength":"1", "readOnly":true, "title":"Execution node", "type":"string" }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "host_filter":{ "description":"This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.", "title":"Host filter", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "instance_group":{ "description":"The Instance group the job was run under", "title":"Instance group", "type":"integer", "x-nullable":true }, "inventory":{ "title":"Inventory", "type":"integer", "x-nullable":true }, "inventory_source":{ "readOnly":true, "title":"Inventory source", "type":"string" }, "job_args":{ "minLength":"1", "readOnly":true, "title":"Job args", "type":"string" }, "job_cwd":{ "minLength":"1", "readOnly":true, "title":"Job cwd", "type":"string" }, "job_env":{ "readOnly":true, "title":"job_env", "type":"object" }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "license_error":{ "readOnly":true, "title":"License error", "type":"boolean" }, "limit":{ "description":"Enter host, group or pattern match", "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "org_host_limit_error":{ "readOnly":true, "title":"Org host limit error", "type":"boolean" }, "overwrite":{ "description":"Overwrite local groups and hosts from remote inventory source.", "title":"Overwrite", "type":"boolean", "x-nullable":true }, "overwrite_vars":{ "description":"Overwrite local variables from remote inventory source.", "title":"Overwrite vars", "type":"boolean", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "result_traceback":{ "minLength":"1", "readOnly":true, "title":"Result traceback", "type":"string" }, "scm_branch":{ "description":"Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.", "maxLength":"1024", "title":"Scm branch", "type":"string", "x-nullable":true }, "scm_revision":{ "description":"The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm", "minLength":"1", "readOnly":true, "title":"SCM Revision", "type":"string" }, "source":{ "enum":[ "file", "constructed", "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights" ], "title":"Source", "type":"string", "x-nullable":true }, "source_path":{ "maxLength":"1024", "title":"Source path", "type":"string", "x-nullable":true }, "source_project":{ "description":"The project used for this job.", "readOnly":true, "title":"Source project", "type":"string" }, "source_project_update":{ "description":"Inventory files from this Project Update were used for the inventory update.", "title":"Source project update", "type":"string", "x-nullable":true }, "source_vars":{ "description":"Inventory source variables in YAML or JSON format.", "title":"Source vars", "type":"string", "x-nullable":true }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) to run before the task is canceled.", "title":"Timeout", "type":"integer" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "verbosity":{ "default":"1", "enum":[ "0", "1", "2" ], "title":"Verbosity", "type":"integer" }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "InventoryUpdateEvent":{ "properties":{ "changed":{ "readOnly":true, "title":"Changed", "type":"string" }, "counter":{ "minimum":"0", "readOnly":true, "title":"Counter", "type":"integer" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "end_line":{ "minimum":"0", "readOnly":true, "title":"End line", "type":"integer" }, "event":{ "readOnly":true, "title":"Event", "type":"string" }, "event_data":{ "title":"Event data", "type":"object" }, "event_display":{ "minLength":"1", "readOnly":true, "title":"Event display", "type":"string" }, "failed":{ "readOnly":true, "title":"Failed", "type":"string" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory_update":{ "readOnly":true, "title":"Inventory update", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "start_line":{ "minimum":"0", "readOnly":true, "title":"Start line", "type":"integer" }, "stdout":{ "minLength":"1", "readOnly":true, "title":"Stdout", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "uuid":{ "minLength":"1", "readOnly":true, "title":"Uuid", "type":"string" }, "verbosity":{ "minimum":"0", "readOnly":true, "title":"Verbosity", "type":"integer" } }, "type":"object" }, "InventoryUpdateList":{ "properties":{ "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "controller_node":{ "description":"The instance that managed the execution environment.", "minLength":"1", "readOnly":true, "title":"Controller node", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential":{ "description":"Cloud credential to use for inventory updates.", "minimum":"1", "title":"Credential", "type":"integer", "x-nullable":true }, "custom_virtualenv":{ "readOnly":true, "title":"Custom virtualenv", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "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. If the key is not found then the host will be enabled", "title":"Enabled value", "type":"string", "x-nullable":true }, "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)", "title":"Enabled var", "type":"string", "x-nullable":true }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "execution_node":{ "description":"The node the job executed on.", "minLength":"1", "readOnly":true, "title":"Execution node", "type":"string" }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "host_filter":{ "description":"This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.", "title":"Host filter", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "instance_group":{ "description":"The Instance group the job was run under", "title":"Instance group", "type":"integer", "x-nullable":true }, "inventory":{ "title":"Inventory", "type":"integer", "x-nullable":true }, "inventory_source":{ "readOnly":true, "title":"Inventory source", "type":"string" }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "license_error":{ "readOnly":true, "title":"License error", "type":"boolean" }, "limit":{ "description":"Enter host, group or pattern match", "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "org_host_limit_error":{ "readOnly":true, "title":"Org host limit error", "type":"boolean" }, "overwrite":{ "description":"Overwrite local groups and hosts from remote inventory source.", "title":"Overwrite", "type":"boolean", "x-nullable":true }, "overwrite_vars":{ "description":"Overwrite local variables from remote inventory source.", "title":"Overwrite vars", "type":"boolean", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "description":"Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.", "maxLength":"1024", "title":"Scm branch", "type":"string", "x-nullable":true }, "scm_revision":{ "description":"The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm", "minLength":"1", "readOnly":true, "title":"SCM Revision", "type":"string" }, "source":{ "enum":[ "file", "constructed", "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights" ], "title":"Source", "type":"string", "x-nullable":true }, "source_path":{ "maxLength":"1024", "title":"Source path", "type":"string", "x-nullable":true }, "source_project_update":{ "description":"Inventory files from this Project Update were used for the inventory update.", "title":"Source project update", "type":"string", "x-nullable":true }, "source_vars":{ "description":"Inventory source variables in YAML or JSON format.", "title":"Source vars", "type":"string", "x-nullable":true }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) to run before the task is canceled.", "title":"Timeout", "type":"integer" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "verbosity":{ "default":"1", "enum":[ "0", "1", "2" ], "title":"Verbosity", "type":"integer" }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "InventoryVariableData":{ "properties":{ "variables":{ "description":"Inventory variables in JSON or YAML format.", "title":"Variables", "type":"string", "x-nullable":true } }, "type":"object" }, "JobCancel":{ "properties":{ "can_cancel":{ "readOnly":true, "title":"Can cancel", "type":"boolean" } }, "type":"object" }, "JobCreateSchedule":{ "properties":{ "can_schedule":{ "readOnly":true, "title":"Can schedule", "type":"string" }, "prompts":{ "readOnly":true, "title":"Prompts", "type":"string" } }, "type":"object" }, "JobDetail":{ "properties":{ "allow_simultaneous":{ "title":"Allow simultaneous", "type":"boolean", "x-nullable":true }, "artifacts":{ "readOnly":true, "title":"Artifacts", "type":"string" }, "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "controller_node":{ "description":"The instance that managed the execution environment.", "minLength":"1", "readOnly":true, "title":"Controller node", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "custom_virtualenv":{ "readOnly":true, "title":"Custom virtualenv", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "diff_mode":{ "description":"If enabled, textual changes made to any templated files on the host are shown in the standard output", "title":"Diff mode", "type":"boolean", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "event_processing_finished":{ "description":"Indicates whether all of the events generated by this unified job have been saved to the database.", "readOnly":true, "title":"Event processing finished", "type":"boolean" }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "execution_node":{ "description":"The node the job executed on.", "minLength":"1", "readOnly":true, "title":"Execution node", "type":"string" }, "extra_vars":{ "title":"Extra vars", "type":"string", "x-nullable":true }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "force_handlers":{ "title":"Force handlers", "type":"boolean", "x-nullable":true }, "forks":{ "minimum":"0", "title":"Forks", "type":"integer" }, "host_status_counts":{ "description":"Playbook stats from the Ansible playbook_on_stats event.", "readOnly":true, "title":"Host status counts", "type":"object", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "instance_group":{ "description":"The Instance group the job was run under", "title":"Instance group", "type":"integer", "x-nullable":true }, "inventory":{ "title":"Inventory", "type":"integer", "x-nullable":true }, "job_args":{ "minLength":"1", "readOnly":true, "title":"Job args", "type":"string" }, "job_cwd":{ "minLength":"1", "readOnly":true, "title":"Job cwd", "type":"string" }, "job_env":{ "readOnly":true, "title":"job_env", "type":"object" }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "job_slice_count":{ "default":"1", "description":"If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job.", "minimum":"0", "title":"Job slice count", "type":"integer" }, "job_slice_number":{ "description":"If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used.", "minimum":"0", "title":"Job slice number", "type":"integer" }, "job_tags":{ "title":"Job tags", "type":"string", "x-nullable":true }, "job_template":{ "title":"Job template", "type":"string", "x-nullable":true }, "job_type":{ "default":"run", "enum":[ "run", "check", "scan" ], "title":"Job type", "type":"string", "x-nullable":true }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "organization":{ "description":"The organization used to determine access to this unified job.", "readOnly":true, "title":"Organization", "type":"integer", "x-nullable":true }, "passwords_needed_to_start":{ "readOnly":true, "title":"Passwords needed to start", "type":"string" }, "playbook":{ "maxLength":"1024", "title":"Playbook", "type":"string", "x-nullable":true }, "playbook_counts":{ "description":"A count of all plays and tasks for the job run.", "readOnly":true, "title":"Playbook counts", "type":"string" }, "project":{ "title":"Project", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "result_traceback":{ "minLength":"1", "readOnly":true, "title":"Result traceback", "type":"string" }, "scm_branch":{ "description":"Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.", "maxLength":"1024", "title":"Scm branch", "type":"string", "x-nullable":true }, "scm_revision":{ "description":"The SCM Revision from the Project used for this job, if available", "minLength":"1", "readOnly":true, "title":"SCM Revision", "type":"string" }, "skip_tags":{ "maxLength":"1024", "title":"Skip tags", "type":"string", "x-nullable":true }, "start_at_task":{ "maxLength":"1024", "title":"Start at task", "type":"string", "x-nullable":true }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) to run before the task is canceled.", "title":"Timeout", "type":"integer" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "use_fact_cache":{ "description":"If enabled, the service 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.", "title":"Use fact cache", "type":"boolean", "x-nullable":true }, "verbosity":{ "enum":[ "0", "1", "2", "3", "4", "5" ], "title":"Verbosity", "type":"integer" }, "webhook_credential":{ "description":"Personal Access Token for posting back the status to the service API", "title":"Webhook credential", "type":"integer", "x-nullable":true }, "webhook_guid":{ "description":"Unique identifier of the event that triggered this webhook", "maxLength":"128", "title":"Webhook guid", "type":"string", "x-nullable":true }, "webhook_service":{ "description":"Service that webhook requests will be accepted from", "enum":[ "github", "gitlab", "bitbucket_dc" ], "title":"Webhook service", "type":"string", "x-nullable":true }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "JobEvent":{ "properties":{ "changed":{ "readOnly":true, "title":"Changed", "type":"boolean" }, "counter":{ "minimum":"0", "readOnly":true, "title":"Counter", "type":"integer" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "end_line":{ "minimum":"0", "readOnly":true, "title":"End line", "type":"integer" }, "event":{ "enum":[ "runner_on_failed", "runner_on_start", "runner_on_ok", "runner_on_error", "runner_on_skipped", "runner_on_unreachable", "runner_on_no_hosts", "runner_on_async_poll", "runner_on_async_ok", "runner_on_async_failed", "runner_item_on_ok", "runner_item_on_failed", "runner_item_on_skipped", "runner_retry", "runner_on_file_diff", "playbook_on_start", "playbook_on_notify", "playbook_on_include", "playbook_on_no_hosts_matched", "playbook_on_no_hosts_remaining", "playbook_on_task_start", "playbook_on_vars_prompt", "playbook_on_setup", "playbook_on_import_for_host", "playbook_on_not_import_for_host", "playbook_on_play_start", "playbook_on_stats", "debug", "verbose", "deprecated", "warning", "system_warning", "error" ], "title":"Event", "type":"string", "x-nullable":true }, "event_data":{ "title":"Event data", "type":"object" }, "event_display":{ "minLength":"1", "readOnly":true, "title":"Event display", "type":"string" }, "event_level":{ "readOnly":true, "title":"Event level", "type":"integer" }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "host":{ "readOnly":true, "title":"Host", "type":"integer", "x-nullable":true }, "host_name":{ "minLength":"1", "readOnly":true, "title":"Host name", "type":"string" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "job":{ "readOnly":true, "title":"Job", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "parent_uuid":{ "minLength":"1", "readOnly":true, "title":"Parent uuid", "type":"string" }, "play":{ "minLength":"1", "readOnly":true, "title":"Play", "type":"string" }, "playbook":{ "minLength":"1", "readOnly":true, "title":"Playbook", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "role":{ "minLength":"1", "readOnly":true, "title":"Role", "type":"string" }, "start_line":{ "minimum":"0", "readOnly":true, "title":"Start line", "type":"integer" }, "stdout":{ "minLength":"1", "readOnly":true, "title":"Stdout", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "task":{ "minLength":"1", "readOnly":true, "title":"Task", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "uuid":{ "minLength":"1", "readOnly":true, "title":"Uuid", "type":"string" }, "verbosity":{ "minimum":"0", "readOnly":true, "title":"Verbosity", "type":"integer" } }, "required":[ "event" ], "type":"object" }, "JobHostSummary":{ "properties":{ "changed":{ "minimum":"0", "readOnly":true, "title":"Changed", "type":"integer" }, "constructed_host":{ "description":"Only for jobs run against constructed inventories, this links to the host inside the constructed inventory.", "readOnly":true, "title":"Constructed host", "type":"integer", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "dark":{ "minimum":"0", "readOnly":true, "title":"Dark", "type":"integer" }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "failures":{ "minimum":"0", "readOnly":true, "title":"Failures", "type":"integer" }, "host":{ "readOnly":true, "title":"Host", "type":"integer", "x-nullable":true }, "host_name":{ "minLength":"1", "readOnly":true, "title":"Host name", "type":"string" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "ignored":{ "minimum":"0", "readOnly":true, "title":"Ignored", "type":"integer" }, "job":{ "readOnly":true, "title":"Job", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "ok":{ "minimum":"0", "readOnly":true, "title":"Ok", "type":"integer" }, "processed":{ "minimum":"0", "readOnly":true, "title":"Processed", "type":"integer" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "rescued":{ "minimum":"0", "readOnly":true, "title":"Rescued", "type":"integer" }, "skipped":{ "minimum":"0", "readOnly":true, "title":"Skipped", "type":"integer" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "type":"object" }, "JobLaunch":{ "properties":{ "ask_credential_on_launch":{ "readOnly":true, "title":"Ask credential on launch", "type":"boolean", "x-nullable":true }, "ask_diff_mode_on_launch":{ "readOnly":true, "title":"Ask diff mode on launch", "type":"boolean", "x-nullable":true }, "ask_execution_environment_on_launch":{ "readOnly":true, "title":"Ask execution environment on launch", "type":"boolean", "x-nullable":true }, "ask_forks_on_launch":{ "readOnly":true, "title":"Ask forks on launch", "type":"boolean", "x-nullable":true }, "ask_instance_groups_on_launch":{ "readOnly":true, "title":"Ask instance groups on launch", "type":"boolean", "x-nullable":true }, "ask_inventory_on_launch":{ "readOnly":true, "title":"Ask inventory on launch", "type":"boolean", "x-nullable":true }, "ask_job_slice_count_on_launch":{ "readOnly":true, "title":"Ask job slice count on launch", "type":"boolean", "x-nullable":true }, "ask_job_type_on_launch":{ "readOnly":true, "title":"Ask job type on launch", "type":"boolean", "x-nullable":true }, "ask_labels_on_launch":{ "readOnly":true, "title":"Ask labels on launch", "type":"boolean", "x-nullable":true }, "ask_limit_on_launch":{ "readOnly":true, "title":"Ask limit on launch", "type":"boolean", "x-nullable":true }, "ask_scm_branch_on_launch":{ "readOnly":true, "title":"Ask scm branch on launch", "type":"boolean", "x-nullable":true }, "ask_skip_tags_on_launch":{ "readOnly":true, "title":"Ask skip tags on launch", "type":"boolean", "x-nullable":true }, "ask_tags_on_launch":{ "readOnly":true, "title":"Ask tags on launch", "type":"boolean", "x-nullable":true }, "ask_timeout_on_launch":{ "readOnly":true, "title":"Ask timeout on launch", "type":"boolean", "x-nullable":true }, "ask_variables_on_launch":{ "readOnly":true, "title":"Ask variables on launch", "type":"boolean", "x-nullable":true }, "ask_verbosity_on_launch":{ "readOnly":true, "title":"Ask verbosity on launch", "type":"boolean", "x-nullable":true }, "can_start_without_user_input":{ "readOnly":true, "title":"Can start without user input", "type":"boolean" }, "credential_needed_to_start":{ "readOnly":true, "title":"Credential needed to start", "type":"string" }, "credential_passwords":{ "title":"Credential passwords", "type":"string" }, "credentials":{ "items":{ "type":"integer" }, "type":"array", "uniqueItems":true }, "defaults":{ "readOnly":true, "title":"Defaults", "type":"string" }, "diff_mode":{ "title":"Diff mode", "type":"boolean" }, "execution_environment":{ "title":"Execution environment", "type":"integer" }, "extra_vars":{ "title":"Extra vars", "type":"object" }, "forks":{ "minimum":"0", "title":"Forks", "type":"integer" }, "instance_groups":{ "items":{ "type":"integer" }, "type":"array", "uniqueItems":true }, "inventory":{ "title":"Inventory", "type":"integer" }, "inventory_needed_to_start":{ "readOnly":true, "title":"Inventory needed to start", "type":"string" }, "job_slice_count":{ "minimum":"0", "title":"Job slice count", "type":"integer" }, "job_tags":{ "title":"Job tags", "type":"string" }, "job_template_data":{ "readOnly":true, "title":"Job template data", "type":"string" }, "job_type":{ "enum":[ "run", "check" ], "title":"Job type", "type":"string" }, "labels":{ "items":{ "type":"integer" }, "type":"array", "uniqueItems":true }, "limit":{ "title":"Limit", "type":"string" }, "passwords_needed_to_start":{ "readOnly":true, "title":"Passwords needed to start", "type":"string" }, "scm_branch":{ "title":"Scm branch", "type":"string" }, "skip_tags":{ "title":"Skip tags", "type":"string" }, "survey_enabled":{ "readOnly":true, "title":"Survey enabled", "type":"string" }, "timeout":{ "title":"Timeout", "type":"integer" }, "variables_needed_to_start":{ "readOnly":true, "title":"Variables needed to start", "type":"string" }, "verbosity":{ "enum":[ "0", "1", "2", "3", "4", "5" ], "title":"Verbosity", "type":"integer" } }, "type":"object" }, "JobList":{ "properties":{ "allow_simultaneous":{ "title":"Allow simultaneous", "type":"boolean", "x-nullable":true }, "artifacts":{ "readOnly":true, "title":"Artifacts", "type":"string" }, "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "controller_node":{ "description":"The instance that managed the execution environment.", "minLength":"1", "readOnly":true, "title":"Controller node", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "diff_mode":{ "description":"If enabled, textual changes made to any templated files on the host are shown in the standard output", "title":"Diff mode", "type":"boolean", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "execution_node":{ "description":"The node the job executed on.", "minLength":"1", "readOnly":true, "title":"Execution node", "type":"string" }, "extra_vars":{ "title":"Extra vars", "type":"string", "x-nullable":true }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "force_handlers":{ "title":"Force handlers", "type":"boolean", "x-nullable":true }, "forks":{ "minimum":"0", "title":"Forks", "type":"integer" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "instance_group":{ "description":"The Instance group the job was run under", "title":"Instance group", "type":"integer", "x-nullable":true }, "inventory":{ "title":"Inventory", "type":"integer", "x-nullable":true }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "job_slice_count":{ "default":"1", "description":"If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job.", "minimum":"0", "title":"Job slice count", "type":"integer" }, "job_slice_number":{ "description":"If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used.", "minimum":"0", "title":"Job slice number", "type":"integer" }, "job_tags":{ "title":"Job tags", "type":"string", "x-nullable":true }, "job_template":{ "title":"Job template", "type":"string", "x-nullable":true }, "job_type":{ "default":"run", "enum":[ "run", "check", "scan" ], "title":"Job type", "type":"string", "x-nullable":true }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "organization":{ "description":"The organization used to determine access to this unified job.", "readOnly":true, "title":"Organization", "type":"integer", "x-nullable":true }, "passwords_needed_to_start":{ "readOnly":true, "title":"Passwords needed to start", "type":"string" }, "playbook":{ "maxLength":"1024", "title":"Playbook", "type":"string", "x-nullable":true }, "project":{ "title":"Project", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "description":"Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.", "maxLength":"1024", "title":"Scm branch", "type":"string", "x-nullable":true }, "scm_revision":{ "description":"The SCM Revision from the Project used for this job, if available", "minLength":"1", "readOnly":true, "title":"SCM Revision", "type":"string" }, "skip_tags":{ "maxLength":"1024", "title":"Skip tags", "type":"string", "x-nullable":true }, "start_at_task":{ "maxLength":"1024", "title":"Start at task", "type":"string", "x-nullable":true }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) to run before the task is canceled.", "title":"Timeout", "type":"integer" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "use_fact_cache":{ "description":"If enabled, the service 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.", "title":"Use fact cache", "type":"boolean", "x-nullable":true }, "verbosity":{ "enum":[ "0", "1", "2", "3", "4", "5" ], "title":"Verbosity", "type":"integer" }, "webhook_credential":{ "description":"Personal Access Token for posting back the status to the service API", "title":"Webhook credential", "type":"integer", "x-nullable":true }, "webhook_guid":{ "description":"Unique identifier of the event that triggered this webhook", "maxLength":"128", "title":"Webhook guid", "type":"string", "x-nullable":true }, "webhook_service":{ "description":"Service that webhook requests will be accepted from", "enum":[ "github", "gitlab", "bitbucket_dc" ], "title":"Webhook service", "type":"string", "x-nullable":true }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "JobRelaunch":{ "properties":{ "credential_passwords":{ "title":"Credential passwords", "type":"string" }, "hosts":{ "default":"all", "enum":[ "all", "failed" ], "title":"Hosts", "type":"string", "x-nullable":true }, "passwords_needed_to_start":{ "readOnly":true, "title":"Passwords needed to start", "type":"string" }, "retry_counts":{ "readOnly":true, "title":"Retry counts", "type":"string" } }, "required":[ "credential_passwords" ], "type":"object" }, "JobTemplate":{ "properties":{ "allow_simultaneous":{ "title":"Allow simultaneous", "type":"boolean", "x-nullable":true }, "ask_credential_on_launch":{ "title":"Ask credential on launch", "type":"boolean", "x-nullable":true }, "ask_diff_mode_on_launch":{ "title":"Ask diff mode on launch", "type":"boolean", "x-nullable":true }, "ask_execution_environment_on_launch":{ "title":"Ask execution environment on launch", "type":"boolean", "x-nullable":true }, "ask_forks_on_launch":{ "title":"Ask forks on launch", "type":"boolean", "x-nullable":true }, "ask_instance_groups_on_launch":{ "title":"Ask instance groups on launch", "type":"boolean", "x-nullable":true }, "ask_inventory_on_launch":{ "title":"Ask inventory on launch", "type":"boolean", "x-nullable":true }, "ask_job_slice_count_on_launch":{ "title":"Ask job slice count on launch", "type":"boolean", "x-nullable":true }, "ask_job_type_on_launch":{ "title":"Ask job type on launch", "type":"boolean", "x-nullable":true }, "ask_labels_on_launch":{ "title":"Ask labels on launch", "type":"boolean", "x-nullable":true }, "ask_limit_on_launch":{ "title":"Ask limit on launch", "type":"boolean", "x-nullable":true }, "ask_scm_branch_on_launch":{ "title":"Ask scm branch on launch", "type":"boolean", "x-nullable":true }, "ask_skip_tags_on_launch":{ "title":"Ask skip tags on launch", "type":"boolean", "x-nullable":true }, "ask_tags_on_launch":{ "title":"Ask tags on launch", "type":"boolean", "x-nullable":true }, "ask_timeout_on_launch":{ "title":"Ask timeout on launch", "type":"boolean", "x-nullable":true }, "ask_variables_on_launch":{ "title":"Ask variables on launch", "type":"boolean", "x-nullable":true }, "ask_verbosity_on_launch":{ "title":"Ask verbosity on launch", "type":"boolean", "x-nullable":true }, "become_enabled":{ "title":"Become enabled", "type":"boolean", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "custom_virtualenv":{ "description":"Local absolute file path containing a custom Python virtualenv to use", "minLength":"1", "readOnly":true, "title":"Custom virtualenv", "type":"string", "x-nullable":true }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "diff_mode":{ "description":"If enabled, textual changes made to any templated files on the host are shown in the standard output", "title":"Diff mode", "type":"boolean", "x-nullable":true }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "extra_vars":{ "title":"Extra vars", "type":"string", "x-nullable":true }, "force_handlers":{ "title":"Force handlers", "type":"boolean", "x-nullable":true }, "forks":{ "minimum":"0", "title":"Forks", "type":"integer" }, "host_config_key":{ "maxLength":"1024", "title":"Host config key", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory":{ "title":"Inventory", "type":"integer", "x-nullable":true }, "job_slice_count":{ "default":"1", "description":"The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.", "minimum":"0", "title":"Job slice count", "type":"integer" }, "job_tags":{ "title":"Job tags", "type":"string", "x-nullable":true }, "job_type":{ "default":"run", "enum":[ "run", "check" ], "title":"Job type", "type":"string", "x-nullable":true }, "last_job_failed":{ "readOnly":true, "title":"Last job failed", "type":"boolean" }, "last_job_run":{ "format":"date-time", "readOnly":true, "title":"Last job run", "type":"string", "x-nullable":true }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "next_job_run":{ "format":"date-time", "readOnly":true, "title":"Next job run", "type":"string", "x-nullable":true }, "organization":{ "description":"The organization used to determine access to this template.", "readOnly":true, "title":"Organization", "type":"integer", "x-nullable":true }, "playbook":{ "maxLength":"1024", "title":"Playbook", "type":"string", "x-nullable":true }, "prevent_instance_group_fallback":{ "description":"If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.", "title":"Prevent instance group fallback", "type":"boolean", "x-nullable":true }, "project":{ "title":"Project", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "description":"Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.", "maxLength":"1024", "title":"Scm branch", "type":"string", "x-nullable":true }, "skip_tags":{ "maxLength":"1024", "title":"Skip tags", "type":"string", "x-nullable":true }, "start_at_task":{ "maxLength":"1024", "title":"Start at task", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "survey_enabled":{ "title":"Survey enabled", "type":"boolean", "x-nullable":true }, "timeout":{ "description":"The amount of time (in seconds) to run before the task is canceled.", "title":"Timeout", "type":"integer" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "use_fact_cache":{ "description":"If enabled, the service 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.", "title":"Use fact cache", "type":"boolean", "x-nullable":true }, "verbosity":{ "enum":[ "0", "1", "2", "3", "4", "5" ], "title":"Verbosity", "type":"integer" }, "webhook_credential":{ "description":"Personal Access Token for posting back the status to the service API", "title":"Webhook credential", "type":"integer", "x-nullable":true }, "webhook_service":{ "description":"Service that webhook requests will be accepted from", "enum":[ "github", "gitlab", "bitbucket_dc" ], "title":"Webhook service", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "Label":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "organization":{ "description":"Organization this label belongs to.", "title":"Organization", "type":"integer" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name", "organization" ], "type":"object" }, "Notification":{ "properties":{ "body":{ "description":"Notification body", "readOnly":true, "title":"Body", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "error":{ "minLength":"1", "readOnly":true, "title":"Error", "type":"string" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "notification_template":{ "readOnly":true, "title":"Notification template", "type":"integer" }, "notification_type":{ "enum":[ "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook" ], "title":"Notification type", "type":"string", "x-nullable":true }, "notifications_sent":{ "readOnly":true, "title":"Notifications sent", "type":"integer" }, "recipients":{ "minLength":"1", "readOnly":true, "title":"Recipients", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "status":{ "enum":[ "pending", "successful", "failed" ], "readOnly":true, "title":"Status", "type":"string" }, "subject":{ "minLength":"1", "readOnly":true, "title":"Subject", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "notification_type" ], "type":"object" }, "NotificationTemplate":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "messages":{ "default":{ }, "description":"Optional custom messages for notification template.", "title":"Messages", "type":"object", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "notification_configuration":{ "title":"Notification configuration", "type":"object" }, "notification_type":{ "enum":[ "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook" ], "title":"Notification type", "type":"string", "x-nullable":true }, "organization":{ "title":"Organization", "type":"integer", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name", "organization", "notification_type" ], "type":"object" }, "OAuth2Application":{ "properties":{ "authorization_grant_type":{ "description":"The Grant type the user must use for acquire tokens for this application.", "enum":[ "authorization-code", "password" ], "title":"Authorization Grant Type", "type":"string", "x-nullable":true }, "client_id":{ "minLength":"1", "readOnly":true, "title":"Client id", "type":"string", "x-nullable":true }, "client_secret":{ "description":"Used for more stringent verification of access to an application when creating a token.", "minLength":"1", "readOnly":true, "title":"Client Secret", "type":"string", "x-nullable":true }, "client_type":{ "description":"Set to Public or Confidential depending on how secure the client device is.", "enum":[ "confidential", "public" ], "title":"Client Type", "type":"string", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"Id", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"255", "title":"Name", "type":"string", "x-nullable":true }, "organization":{ "description":"Organization containing this application.", "title":"Organization", "type":"integer" }, "redirect_uris":{ "description":"Allowed URIs list, space separated", "title":"Redirect URIs", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "skip_authorization":{ "description":"Set True to skip authorization step for completely trusted applications.", "title":"Skip Authorization", "type":"boolean", "x-nullable":true }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name", "client_type", "authorization_grant_type", "organization" ], "type":"object" }, "OAuth2Token":{ "properties":{ "application":{ "title":"Application", "type":"integer", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "expires":{ "format":"date-time", "readOnly":true, "title":"Expires", "type":"string" }, "id":{ "readOnly":true, "title":"Id", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "refresh_token":{ "readOnly":true, "title":"Refresh token", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scope":{ "default":"write", "description":"Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", "title":"Scope", "type":"string", "x-nullable":true }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "token":{ "readOnly":true, "title":"Token", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "user":{ "description":"The user representing the token owner", "readOnly":true, "title":"User", "type":"integer" } }, "type":"object" }, "OAuth2TokenDetail":{ "properties":{ "application":{ "readOnly":true, "title":"Application", "type":"integer", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "expires":{ "format":"date-time", "readOnly":true, "title":"Expires", "type":"string" }, "id":{ "readOnly":true, "title":"Id", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "refresh_token":{ "readOnly":true, "title":"Refresh token", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scope":{ "default":"write", "description":"Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", "title":"Scope", "type":"string", "x-nullable":true }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "token":{ "readOnly":true, "title":"Token", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "user":{ "description":"The user representing the token owner", "readOnly":true, "title":"User", "type":"integer" } }, "type":"object" }, "Organization":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "custom_virtualenv":{ "description":"Local absolute file path containing a custom Python virtualenv to use", "minLength":"1", "readOnly":true, "title":"Custom virtualenv", "type":"string", "x-nullable":true }, "default_environment":{ "description":"The default execution environment for jobs run by this organization.", "title":"Default environment", "type":"integer", "x-nullable":true }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "max_hosts":{ "description":"Maximum number of hosts allowed to be managed by this organization.", "minimum":"0", "title":"Max hosts", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name" ], "type":"object" }, "OrganizationCredentialSerializerCreate":{ "properties":{ "cloud":{ "readOnly":true, "title":"Cloud", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential_type":{ "description":"Specify the type of credential you want to create. Refer to the documentation for details on each type.", "title":"Credential Type", "type":"integer" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inputs":{ "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", "title":"Inputs", "type":"object" }, "kind":{ "readOnly":true, "title":"Kind", "type":"string" }, "kubernetes":{ "readOnly":true, "title":"Kubernetes", "type":"string" }, "managed":{ "readOnly":true, "title":"Managed", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "organization":{ "description":"Inherit permissions from organization roles. If provided on creation, do not give either user or team.", "title":"Organization", "type":"integer", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name", "credential_type" ], "type":"object" }, "Project":{ "properties":{ "allow_override":{ "description":"Allow changing the SCM branch or revision in a job template that uses this project.", "title":"Allow override", "type":"boolean", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential":{ "title":"Credential", "type":"integer", "x-nullable":true }, "custom_virtualenv":{ "description":"Local absolute file path containing a custom Python virtualenv to use", "minLength":"1", "readOnly":true, "title":"Custom virtualenv", "type":"string", "x-nullable":true }, "default_environment":{ "description":"The default execution environment for jobs run using this project.", "title":"Default environment", "type":"integer", "x-nullable":true }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "last_job_failed":{ "readOnly":true, "title":"Last job failed", "type":"boolean" }, "last_job_run":{ "format":"date-time", "readOnly":true, "title":"Last job run", "type":"string", "x-nullable":true }, "last_update_failed":{ "readOnly":true, "title":"Last update failed", "type":"boolean" }, "last_updated":{ "format":"date-time", "readOnly":true, "title":"Last updated", "type":"string" }, "local_path":{ "description":"Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", "maxLength":"1024", "title":"Local path", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "next_job_run":{ "format":"date-time", "readOnly":true, "title":"Next job run", "type":"string", "x-nullable":true }, "organization":{ "description":"The organization used to determine access to this template.", "title":"Organization", "type":"integer", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "description":"Specific branch, tag or commit to checkout.", "maxLength":"256", "title":"SCM Branch", "type":"string", "x-nullable":true }, "scm_clean":{ "description":"Discard any local changes before syncing the project.", "title":"Scm clean", "type":"boolean", "x-nullable":true }, "scm_delete_on_update":{ "description":"Delete the project before syncing.", "title":"Scm delete on update", "type":"boolean", "x-nullable":true }, "scm_refspec":{ "description":"For git projects, an additional refspec to fetch.", "maxLength":"1024", "title":"SCM refspec", "type":"string", "x-nullable":true }, "scm_revision":{ "description":"The last revision fetched by a project update", "minLength":"1", "readOnly":true, "title":"SCM Revision", "type":"string" }, "scm_track_submodules":{ "description":"Track submodules latest commits on defined branch.", "title":"Scm track submodules", "type":"boolean", "x-nullable":true }, "scm_type":{ "description":"Specifies the source control system used to store the project.", "enum":[ "", "git", "svn", "insights", "archive" ], "title":"SCM Type", "type":"string", "x-nullable":true }, "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.", "minimum":"0", "title":"Scm update cache timeout", "type":"integer" }, "scm_update_on_launch":{ "description":"Update the project when a job is launched that uses the project.", "title":"Scm update on launch", "type":"boolean", "x-nullable":true }, "scm_url":{ "description":"The location where the project is stored.", "maxLength":"1024", "title":"SCM URL", "type":"string", "x-nullable":true }, "signature_validation_credential":{ "description":"An optional credential used for validating files in the project against unexpected changes.", "title":"Signature validation credential", "type":"integer", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) to run before the task is canceled.", "title":"Timeout", "type":"integer" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name" ], "type":"object" }, "ProjectInventories":{ "properties":{ "inventory_files":{ "description":"Array of inventory files and directories available within this project, not comprehensive.", "readOnly":true, "title":"Inventory files", "type":"string" } }, "type":"object" }, "ProjectPlaybooks":{ "properties":{ "playbooks":{ "description":"Array of playbooks available within this project.", "readOnly":true, "title":"Playbooks", "type":"string" } }, "type":"object" }, "ProjectUpdateCancel":{ "properties":{ "can_cancel":{ "readOnly":true, "title":"Can cancel", "type":"boolean" } }, "type":"object" }, "ProjectUpdateDetail":{ "properties":{ "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential":{ "title":"Credential", "type":"integer", "x-nullable":true }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "event_processing_finished":{ "description":"Indicates whether all of the events generated by this unified job have been saved to the database.", "readOnly":true, "title":"Event processing finished", "type":"boolean" }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "execution_node":{ "description":"The node the job executed on.", "minLength":"1", "readOnly":true, "title":"Execution node", "type":"string" }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "host_status_counts":{ "description":"Playbook stats from the Ansible playbook_on_stats event.", "readOnly":true, "title":"Host status counts", "type":"object", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "job_args":{ "minLength":"1", "readOnly":true, "title":"Job args", "type":"string" }, "job_cwd":{ "minLength":"1", "readOnly":true, "title":"Job cwd", "type":"string" }, "job_env":{ "readOnly":true, "title":"job_env", "type":"object" }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "job_tags":{ "description":"Parts of the project update playbook that will be run.", "maxLength":"1024", "title":"Job tags", "type":"string", "x-nullable":true }, "job_type":{ "default":"check", "enum":[ "run", "check" ], "title":"Job type", "type":"string", "x-nullable":true }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "local_path":{ "description":"Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", "maxLength":"1024", "title":"Local path", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "playbook_counts":{ "description":"A count of all plays and tasks for the job run.", "readOnly":true, "title":"Playbook counts", "type":"string" }, "project":{ "readOnly":true, "title":"Project", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "result_traceback":{ "minLength":"1", "readOnly":true, "title":"Result traceback", "type":"string" }, "scm_branch":{ "description":"Specific branch, tag or commit to checkout.", "maxLength":"256", "title":"SCM Branch", "type":"string", "x-nullable":true }, "scm_clean":{ "description":"Discard any local changes before syncing the project.", "title":"Scm clean", "type":"boolean", "x-nullable":true }, "scm_delete_on_update":{ "description":"Delete the project before syncing.", "title":"Scm delete on update", "type":"boolean", "x-nullable":true }, "scm_refspec":{ "description":"For git projects, an additional refspec to fetch.", "maxLength":"1024", "title":"SCM refspec", "type":"string", "x-nullable":true }, "scm_revision":{ "description":"The SCM Revision discovered by this update for the given project and branch.", "minLength":"1", "readOnly":true, "title":"SCM Revision", "type":"string" }, "scm_track_submodules":{ "description":"Track submodules latest commits on defined branch.", "title":"Scm track submodules", "type":"boolean", "x-nullable":true }, "scm_type":{ "description":"Specifies the source control system used to store the project.", "enum":[ "", "git", "svn", "insights", "archive" ], "title":"SCM Type", "type":"string", "x-nullable":true }, "scm_url":{ "description":"The location where the project is stored.", "maxLength":"1024", "title":"SCM URL", "type":"string", "x-nullable":true }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) to run before the task is canceled.", "title":"Timeout", "type":"integer" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "ProjectUpdateEvent":{ "properties":{ "changed":{ "readOnly":true, "title":"Changed", "type":"boolean" }, "counter":{ "minimum":"0", "readOnly":true, "title":"Counter", "type":"integer" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "end_line":{ "minimum":"0", "readOnly":true, "title":"End line", "type":"integer" }, "event":{ "enum":[ "runner_on_failed", "runner_on_start", "runner_on_ok", "runner_on_error", "runner_on_skipped", "runner_on_unreachable", "runner_on_no_hosts", "runner_on_async_poll", "runner_on_async_ok", "runner_on_async_failed", "runner_item_on_ok", "runner_item_on_failed", "runner_item_on_skipped", "runner_retry", "runner_on_file_diff", "playbook_on_start", "playbook_on_notify", "playbook_on_include", "playbook_on_no_hosts_matched", "playbook_on_no_hosts_remaining", "playbook_on_task_start", "playbook_on_vars_prompt", "playbook_on_setup", "playbook_on_import_for_host", "playbook_on_not_import_for_host", "playbook_on_play_start", "playbook_on_stats", "debug", "verbose", "deprecated", "warning", "system_warning", "error" ], "title":"Event", "type":"string", "x-nullable":true }, "event_data":{ "readOnly":true, "title":"Event data", "type":"string" }, "event_display":{ "minLength":"1", "readOnly":true, "title":"Event display", "type":"string" }, "event_level":{ "readOnly":true, "title":"Event level", "type":"integer" }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "host_name":{ "readOnly":true, "title":"Host name", "type":"string" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "play":{ "minLength":"1", "readOnly":true, "title":"Play", "type":"string" }, "playbook":{ "minLength":"1", "readOnly":true, "title":"Playbook", "type":"string" }, "project_update":{ "readOnly":true, "title":"Project update", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "role":{ "minLength":"1", "readOnly":true, "title":"Role", "type":"string" }, "start_line":{ "minimum":"0", "readOnly":true, "title":"Start line", "type":"integer" }, "stdout":{ "readOnly":true, "title":"Stdout", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "task":{ "minLength":"1", "readOnly":true, "title":"Task", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "uuid":{ "minLength":"1", "readOnly":true, "title":"Uuid", "type":"string" }, "verbosity":{ "minimum":"0", "readOnly":true, "title":"Verbosity", "type":"integer" } }, "required":[ "event" ], "type":"object" }, "ProjectUpdateList":{ "properties":{ "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential":{ "title":"Credential", "type":"integer", "x-nullable":true }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "execution_node":{ "description":"The node the job executed on.", "minLength":"1", "readOnly":true, "title":"Execution node", "type":"string" }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "job_tags":{ "description":"Parts of the project update playbook that will be run.", "maxLength":"1024", "title":"Job tags", "type":"string", "x-nullable":true }, "job_type":{ "default":"check", "enum":[ "run", "check" ], "title":"Job type", "type":"string", "x-nullable":true }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "local_path":{ "description":"Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", "maxLength":"1024", "title":"Local path", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "project":{ "readOnly":true, "title":"Project", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "description":"Specific branch, tag or commit to checkout.", "maxLength":"256", "title":"SCM Branch", "type":"string", "x-nullable":true }, "scm_clean":{ "description":"Discard any local changes before syncing the project.", "title":"Scm clean", "type":"boolean", "x-nullable":true }, "scm_delete_on_update":{ "description":"Delete the project before syncing.", "title":"Scm delete on update", "type":"boolean", "x-nullable":true }, "scm_refspec":{ "description":"For git projects, an additional refspec to fetch.", "maxLength":"1024", "title":"SCM refspec", "type":"string", "x-nullable":true }, "scm_revision":{ "description":"The SCM Revision discovered by this update for the given project and branch.", "minLength":"1", "readOnly":true, "title":"SCM Revision", "type":"string" }, "scm_track_submodules":{ "description":"Track submodules latest commits on defined branch.", "title":"Scm track submodules", "type":"boolean", "x-nullable":true }, "scm_type":{ "description":"Specifies the source control system used to store the project.", "enum":[ "", "git", "svn", "insights", "archive" ], "title":"SCM Type", "type":"string", "x-nullable":true }, "scm_url":{ "description":"The location where the project is stored.", "maxLength":"1024", "title":"SCM URL", "type":"string", "x-nullable":true }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) to run before the task is canceled.", "title":"Timeout", "type":"integer" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "ProjectUpdateView":{ "properties":{ "can_update":{ "readOnly":true, "title":"Can update", "type":"boolean" } }, "type":"object" }, "ResourceAccessListElement":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "email":{ "maxLength":"254", "title":"Email address", "type":"string", "x-nullable":true }, "external_account":{ "description":"Set if the account is managed by an external service", "readOnly":true, "title":"External account", "type":"string" }, "first_name":{ "maxLength":"150", "title":"First name", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "is_superuser":{ "description":"Designates that this user has all permissions without explicitly assigning them.", "title":"Superuser status", "type":"boolean", "x-nullable":true }, "is_system_auditor":{ "title":"Is system auditor", "type":"boolean" }, "last_login":{ "format":"date-time", "readOnly":true, "title":"Last login", "type":"string", "x-nullable":true }, "last_name":{ "maxLength":"150", "title":"Last name", "type":"string", "x-nullable":true }, "ldap_dn":{ "minLength":"1", "readOnly":true, "title":"Ldap dn", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "password":{ "description":"Field used to change the password.", "minLength":"1", "title":"Password", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "username":{ "description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "maxLength":"150", "minLength":"1", "pattern":"^[\\w.@+-]+$", "title":"Username", "type":"string", "x-nullable":true } }, "required":[ "username" ], "type":"object" }, "Role":{ "properties":{ "description":{ "readOnly":true, "title":"Description", "type":"string" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "name":{ "readOnly":true, "title":"Name", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "type":"object" }, "RoleSerializerWithParentAccess":{ "properties":{ "description":{ "readOnly":true, "title":"Description", "type":"string" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "name":{ "readOnly":true, "title":"Name", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "type":"object" }, "Schedule":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "diff_mode":{ "title":"Diff mode", "type":"boolean", "x-nullable":true }, "dtend":{ "description":"The last occurrence of the schedule occurs before this time, aftewards the schedule expires.", "format":"date-time", "readOnly":true, "title":"Dtend", "type":"string", "x-nullable":true }, "dtstart":{ "description":"The first occurrence of the schedule occurs on or after this time.", "format":"date-time", "readOnly":true, "title":"Dtstart", "type":"string", "x-nullable":true }, "enabled":{ "default":true, "description":"Enables processing of this schedule.", "title":"Enabled", "type":"boolean", "x-nullable":true }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "extra_data":{ "title":"Extra data", "type":"object" }, "forks":{ "minimum":"0", "title":"Forks", "type":"integer", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory":{ "description":"Inventory applied as a prompt, assuming job template prompts for inventory", "title":"Inventory", "type":"integer", "x-nullable":true }, "job_slice_count":{ "minimum":"0", "title":"Job slice count", "type":"integer", "x-nullable":true }, "job_tags":{ "title":"Job tags", "type":"string", "x-nullable":true }, "job_type":{ "enum":[ "run", "check" ], "title":"Job type", "type":"string", "x-nullable":true }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "next_run":{ "description":"The next time that the scheduled action will run.", "format":"date-time", "readOnly":true, "title":"Next run", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "rrule":{ "description":"A value representing the schedules iCal recurrence rule.", "minLength":"1", "title":"Rrule", "type":"string", "x-nullable":true }, "scm_branch":{ "title":"Scm branch", "type":"string", "x-nullable":true }, "skip_tags":{ "title":"Skip tags", "type":"string", "x-nullable":true }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "title":"Timeout", "type":"integer", "x-nullable":true }, "timezone":{ "description":"The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field.", "readOnly":true, "title":"Timezone", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "title":"Unified job template", "type":"integer" }, "until":{ "description":"The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned", "readOnly":true, "title":"Until", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "verbosity":{ "enum":[ "0", "1", "2", "3", "4", "5" ], "title":"Verbosity", "type":"string", "x-nullable":true } }, "required":[ "rrule", "name", "unified_job_template" ], "type":"object" }, "SchedulePreview":{ "properties":{ "rrule":{ "description":"A value representing the schedules iCal recurrence rule.", "minLength":"1", "title":"Rrule", "type":"string", "x-nullable":true } }, "required":[ "rrule" ], "type":"object" }, "SettingCategory":{ "properties":{ "name":{ "minLength":"1", "readOnly":true, "title":"Name", "type":"string" }, "slug":{ "minLength":"1", "readOnly":true, "title":"Slug", "type":"string" }, "url":{ "minLength":"1", "readOnly":true, "title":"Url", "type":"string" } }, "type":"object" }, "SettingSingleton":{ "properties":{ "ACTIVITY_STREAM_ENABLED":{ "default":true, "description":"Enable capturing activity for the activity stream.", "title":"Enable Activity Stream", "type":"boolean" }, "ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC":{ "description":"Enable capturing activity for the activity stream when running inventory sync.", "title":"Enable Activity Stream for Inventory Sync", "type":"boolean" }, "AD_HOC_COMMANDS":{ "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" ], "description":"List of modules allowed to be used by ad-hoc jobs.", "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "ALLOW_JINJA_IN_EXTRA_VARS":{ "default":"template", "description":"Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where 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\".", "enum":[ "always", "never", "template" ], "title":"When can extra variables contain Jinja templates?", "type":"string" }, "ALLOW_METRICS_FOR_ANONYMOUS_USERS":{ "description":"If true, anonymous users are allowed to poll metrics.", "title":"Allow anonymous users to poll metrics", "type":"boolean" }, "ALLOW_OAUTH2_FOR_EXTERNAL_USERS":{ "description":"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.", "title":"Allow External Users to Create OAuth2 Tokens", "type":"boolean" }, "ANSIBLE_FACT_CACHE_TIMEOUT":{ "description":"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.", "minimum":"0", "title":"Per-Host Ansible Fact Cache Timeout", "type":"integer" }, "API_400_ERROR_LOG_FORMAT":{ "default":"status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}", "description":"The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {}.", "minLength":"1", "title":"Log Format For API 4XX Errors", "type":"string" }, "AUTHENTICATION_BACKENDS":{ "default":[ "awx.sso.backends.TACACSPlusBackend", "awx.main.backends.AWXModelBackend" ], "description":"List of authentication backends that are enabled based on license features and other authentication settings.", "items":{ "minLength":"1", "type":"string" }, "readOnly":true, "type":"array" }, "AUTH_BASIC_ENABLED":{ "default":true, "description":"Enable HTTP Basic Auth for the API Browser.", "title":"Enable HTTP Basic Auth", "type":"boolean" }, "AUTH_LDAP_1_BIND_DN":{ "description":"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 documentation for example syntax.", "title":"LDAP Bind DN", "type":"string" }, "AUTH_LDAP_1_BIND_PASSWORD":{ "description":"Password used to bind LDAP user account.", "title":"LDAP Bind Password", "type":"string" }, "AUTH_LDAP_1_CONNECTION_OPTIONS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "OPT_NETWORK_TIMEOUT":"30", "OPT_REFERRALS":"0" }, "description":"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.", "title":"LDAP Connection Options", "type":"object" }, "AUTH_LDAP_1_DENY_GROUP":{ "description":"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.", "title":"LDAP Deny Group", "type":"string", "x-nullable":true }, "AUTH_LDAP_1_GROUP_SEARCH":{ "description":"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.", "items":{ "type":"string", "x-nullable":true }, "type":"array" }, "AUTH_LDAP_1_GROUP_TYPE":{ "default":"MemberDNGroupType", "description":"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", "enum":[ "PosixGroupType", "GroupOfNamesType", "GroupOfUniqueNamesType", "ActiveDirectoryGroupType", "OrganizationalRoleGroupType", "MemberDNGroupType", "NestedGroupOfNamesType", "NestedGroupOfUniqueNamesType", "NestedActiveDirectoryGroupType", "NestedOrganizationalRoleGroupType", "NestedMemberDNGroupType", "PosixUIDGroupType" ], "title":"LDAP Group Type", "type":"string" }, "AUTH_LDAP_1_GROUP_TYPE_PARAMS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "member_attr":"member", "name_attr":"cn" }, "description":"Key value parameters to send the chosen group type init method.", "title":"LDAP Group Type Parameters", "type":"object" }, "AUTH_LDAP_1_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", "title":"LDAP Organization Map", "type":"object" }, "AUTH_LDAP_1_REQUIRE_GROUP":{ "description":"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 to the service. Only one require group is supported.", "title":"LDAP Require Group", "type":"string", "x-nullable":true }, "AUTH_LDAP_1_SERVER_URI":{ "description":"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.", "title":"LDAP Server URI", "type":"string" }, "AUTH_LDAP_1_START_TLS":{ "description":"Whether to enable TLS when the LDAP connection is not using SSL.", "title":"LDAP Start TLS", "type":"boolean" }, "AUTH_LDAP_1_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", "title":"LDAP Team Map", "type":"object" }, "AUTH_LDAP_1_USER_ATTR_MAP":{ "additionalProperties":{ "minLength":"1", "type":"string" }, "description":"Mapping of LDAP user schema to 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 documentation for additional details.", "title":"LDAP User Attribute Map", "type":"object" }, "AUTH_LDAP_1_USER_DN_TEMPLATE":{ "description":"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.", "title":"LDAP User DN Template", "type":"string", "x-nullable":true }, "AUTH_LDAP_1_USER_FLAGS_BY_GROUP":{ "additionalProperties":{ "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "description":"Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", "title":"LDAP User Flags By Group", "type":"object" }, "AUTH_LDAP_1_USER_SEARCH":{ "description":"LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", "items":{ "type":"string", "x-nullable":true }, "type":"array" }, "AUTH_LDAP_2_BIND_DN":{ "description":"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 documentation for example syntax.", "title":"LDAP Bind DN", "type":"string" }, "AUTH_LDAP_2_BIND_PASSWORD":{ "description":"Password used to bind LDAP user account.", "title":"LDAP Bind Password", "type":"string" }, "AUTH_LDAP_2_CONNECTION_OPTIONS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "OPT_NETWORK_TIMEOUT":"30", "OPT_REFERRALS":"0" }, "description":"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.", "title":"LDAP Connection Options", "type":"object" }, "AUTH_LDAP_2_DENY_GROUP":{ "description":"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.", "title":"LDAP Deny Group", "type":"string", "x-nullable":true }, "AUTH_LDAP_2_GROUP_SEARCH":{ "description":"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.", "items":{ "type":"string", "x-nullable":true }, "type":"array" }, "AUTH_LDAP_2_GROUP_TYPE":{ "default":"MemberDNGroupType", "description":"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", "enum":[ "PosixGroupType", "GroupOfNamesType", "GroupOfUniqueNamesType", "ActiveDirectoryGroupType", "OrganizationalRoleGroupType", "MemberDNGroupType", "NestedGroupOfNamesType", "NestedGroupOfUniqueNamesType", "NestedActiveDirectoryGroupType", "NestedOrganizationalRoleGroupType", "NestedMemberDNGroupType", "PosixUIDGroupType" ], "title":"LDAP Group Type", "type":"string" }, "AUTH_LDAP_2_GROUP_TYPE_PARAMS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "member_attr":"member", "name_attr":"cn" }, "description":"Key value parameters to send the chosen group type init method.", "title":"LDAP Group Type Parameters", "type":"object" }, "AUTH_LDAP_2_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", "title":"LDAP Organization Map", "type":"object" }, "AUTH_LDAP_2_REQUIRE_GROUP":{ "description":"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 to the service. Only one require group is supported.", "title":"LDAP Require Group", "type":"string", "x-nullable":true }, "AUTH_LDAP_2_SERVER_URI":{ "description":"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.", "title":"LDAP Server URI", "type":"string" }, "AUTH_LDAP_2_START_TLS":{ "description":"Whether to enable TLS when the LDAP connection is not using SSL.", "title":"LDAP Start TLS", "type":"boolean" }, "AUTH_LDAP_2_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", "title":"LDAP Team Map", "type":"object" }, "AUTH_LDAP_2_USER_ATTR_MAP":{ "additionalProperties":{ "minLength":"1", "type":"string" }, "description":"Mapping of LDAP user schema to 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 documentation for additional details.", "title":"LDAP User Attribute Map", "type":"object" }, "AUTH_LDAP_2_USER_DN_TEMPLATE":{ "description":"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.", "title":"LDAP User DN Template", "type":"string", "x-nullable":true }, "AUTH_LDAP_2_USER_FLAGS_BY_GROUP":{ "additionalProperties":{ "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "description":"Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", "title":"LDAP User Flags By Group", "type":"object" }, "AUTH_LDAP_2_USER_SEARCH":{ "description":"LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", "items":{ "type":"string", "x-nullable":true }, "type":"array" }, "AUTH_LDAP_3_BIND_DN":{ "description":"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 documentation for example syntax.", "title":"LDAP Bind DN", "type":"string" }, "AUTH_LDAP_3_BIND_PASSWORD":{ "description":"Password used to bind LDAP user account.", "title":"LDAP Bind Password", "type":"string" }, "AUTH_LDAP_3_CONNECTION_OPTIONS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "OPT_NETWORK_TIMEOUT":"30", "OPT_REFERRALS":"0" }, "description":"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.", "title":"LDAP Connection Options", "type":"object" }, "AUTH_LDAP_3_DENY_GROUP":{ "description":"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.", "title":"LDAP Deny Group", "type":"string", "x-nullable":true }, "AUTH_LDAP_3_GROUP_SEARCH":{ "description":"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.", "items":{ "type":"string", "x-nullable":true }, "type":"array" }, "AUTH_LDAP_3_GROUP_TYPE":{ "default":"MemberDNGroupType", "description":"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", "enum":[ "PosixGroupType", "GroupOfNamesType", "GroupOfUniqueNamesType", "ActiveDirectoryGroupType", "OrganizationalRoleGroupType", "MemberDNGroupType", "NestedGroupOfNamesType", "NestedGroupOfUniqueNamesType", "NestedActiveDirectoryGroupType", "NestedOrganizationalRoleGroupType", "NestedMemberDNGroupType", "PosixUIDGroupType" ], "title":"LDAP Group Type", "type":"string" }, "AUTH_LDAP_3_GROUP_TYPE_PARAMS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "member_attr":"member", "name_attr":"cn" }, "description":"Key value parameters to send the chosen group type init method.", "title":"LDAP Group Type Parameters", "type":"object" }, "AUTH_LDAP_3_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", "title":"LDAP Organization Map", "type":"object" }, "AUTH_LDAP_3_REQUIRE_GROUP":{ "description":"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 to the service. Only one require group is supported.", "title":"LDAP Require Group", "type":"string", "x-nullable":true }, "AUTH_LDAP_3_SERVER_URI":{ "description":"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.", "title":"LDAP Server URI", "type":"string" }, "AUTH_LDAP_3_START_TLS":{ "description":"Whether to enable TLS when the LDAP connection is not using SSL.", "title":"LDAP Start TLS", "type":"boolean" }, "AUTH_LDAP_3_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", "title":"LDAP Team Map", "type":"object" }, "AUTH_LDAP_3_USER_ATTR_MAP":{ "additionalProperties":{ "minLength":"1", "type":"string" }, "description":"Mapping of LDAP user schema to 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 documentation for additional details.", "title":"LDAP User Attribute Map", "type":"object" }, "AUTH_LDAP_3_USER_DN_TEMPLATE":{ "description":"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.", "title":"LDAP User DN Template", "type":"string", "x-nullable":true }, "AUTH_LDAP_3_USER_FLAGS_BY_GROUP":{ "additionalProperties":{ "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "description":"Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", "title":"LDAP User Flags By Group", "type":"object" }, "AUTH_LDAP_3_USER_SEARCH":{ "description":"LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", "items":{ "type":"string", "x-nullable":true }, "type":"array" }, "AUTH_LDAP_4_BIND_DN":{ "description":"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 documentation for example syntax.", "title":"LDAP Bind DN", "type":"string" }, "AUTH_LDAP_4_BIND_PASSWORD":{ "description":"Password used to bind LDAP user account.", "title":"LDAP Bind Password", "type":"string" }, "AUTH_LDAP_4_CONNECTION_OPTIONS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "OPT_NETWORK_TIMEOUT":"30", "OPT_REFERRALS":"0" }, "description":"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.", "title":"LDAP Connection Options", "type":"object" }, "AUTH_LDAP_4_DENY_GROUP":{ "description":"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.", "title":"LDAP Deny Group", "type":"string", "x-nullable":true }, "AUTH_LDAP_4_GROUP_SEARCH":{ "description":"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.", "items":{ "type":"string", "x-nullable":true }, "type":"array" }, "AUTH_LDAP_4_GROUP_TYPE":{ "default":"MemberDNGroupType", "description":"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", "enum":[ "PosixGroupType", "GroupOfNamesType", "GroupOfUniqueNamesType", "ActiveDirectoryGroupType", "OrganizationalRoleGroupType", "MemberDNGroupType", "NestedGroupOfNamesType", "NestedGroupOfUniqueNamesType", "NestedActiveDirectoryGroupType", "NestedOrganizationalRoleGroupType", "NestedMemberDNGroupType", "PosixUIDGroupType" ], "title":"LDAP Group Type", "type":"string" }, "AUTH_LDAP_4_GROUP_TYPE_PARAMS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "member_attr":"member", "name_attr":"cn" }, "description":"Key value parameters to send the chosen group type init method.", "title":"LDAP Group Type Parameters", "type":"object" }, "AUTH_LDAP_4_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", "title":"LDAP Organization Map", "type":"object" }, "AUTH_LDAP_4_REQUIRE_GROUP":{ "description":"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 to the service. Only one require group is supported.", "title":"LDAP Require Group", "type":"string", "x-nullable":true }, "AUTH_LDAP_4_SERVER_URI":{ "description":"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.", "title":"LDAP Server URI", "type":"string" }, "AUTH_LDAP_4_START_TLS":{ "description":"Whether to enable TLS when the LDAP connection is not using SSL.", "title":"LDAP Start TLS", "type":"boolean" }, "AUTH_LDAP_4_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", "title":"LDAP Team Map", "type":"object" }, "AUTH_LDAP_4_USER_ATTR_MAP":{ "additionalProperties":{ "minLength":"1", "type":"string" }, "description":"Mapping of LDAP user schema to 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 documentation for additional details.", "title":"LDAP User Attribute Map", "type":"object" }, "AUTH_LDAP_4_USER_DN_TEMPLATE":{ "description":"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.", "title":"LDAP User DN Template", "type":"string", "x-nullable":true }, "AUTH_LDAP_4_USER_FLAGS_BY_GROUP":{ "additionalProperties":{ "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "description":"Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", "title":"LDAP User Flags By Group", "type":"object" }, "AUTH_LDAP_4_USER_SEARCH":{ "description":"LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", "items":{ "type":"string", "x-nullable":true }, "type":"array" }, "AUTH_LDAP_5_BIND_DN":{ "description":"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 documentation for example syntax.", "title":"LDAP Bind DN", "type":"string" }, "AUTH_LDAP_5_BIND_PASSWORD":{ "description":"Password used to bind LDAP user account.", "title":"LDAP Bind Password", "type":"string" }, "AUTH_LDAP_5_CONNECTION_OPTIONS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "OPT_NETWORK_TIMEOUT":"30", "OPT_REFERRALS":"0" }, "description":"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.", "title":"LDAP Connection Options", "type":"object" }, "AUTH_LDAP_5_DENY_GROUP":{ "description":"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.", "title":"LDAP Deny Group", "type":"string", "x-nullable":true }, "AUTH_LDAP_5_GROUP_SEARCH":{ "description":"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.", "items":{ "type":"string", "x-nullable":true }, "type":"array" }, "AUTH_LDAP_5_GROUP_TYPE":{ "default":"MemberDNGroupType", "description":"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", "enum":[ "PosixGroupType", "GroupOfNamesType", "GroupOfUniqueNamesType", "ActiveDirectoryGroupType", "OrganizationalRoleGroupType", "MemberDNGroupType", "NestedGroupOfNamesType", "NestedGroupOfUniqueNamesType", "NestedActiveDirectoryGroupType", "NestedOrganizationalRoleGroupType", "NestedMemberDNGroupType", "PosixUIDGroupType" ], "title":"LDAP Group Type", "type":"string" }, "AUTH_LDAP_5_GROUP_TYPE_PARAMS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "member_attr":"member", "name_attr":"cn" }, "description":"Key value parameters to send the chosen group type init method.", "title":"LDAP Group Type Parameters", "type":"object" }, "AUTH_LDAP_5_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", "title":"LDAP Organization Map", "type":"object" }, "AUTH_LDAP_5_REQUIRE_GROUP":{ "description":"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 to the service. Only one require group is supported.", "title":"LDAP Require Group", "type":"string", "x-nullable":true }, "AUTH_LDAP_5_SERVER_URI":{ "description":"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.", "title":"LDAP Server URI", "type":"string" }, "AUTH_LDAP_5_START_TLS":{ "description":"Whether to enable TLS when the LDAP connection is not using SSL.", "title":"LDAP Start TLS", "type":"boolean" }, "AUTH_LDAP_5_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", "title":"LDAP Team Map", "type":"object" }, "AUTH_LDAP_5_USER_ATTR_MAP":{ "additionalProperties":{ "minLength":"1", "type":"string" }, "description":"Mapping of LDAP user schema to 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 documentation for additional details.", "title":"LDAP User Attribute Map", "type":"object" }, "AUTH_LDAP_5_USER_DN_TEMPLATE":{ "description":"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.", "title":"LDAP User DN Template", "type":"string", "x-nullable":true }, "AUTH_LDAP_5_USER_FLAGS_BY_GROUP":{ "additionalProperties":{ "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "description":"Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", "title":"LDAP User Flags By Group", "type":"object" }, "AUTH_LDAP_5_USER_SEARCH":{ "description":"LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", "items":{ "type":"string", "x-nullable":true }, "type":"array" }, "AUTH_LDAP_BIND_DN":{ "description":"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 documentation for example syntax.", "title":"LDAP Bind DN", "type":"string" }, "AUTH_LDAP_BIND_PASSWORD":{ "description":"Password used to bind LDAP user account.", "title":"LDAP Bind Password", "type":"string" }, "AUTH_LDAP_CONNECTION_OPTIONS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "OPT_NETWORK_TIMEOUT":"30", "OPT_REFERRALS":"0" }, "description":"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.", "title":"LDAP Connection Options", "type":"object" }, "AUTH_LDAP_DENY_GROUP":{ "description":"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.", "title":"LDAP Deny Group", "type":"string", "x-nullable":true }, "AUTH_LDAP_GROUP_SEARCH":{ "description":"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.", "items":{ "type":"string", "x-nullable":true }, "type":"array" }, "AUTH_LDAP_GROUP_TYPE":{ "default":"MemberDNGroupType", "description":"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", "enum":[ "PosixGroupType", "GroupOfNamesType", "GroupOfUniqueNamesType", "ActiveDirectoryGroupType", "OrganizationalRoleGroupType", "MemberDNGroupType", "NestedGroupOfNamesType", "NestedGroupOfUniqueNamesType", "NestedActiveDirectoryGroupType", "NestedOrganizationalRoleGroupType", "NestedMemberDNGroupType", "PosixUIDGroupType" ], "title":"LDAP Group Type", "type":"string" }, "AUTH_LDAP_GROUP_TYPE_PARAMS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "member_attr":"member", "name_attr":"cn" }, "description":"Key value parameters to send the chosen group type init method.", "title":"LDAP Group Type Parameters", "type":"object" }, "AUTH_LDAP_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", "title":"LDAP Organization Map", "type":"object" }, "AUTH_LDAP_REQUIRE_GROUP":{ "description":"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 to the service. Only one require group is supported.", "title":"LDAP Require Group", "type":"string", "x-nullable":true }, "AUTH_LDAP_SERVER_URI":{ "description":"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.", "title":"LDAP Server URI", "type":"string" }, "AUTH_LDAP_START_TLS":{ "description":"Whether to enable TLS when the LDAP connection is not using SSL.", "title":"LDAP Start TLS", "type":"boolean" }, "AUTH_LDAP_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", "title":"LDAP Team Map", "type":"object" }, "AUTH_LDAP_USER_ATTR_MAP":{ "additionalProperties":{ "minLength":"1", "type":"string" }, "description":"Mapping of LDAP user schema to 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 documentation for additional details.", "title":"LDAP User Attribute Map", "type":"object" }, "AUTH_LDAP_USER_DN_TEMPLATE":{ "description":"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.", "title":"LDAP User DN Template", "type":"string", "x-nullable":true }, "AUTH_LDAP_USER_FLAGS_BY_GROUP":{ "additionalProperties":{ "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "description":"Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", "title":"LDAP User Flags By Group", "type":"object" }, "AUTH_LDAP_USER_SEARCH":{ "description":"LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", "items":{ "type":"string", "x-nullable":true }, "type":"array" }, "AUTOMATION_ANALYTICS_GATHER_INTERVAL":{ "default":"14400", "description":"Interval (in seconds) between data gathering.", "minimum":"1800", "title":"Automation Analytics Gather Interval", "type":"integer" }, "AUTOMATION_ANALYTICS_LAST_ENTRIES":{ "title":"Last gathered entries from the data collection service of Automation Analytics", "type":"string" }, "AUTOMATION_ANALYTICS_LAST_GATHER":{ "format":"date-time", "title":"Last gather date for Automation Analytics.", "type":"string", "x-nullable":true }, "AUTOMATION_ANALYTICS_URL":{ "default":"https://example.com", "description":"This setting is used to to configure the upload URL for data collection for Automation Analytics.", "minLength":"1", "title":"Automation Analytics upload URL", "type":"string" }, "AWX_ANSIBLE_CALLBACK_PLUGINS":{ "description":"List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line.", "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "AWX_CLEANUP_PATHS":{ "default":true, "description":"Enable or Disable TMP Dir cleanup", "title":"Enable or Disable tmp dir cleanup", "type":"boolean" }, "AWX_COLLECTIONS_ENABLED":{ "default":true, "description":"Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects.", "title":"Enable Collection(s) Download", "type":"boolean" }, "AWX_ISOLATION_BASE_PATH":{ "default":"/tmp", "description":"The directory in which the service will create new temporary directories for job execution and isolation (such as credential files).", "minLength":"1", "title":"Job execution path", "type":"string" }, "AWX_ISOLATION_SHOW_PATHS":{ "description":"List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. ", "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "AWX_MOUNT_ISOLATED_PATHS_ON_K8S":{ "description":"Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. ", "title":"Expose host paths for Container Groups", "type":"boolean" }, "AWX_REQUEST_PROFILE":{ "description":"Debug web request python timing", "title":"Debug Web Requests", "type":"boolean" }, "AWX_ROLES_ENABLED":{ "default":true, "description":"Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects.", "title":"Enable Role Download", "type":"boolean" }, "AWX_RUNNER_KEEPALIVE_SECONDS":{ "description":"Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open.", "title":"K8S Ansible Runner Keep-Alive Message Interval", "type":"integer" }, "AWX_SHOW_PLAYBOOK_LINKS":{ "description":"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.", "title":"Follow symlinks", "type":"boolean" }, "AWX_TASK_ENV":{ "additionalProperties":{ "minLength":"1", "type":"string" }, "description":"Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending.", "title":"Extra Environment Variables", "type":"object" }, "BULK_HOST_MAX_CREATE":{ "default":"100", "description":"Max number of hosts to allow to be created in a single bulk action", "title":"Max number of hosts to allow to be created in a single bulk action", "type":"integer" }, "BULK_HOST_MAX_DELETE":{ "default":"250", "description":"Max number of hosts to allow to be deleted in a single bulk action", "title":"Max number of hosts to allow to be deleted in a single bulk action", "type":"integer" }, "BULK_JOB_MAX_LAUNCH":{ "default":"100", "description":"Max jobs to allow bulk jobs to launch", "title":"Max jobs to allow bulk jobs to launch", "type":"integer" }, "CLEANUP_HOST_METRICS_LAST_TS":{ "format":"date-time", "title":"Last cleanup date for HostMetrics", "type":"string", "x-nullable":true }, "CSRF_TRUSTED_ORIGINS":{ "description":"If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. ", "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "CUSTOM_LOGIN_INFO":{ "description":"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.", "title":"Custom Login Info", "type":"string" }, "CUSTOM_LOGO":{ "description":"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.", "title":"Custom Logo", "type":"string" }, "CUSTOM_VENV_PATHS":{ "description":"Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line.", "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "DEFAULT_CONTAINER_RUN_OPTIONS":{ "default":[ "--network", "slirp4netns:enable_ipv6=true" ], "description":"List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug']", "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "DEFAULT_CONTROL_PLANE_QUEUE_NAME":{ "default":"controlplane", "minLength":"1", "readOnly":true, "title":"The instance group where control plane tasks run", "type":"string" }, "DEFAULT_EXECUTION_ENVIRONMENT":{ "description":"The Execution Environment to be used when one has not been configured for a job template.", "title":"Global default execution environment", "type":"integer", "x-nullable":true }, "DEFAULT_EXECUTION_QUEUE_NAME":{ "default":"default", "minLength":"1", "readOnly":true, "title":"The instance group where user jobs run (currently only on non-VM installs)", "type":"string" }, "DEFAULT_INVENTORY_UPDATE_TIMEOUT":{ "description":"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.", "minimum":"0", "title":"Default Inventory Update Timeout", "type":"integer" }, "DEFAULT_JOB_IDLE_TIMEOUT":{ "description":"If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed.", "minimum":"0", "title":"Default Job Idle Timeout", "type":"integer" }, "DEFAULT_JOB_TIMEOUT":{ "description":"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.", "minimum":"0", "title":"Default Job Timeout", "type":"integer" }, "DEFAULT_PROJECT_UPDATE_TIMEOUT":{ "description":"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.", "minimum":"0", "title":"Default Project Update Timeout", "type":"integer" }, "DISABLE_LOCAL_AUTH":{ "description":"Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration.", "title":"Disable the built-in authentication system", "type":"boolean" }, "EVENT_STDOUT_MAX_BYTES_DISPLAY":{ "default":"1024", "description":"Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `???` when truncated.", "minimum":"0", "title":"Job Event Standard Output Maximum Display Size", "type":"integer" }, "GALAXY_IGNORE_CERTS":{ "description":"If set to true, certificate validation will not be done when installing content from any Galaxy server.", "title":"Ignore Ansible Galaxy SSL Certificate Verification", "type":"boolean" }, "GALAXY_TASK_ENV":{ "additionalProperties":{ "minLength":"1", "type":"string" }, "default":{ "ANSIBLE_FORCE_COLOR":"false", "GIT_SSH_COMMAND":"ssh -o StrictHostKeyChecking=no" }, "description":"Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git.", "title":"Environment Variables for Galaxy Commands", "type":"object" }, "HOST_METRIC_SUMMARY_TASK_LAST_TS":{ "format":"date-time", "title":"Last computing date of HostMetricSummaryMonthly", "type":"string", "x-nullable":true }, "INSIGHTS_TRACKING_STATE":{ "description":"Enables the service to gather data on automation and send it to Automation Analytics.", "title":"Gather data for Automation Analytics", "type":"boolean" }, "INSTALL_UUID":{ "default":"00000000-0000-0000-0000-000000000000", "minLength":"1", "readOnly":true, "title":"Unique identifier for an installation", "type":"string" }, "IS_K8S":{ "description":"Indicates whether the instance is part of a kubernetes-based deployment.", "readOnly":true, "title":"Is k8s", "type":"boolean" }, "LICENSE":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "description":"The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license.", "readOnly":true, "title":"License", "type":"object" }, "LOCAL_PASSWORD_MIN_DIGITS":{ "description":"Minimum number of digit characters required in a local password. 0 means no minimum", "minimum":"0", "title":"Minimum number of digit characters in local password", "type":"integer" }, "LOCAL_PASSWORD_MIN_LENGTH":{ "description":"Minimum number of characters required in a local password. 0 means no minimum", "minimum":"0", "title":"Minimum number of characters in local password", "type":"integer" }, "LOCAL_PASSWORD_MIN_SPECIAL":{ "description":"Minimum number of special characters required in a local password. 0 means no minimum", "minimum":"0", "title":"Minimum number of special characters in local password", "type":"integer" }, "LOCAL_PASSWORD_MIN_UPPER":{ "description":"Minimum number of uppercase characters required in a local password. 0 means no minimum", "minimum":"0", "title":"Minimum number of uppercase characters in local password", "type":"integer" }, "LOGIN_REDIRECT_OVERRIDE":{ "description":"URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page.", "title":"Login redirect override URL", "type":"string" }, "LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB":{ "default":"1", "description":"Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH.", "minimum":"1", "title":"Maximum disk persistence for rsyslogd action queuing (in GB)", "type":"integer" }, "LOG_AGGREGATOR_ACTION_QUEUE_SIZE":{ "default":"131072", "description":"Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5).", "minimum":"1", "title":"Maximum number of messages that can be stored in the log action queue", "type":"integer" }, "LOG_AGGREGATOR_ENABLED":{ "description":"Enable sending logs to external log aggregator.", "title":"Enable External Logging", "type":"boolean" }, "LOG_AGGREGATOR_HOST":{ "description":"Hostname/IP where external logs will be sent to.", "minLength":"1", "title":"Logging Aggregator", "type":"string", "x-nullable":true }, "LOG_AGGREGATOR_INDIVIDUAL_FACTS":{ "description":"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.", "title":"Log System Tracking Facts Individually", "type":"boolean" }, "LOG_AGGREGATOR_LEVEL":{ "default":"INFO", "description":"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)", "enum":[ "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL" ], "title":"Logging Aggregator Level Threshold", "type":"string" }, "LOG_AGGREGATOR_LOGGERS":{ "default":[ "awx", "activity_stream", "job_events", "system_tracking", "broadcast_websocket" ], "description":"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\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n", "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "LOG_AGGREGATOR_MAX_DISK_USAGE_PATH":{ "default":"/var/lib/awx", "description":"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.", "minLength":"1", "title":"File system location for rsyslogd disk persistence", "type":"string" }, "LOG_AGGREGATOR_PASSWORD":{ "description":"Password or authentication token for external log aggregator (if required; HTTP/s only).", "title":"Logging Aggregator Password/Token", "type":"string" }, "LOG_AGGREGATOR_PORT":{ "description":"Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator).", "title":"Logging Aggregator Port", "type":"integer", "x-nullable":true }, "LOG_AGGREGATOR_PROTOCOL":{ "default":"https", "description":"Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname.", "enum":[ "https", "tcp", "udp" ], "title":"Logging Aggregator Protocol", "type":"string" }, "LOG_AGGREGATOR_RSYSLOGD_DEBUG":{ "description":"Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation.", "title":"Enable rsyslogd debugging", "type":"boolean" }, "LOG_AGGREGATOR_TCP_TIMEOUT":{ "default":"5", "description":"Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols.", "title":"TCP Connection Timeout", "type":"integer" }, "LOG_AGGREGATOR_TOWER_UUID":{ "description":"Useful to uniquely identify instances.", "title":"Cluster-wide unique identifier.", "type":"string" }, "LOG_AGGREGATOR_TYPE":{ "description":"Format messages for the chosen log aggregator.", "enum":[ "logstash", "splunk", "loggly", "sumologic", "other" ], "title":"Logging Aggregator Type", "type":"string", "x-nullable":true }, "LOG_AGGREGATOR_USERNAME":{ "description":"Username for external log aggregator (if required; HTTP/s only).", "title":"Logging Aggregator Username", "type":"string" }, "LOG_AGGREGATOR_VERIFY_CERT":{ "default":true, "description":"Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is \"https\". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection.", "title":"Enable/disable HTTPS certificate verification", "type":"boolean" }, "MANAGE_ORGANIZATION_AUTH":{ "default":true, "description":"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.", "title":"Organization Admins Can Manage Users and Teams", "type":"boolean" }, "MAX_FORKS":{ "default":"200", "description":"Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied.", "title":"Maximum number of forks per job", "type":"integer" }, "MAX_UI_JOB_EVENTS":{ "default":"4000", "description":"Maximum number of job events for the UI to retrieve within a single request.", "minimum":"100", "title":"Max Job Events Retrieved by UI", "type":"integer" }, "MAX_WEBSOCKET_EVENT_RATE":{ "default":"30", "description":"Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit.", "minimum":"0", "title":"Job Event Maximum Websocket Messages Per Second", "type":"integer" }, "OAUTH2_PROVIDER":{ "additionalProperties":{ "minimum":"1", "type":"integer" }, "default":{ "ACCESS_TOKEN_EXPIRE_SECONDS":"31536000000", "AUTHORIZATION_CODE_EXPIRE_SECONDS":"600", "REFRESH_TOKEN_EXPIRE_SECONDS":"2628000" }, "description":"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.", "title":"OAuth 2 Timeout Settings", "type":"object" }, "ORG_ADMINS_CAN_SEE_ALL_USERS":{ "default":true, "description":"Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization.", "title":"All Users Visible to Organization Admins", "type":"boolean" }, "PENDO_TRACKING_STATE":{ "default":"off", "description":"Enable or Disable User Analytics Tracking.", "enum":[ "off", "anonymous", "detailed" ], "readOnly":true, "title":"User Analytics Tracking State", "type":"string" }, "PROJECT_UPDATE_VVV":{ "description":"Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates.", "title":"Run Project Updates With Higher Verbosity", "type":"boolean" }, "PROXY_IP_ALLOWED_LIST":{ "description":"If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service 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')", "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "RADIUS_PORT":{ "default":"1812", "description":"Port of RADIUS server.", "maximum":"65535", "minimum":"1", "title":"RADIUS Port", "type":"integer" }, "RADIUS_SECRET":{ "description":"Shared secret for authenticating to RADIUS server.", "title":"RADIUS Secret", "type":"string" }, "RADIUS_SERVER":{ "description":"Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty.", "title":"RADIUS Server", "type":"string" }, "RECEPTOR_NO_SIG":{ "default":true, "description":"Indicates whether signatures for receptor work requests should be enforced.", "readOnly":true, "title":"Receptor no sig", "type":"boolean" }, "RECEPTOR_RELEASE_WORK":{ "default":true, "description":"Release receptor work", "title":"Release Receptor Work", "type":"boolean" }, "REDHAT_PASSWORD":{ "description":"This password is used to send data to Automation Analytics", "title":"Red Hat customer password", "type":"string" }, "REDHAT_USERNAME":{ "description":"This username is used to send data to Automation Analytics", "title":"Red Hat customer username", "type":"string" }, "REMOTE_HOST_HEADERS":{ "default":[ "REMOTE_ADDR", "REMOTE_HOST" ], "description":"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 AAP Installation guide for more details.", "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "SAML_AUTO_CREATE_OBJECTS":{ "default":true, "description":"When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login.", "title":"Automatically Create Organizations and Teams on SAML Login", "type":"boolean" }, "SCHEDULE_MAX_JOBS":{ "default":"10", "description":"Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created.", "minimum":"1", "title":"Maximum Scheduled Jobs", "type":"integer" }, "SESSIONS_PER_USER":{ "default":"-1", "description":"Maximum number of simultaneous logged in sessions a user may have. To disable enter -1.", "minimum":"-1", "title":"Maximum number of simultaneous logged in sessions", "type":"integer" }, "SESSION_COOKIE_AGE":{ "default":"1800", "description":"Number of seconds that a user is inactive before they will need to login again.", "maximum":"30000000000", "minimum":"60", "title":"Idle Time Force Log Out", "type":"integer" }, "SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL":{ "default":"https://olamhost/sso/complete/azuread-oauth2/", "description":"Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. ", "minLength":"1", "readOnly":true, "title":"Azure AD OAuth2 Callback URL", "type":"string" }, "SOCIAL_AUTH_AZUREAD_OAUTH2_KEY":{ "description":"The OAuth2 key (Client ID) from your Azure AD application.", "title":"Azure AD OAuth2 Key", "type":"string" }, "SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "title":"Azure AD OAuth2 Organization Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET":{ "description":"The OAuth2 secret (Client Secret) from your Azure AD application.", "title":"Azure AD OAuth2 Secret", "type":"string" }, "SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "title":"Azure AD OAuth2 Team Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GITHUB_CALLBACK_URL":{ "default":"https://olamhost/sso/complete/github/", "description":"Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", "minLength":"1", "readOnly":true, "title":"GitHub OAuth2 Callback URL", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL":{ "description":"The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details.", "title":"GitHub Enterprise API URL", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL":{ "default":"https://olamhost/sso/complete/github-enterprise/", "description":"Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", "minLength":"1", "readOnly":true, "title":"GitHub Enterprise OAuth2 Callback URL", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY":{ "description":"The OAuth2 key (Client ID) from your GitHub Enterprise developer application.", "title":"GitHub Enterprise OAuth2 Key", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "title":"GitHub Enterprise OAuth2 Organization Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL":{ "description":"The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details.", "title":"GitHub Enterprise Organization API URL", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL":{ "default":"https://olamhost/sso/complete/github-enterprise-org/", "description":"Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", "minLength":"1", "readOnly":true, "title":"GitHub Enterprise Organization OAuth2 Callback URL", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY":{ "description":"The OAuth2 key (Client ID) from your GitHub Enterprise organization application.", "title":"GitHub Enterprise Organization OAuth2 Key", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME":{ "description":"The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com//.", "title":"GitHub Enterprise Organization Name", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "title":"GitHub Enterprise Organization OAuth2 Organization Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET":{ "description":"The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application.", "title":"GitHub Enterprise Organization OAuth2 Secret", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "title":"GitHub Enterprise Organization OAuth2 Team Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL":{ "description":"The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details.", "title":"GitHub Enterprise Organization URL", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET":{ "description":"The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application.", "title":"GitHub Enterprise OAuth2 Secret", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL":{ "description":"The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details.", "title":"GitHub Enterprise Team API URL", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL":{ "default":"https://olamhost/sso/complete/github-enterprise-team/", "description":"Create an organization-owned application at https://github.com/organizations//settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application.", "minLength":"1", "readOnly":true, "title":"GitHub Enterprise Team OAuth2 Callback URL", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID":{ "description":"Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/.", "title":"GitHub Enterprise Team ID", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY":{ "description":"The OAuth2 key (Client ID) from your GitHub Enterprise organization application.", "title":"GitHub Enterprise Team OAuth2 Key", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "title":"GitHub Enterprise OAuth2 Team Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "title":"GitHub Enterprise Team OAuth2 Organization Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET":{ "description":"The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application.", "title":"GitHub Enterprise Team OAuth2 Secret", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "title":"GitHub Enterprise Team OAuth2 Team Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL":{ "description":"The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details.", "title":"GitHub Enterprise Team URL", "type":"string" }, "SOCIAL_AUTH_GITHUB_ENTERPRISE_URL":{ "description":"The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details.", "title":"GitHub Enterprise URL", "type":"string" }, "SOCIAL_AUTH_GITHUB_KEY":{ "description":"The OAuth2 key (Client ID) from your GitHub developer application.", "title":"GitHub OAuth2 Key", "type":"string" }, "SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "title":"GitHub OAuth2 Organization Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL":{ "default":"https://olamhost/sso/complete/github-org/", "description":"Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", "minLength":"1", "readOnly":true, "title":"GitHub Organization OAuth2 Callback URL", "type":"string" }, "SOCIAL_AUTH_GITHUB_ORG_KEY":{ "description":"The OAuth2 key (Client ID) from your GitHub organization application.", "title":"GitHub Organization OAuth2 Key", "type":"string" }, "SOCIAL_AUTH_GITHUB_ORG_NAME":{ "description":"The name of your GitHub organization, as used in your organization's URL: https://github.com//.", "title":"GitHub Organization Name", "type":"string" }, "SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "title":"GitHub Organization OAuth2 Organization Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GITHUB_ORG_SECRET":{ "description":"The OAuth2 secret (Client Secret) from your GitHub organization application.", "title":"GitHub Organization OAuth2 Secret", "type":"string" }, "SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "title":"GitHub Organization OAuth2 Team Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GITHUB_SECRET":{ "description":"The OAuth2 secret (Client Secret) from your GitHub developer application.", "title":"GitHub OAuth2 Secret", "type":"string" }, "SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL":{ "default":"https://olamhost/sso/complete/github-team/", "description":"Create an organization-owned application at https://github.com/organizations//settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application.", "minLength":"1", "readOnly":true, "title":"GitHub Team OAuth2 Callback URL", "type":"string" }, "SOCIAL_AUTH_GITHUB_TEAM_ID":{ "description":"Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/.", "title":"GitHub Team ID", "type":"string" }, "SOCIAL_AUTH_GITHUB_TEAM_KEY":{ "description":"The OAuth2 key (Client ID) from your GitHub organization application.", "title":"GitHub Team OAuth2 Key", "type":"string" }, "SOCIAL_AUTH_GITHUB_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "title":"GitHub OAuth2 Team Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "title":"GitHub Team OAuth2 Organization Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GITHUB_TEAM_SECRET":{ "description":"The OAuth2 secret (Client Secret) from your GitHub organization application.", "title":"GitHub Team OAuth2 Secret", "type":"string" }, "SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "title":"GitHub Team OAuth2 Team Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "description":"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 documentation for more detail.", "title":"Google OAuth2 Extra Arguments", "type":"object" }, "SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL":{ "default":"https://olamhost/sso/complete/google-oauth2/", "description":"Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", "minLength":"1", "readOnly":true, "title":"Google OAuth2 Callback URL", "type":"string" }, "SOCIAL_AUTH_GOOGLE_OAUTH2_KEY":{ "description":"The OAuth2 key from your web application.", "title":"Google OAuth2 Key", "type":"string" }, "SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "title":"Google OAuth2 Organization Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET":{ "description":"The OAuth2 secret from your web application.", "title":"Google OAuth2 Secret", "type":"string" }, "SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "title":"Google OAuth2 Team Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS":{ "description":"Update this setting to restrict the domains who are allowed to login using Google OAuth2.", "items":{ "minLength":"1", "type":"string" }, "type":"array" }, "SOCIAL_AUTH_OIDC_KEY":{ "description":"The OIDC key (Client ID) from your IDP.", "minLength":"1", "title":"OIDC Key", "type":"string" }, "SOCIAL_AUTH_OIDC_OIDC_ENDPOINT":{ "description":"The URL for your OIDC provider including the path up to /.well-known/openid-configuration", "title":"OIDC Provider URL", "type":"string" }, "SOCIAL_AUTH_OIDC_SECRET":{ "description":"The OIDC secret (Client Secret) from your IDP.", "title":"OIDC Secret", "type":"string" }, "SOCIAL_AUTH_OIDC_VERIFY_SSL":{ "default":true, "description":"Verify the OIDC provider ssl certificate.", "title":"Verify OIDC Provider Certificate", "type":"boolean" }, "SOCIAL_AUTH_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "title":"Social Auth Organization Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_SAML_CALLBACK_URL":{ "default":"https://olamhost/sso/complete/saml/", "description":"Register the service 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.", "minLength":"1", "readOnly":true, "title":"SAML Assertion Consumer Service (ACS) URL", "type":"string" }, "SOCIAL_AUTH_SAML_ENABLED_IDPS":{ "additionalProperties":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "type":"object" }, "description":"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.", "title":"SAML Enabled Identity Providers", "type":"object" }, "SOCIAL_AUTH_SAML_EXTRA_DATA":{ "description":"A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value.", "items":{ "type":"string", "x-nullable":true }, "type":"array", "x-nullable":true }, "SOCIAL_AUTH_SAML_METADATA_URL":{ "default":"https://olamhost/sso/metadata/saml/", "description":"If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL.", "minLength":"1", "readOnly":true, "title":"SAML Service Provider Metadata URL", "type":"string" }, "SOCIAL_AUTH_SAML_ORGANIZATION_ATTR":{ "additionalProperties":{ "type":"string" }, "description":"Used to translate user organization membership.", "title":"SAML Organization Attribute Mapping", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_SAML_ORGANIZATION_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "title":"SAML Organization Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_SAML_ORG_INFO":{ "additionalProperties":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "type":"object" }, "description":"Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax.", "title":"SAML Service Provider Organization Info", "type":"object" }, "SOCIAL_AUTH_SAML_SECURITY_CONFIG":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "default":{ "requestedAuthnContext":false }, "description":"A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings", "title":"SAML Security Config", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_SAML_SP_ENTITY_ID":{ "description":"The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service.", "title":"SAML Service Provider Entity ID", "type":"string" }, "SOCIAL_AUTH_SAML_SP_EXTRA":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "description":"A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting.", "title":"SAML Service Provider extra configuration data", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_SAML_SP_PRIVATE_KEY":{ "description":"Create a keypair to use as a service provider (SP) and include the private key content here.", "title":"SAML Service Provider Private Key", "type":"string" }, "SOCIAL_AUTH_SAML_SP_PUBLIC_CERT":{ "description":"Create a keypair to use as a service provider (SP) and include the certificate content here.", "title":"SAML Service Provider Public Certificate", "type":"string" }, "SOCIAL_AUTH_SAML_SUPPORT_CONTACT":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "description":"Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax.", "title":"SAML Service Provider Support Contact", "type":"object" }, "SOCIAL_AUTH_SAML_TEAM_ATTR":{ "additionalProperties":{ "type":"string" }, "description":"Used to translate user team membership.", "title":"SAML Team Attribute Mapping", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_SAML_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "title":"SAML Team Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_SAML_TECHNICAL_CONTACT":{ "additionalProperties":{ "type":"string", "x-nullable":true }, "description":"Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax.", "title":"SAML Service Provider Technical Contact", "type":"object" }, "SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR":{ "additionalProperties":{ "type":"string" }, "description":"Used to map super users and system auditors from SAML.", "title":"SAML User Flags Attribute Mapping", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_TEAM_MAP":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "title":"Social Auth Team Map", "type":"object", "x-nullable":true }, "SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL":{ "description":"Enabling this setting will tell social auth to use the full Email as username instead of the full name", "title":"Use Email address for usernames", "type":"boolean" }, "SOCIAL_AUTH_USER_FIELDS":{ "description":"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.", "items":{ "minLength":"1", "type":"string" }, "type":"array", "x-nullable":true }, "STDOUT_MAX_BYTES_DISPLAY":{ "default":"1048576", "description":"Maximum Size of Standard Output in bytes to display before requiring the output be downloaded.", "minimum":"0", "title":"Standard Output Maximum Display Size", "type":"integer" }, "SUBSCRIPTIONS_PASSWORD":{ "description":"This password is used to retrieve subscription and content information", "title":"Red Hat or Satellite password", "type":"string" }, "SUBSCRIPTIONS_USERNAME":{ "description":"This username is used to retrieve subscription and content information", "title":"Red Hat or Satellite username", "type":"string" }, "SUBSCRIPTION_USAGE_MODEL":{ "enum":[ "", "unique_managed_hosts" ], "title":"Defines subscription usage model and shows Host Metrics", "type":"string" }, "TACACSPLUS_AUTH_PROTOCOL":{ "default":"ascii", "description":"Choose the authentication protocol used by TACACS+ client.", "enum":[ "ascii", "pap" ], "title":"TACACS+ Authentication Protocol", "type":"string" }, "TACACSPLUS_HOST":{ "description":"Hostname of TACACS+ server.", "title":"TACACS+ Server", "type":"string" }, "TACACSPLUS_PORT":{ "default":"49", "description":"Port number of TACACS+ server.", "maximum":"65535", "minimum":"1", "title":"TACACS+ Port", "type":"integer" }, "TACACSPLUS_REM_ADDR":{ "description":"Enable the client address sending by TACACS+ client.", "title":"TACACS+ client address sending enabled", "type":"boolean" }, "TACACSPLUS_SECRET":{ "description":"Shared secret for authenticating to TACACS+ server.", "title":"TACACS+ Secret", "type":"string" }, "TACACSPLUS_SESSION_TIMEOUT":{ "default":"5", "description":"TACACS+ session timeout value in seconds, 0 disables timeout.", "minimum":"0", "title":"TACACS+ Auth Session Timeout", "type":"integer" }, "TOWER_URL_BASE":{ "default":"https://olamhost", "description":"This setting is used by services like notifications to render a valid url to the service.", "minLength":"1", "title":"Base URL of the service", "type":"string" }, "UI_LIVE_UPDATES_ENABLED":{ "default":true, "description":"If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details.", "title":"Enable Live Updates in the UI", "type":"boolean" }, "UI_NEXT":{ "description":"Enable preview of new user interface.", "title":"Enable Preview of New User Interface", "type":"boolean" } }, "required":[ "ACTIVITY_STREAM_ENABLED", "ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC", "ORG_ADMINS_CAN_SEE_ALL_USERS", "MANAGE_ORGANIZATION_AUTH", "TOWER_URL_BASE", "REMOTE_HOST_HEADERS", "PROXY_IP_ALLOWED_LIST", "ALLOW_JINJA_IN_EXTRA_VARS", "AWX_ISOLATION_BASE_PATH", "AWX_RUNNER_KEEPALIVE_SECONDS", "GALAXY_TASK_ENV", "PROJECT_UPDATE_VVV", "STDOUT_MAX_BYTES_DISPLAY", "EVENT_STDOUT_MAX_BYTES_DISPLAY", "SCHEDULE_MAX_JOBS", "AUTOMATION_ANALYTICS_LAST_GATHER", "CLEANUP_HOST_METRICS_LAST_TS", "HOST_METRIC_SUMMARY_TASK_LAST_TS", "SESSION_COOKIE_AGE", "SESSIONS_PER_USER", "DISABLE_LOCAL_AUTH", "AUTH_BASIC_ENABLED", "MAX_UI_JOB_EVENTS", "UI_LIVE_UPDATES_ENABLED", "SOCIAL_AUTH_SAML_SP_PUBLIC_CERT", "SOCIAL_AUTH_SAML_SP_PRIVATE_KEY", "SOCIAL_AUTH_SAML_ORG_INFO", "SOCIAL_AUTH_SAML_TECHNICAL_CONTACT", "SOCIAL_AUTH_SAML_SUPPORT_CONTACT" ], "type":"object" }, "SystemJob":{ "properties":{ "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "event_processing_finished":{ "description":"Indicates whether all of the events generated by this unified job have been saved to the database.", "readOnly":true, "title":"Event processing finished", "type":"boolean" }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "execution_node":{ "description":"The node the job executed on.", "minLength":"1", "readOnly":true, "title":"Execution node", "type":"string" }, "extra_vars":{ "title":"Extra vars", "type":"string", "x-nullable":true }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "job_args":{ "minLength":"1", "readOnly":true, "title":"Job args", "type":"string" }, "job_cwd":{ "minLength":"1", "readOnly":true, "title":"Job cwd", "type":"string" }, "job_env":{ "readOnly":true, "title":"job_env", "type":"object" }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "job_type":{ "enum":[ "cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "cleanup_tokens" ], "title":"Job type", "type":"string", "x-nullable":true }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "result_stdout":{ "readOnly":true, "title":"Result stdout", "type":"string" }, "result_traceback":{ "minLength":"1", "readOnly":true, "title":"Result traceback", "type":"string" }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "system_job_template":{ "title":"System job template", "type":"string", "x-nullable":true }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "SystemJobCancel":{ "properties":{ "can_cancel":{ "readOnly":true, "title":"Can cancel", "type":"boolean" } }, "type":"object" }, "SystemJobEvent":{ "properties":{ "changed":{ "readOnly":true, "title":"Changed", "type":"string" }, "counter":{ "minimum":"0", "readOnly":true, "title":"Counter", "type":"integer" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "end_line":{ "minimum":"0", "readOnly":true, "title":"End line", "type":"integer" }, "event":{ "readOnly":true, "title":"Event", "type":"string" }, "event_data":{ "title":"Event data", "type":"object" }, "event_display":{ "minLength":"1", "readOnly":true, "title":"Event display", "type":"string" }, "failed":{ "readOnly":true, "title":"Failed", "type":"string" }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "start_line":{ "minimum":"0", "readOnly":true, "title":"Start line", "type":"integer" }, "stdout":{ "minLength":"1", "readOnly":true, "title":"Stdout", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "system_job":{ "readOnly":true, "title":"System job", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "uuid":{ "minLength":"1", "readOnly":true, "title":"Uuid", "type":"string" }, "verbosity":{ "minimum":"0", "readOnly":true, "title":"Verbosity", "type":"integer" } }, "type":"object" }, "SystemJobList":{ "properties":{ "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "execution_node":{ "description":"The node the job executed on.", "minLength":"1", "readOnly":true, "title":"Execution node", "type":"string" }, "extra_vars":{ "title":"Extra vars", "type":"string", "x-nullable":true }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "job_type":{ "enum":[ "cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "cleanup_tokens" ], "title":"Job type", "type":"string", "x-nullable":true }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "result_stdout":{ "readOnly":true, "title":"Result stdout", "type":"string" }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "system_job_template":{ "title":"System job template", "type":"string", "x-nullable":true }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "SystemJobTemplate":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "job_type":{ "enum":[ "cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "cleanup_tokens" ], "title":"Job type", "type":"string", "x-nullable":true }, "last_job_failed":{ "readOnly":true, "title":"Last job failed", "type":"boolean" }, "last_job_run":{ "format":"date-time", "readOnly":true, "title":"Last job run", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "next_job_run":{ "format":"date-time", "readOnly":true, "title":"Next job run", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name" ], "type":"object" }, "Team":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "organization":{ "title":"Organization", "type":"integer" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name", "organization" ], "type":"object" }, "TeamCredentialSerializerCreate":{ "properties":{ "cloud":{ "readOnly":true, "title":"Cloud", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential_type":{ "description":"Specify the type of credential you want to create. Refer to the documentation for details on each type.", "title":"Credential Type", "type":"integer" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inputs":{ "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", "title":"Inputs", "type":"object" }, "kind":{ "readOnly":true, "title":"Kind", "type":"string" }, "kubernetes":{ "readOnly":true, "title":"Kubernetes", "type":"string" }, "managed":{ "readOnly":true, "title":"Managed", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "team":{ "description":"Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.", "title":"Team", "type":"integer", "x-nullable":true }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name", "credential_type" ], "type":"object" }, "UnifiedJobList":{ "properties":{ "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "controller_node":{ "description":"The instance that managed the execution environment.", "minLength":"1", "readOnly":true, "title":"Controller node", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "execution_node":{ "description":"The node the job executed on.", "minLength":"1", "readOnly":true, "title":"Execution node", "type":"string" }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "UnifiedJobStdout":{ "properties":{ "result_stdout":{ "readOnly":true, "title":"Result stdout", "type":"string" } }, "type":"object" }, "UnifiedJobTemplate":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "last_job_failed":{ "readOnly":true, "title":"Last job failed", "type":"boolean" }, "last_job_run":{ "format":"date-time", "readOnly":true, "title":"Last job run", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "next_job_run":{ "format":"date-time", "readOnly":true, "title":"Next job run", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name" ], "type":"object" }, "User":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "email":{ "maxLength":"254", "title":"Email address", "type":"string", "x-nullable":true }, "external_account":{ "description":"Set if the account is managed by an external service", "readOnly":true, "title":"External account", "type":"string" }, "first_name":{ "maxLength":"150", "title":"First name", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "is_superuser":{ "description":"Designates that this user has all permissions without explicitly assigning them.", "title":"Superuser status", "type":"boolean", "x-nullable":true }, "is_system_auditor":{ "title":"Is system auditor", "type":"boolean" }, "last_login":{ "format":"date-time", "readOnly":true, "title":"Last login", "type":"string", "x-nullable":true }, "last_name":{ "maxLength":"150", "title":"Last name", "type":"string", "x-nullable":true }, "ldap_dn":{ "minLength":"1", "readOnly":true, "title":"Ldap dn", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "password":{ "description":"Field used to change the password.", "minLength":"1", "title":"Password", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "username":{ "description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "maxLength":"150", "minLength":"1", "pattern":"^[\\w.@+-]+$", "title":"Username", "type":"string", "x-nullable":true } }, "required":[ "username" ], "type":"object" }, "UserAuthorizedToken":{ "properties":{ "application":{ "title":"Application", "type":"integer" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "expires":{ "format":"date-time", "readOnly":true, "title":"Expires", "type":"string" }, "id":{ "readOnly":true, "title":"Id", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "refresh_token":{ "readOnly":true, "title":"Refresh token", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scope":{ "default":"write", "description":"Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", "title":"Scope", "type":"string", "x-nullable":true }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "token":{ "readOnly":true, "title":"Token", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "user":{ "description":"The user representing the token owner", "readOnly":true, "title":"User", "type":"integer" } }, "required":[ "application" ], "type":"object" }, "UserCredentialSerializerCreate":{ "properties":{ "cloud":{ "readOnly":true, "title":"Cloud", "type":"string" }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "credential_type":{ "description":"Specify the type of credential you want to create. Refer to the documentation for details on each type.", "title":"Credential Type", "type":"integer" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inputs":{ "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", "title":"Inputs", "type":"object" }, "kind":{ "readOnly":true, "title":"Kind", "type":"string" }, "kubernetes":{ "readOnly":true, "title":"Kubernetes", "type":"string" }, "managed":{ "readOnly":true, "title":"Managed", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "user":{ "description":"Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.", "title":"User", "type":"integer", "x-nullable":true } }, "required":[ "name", "credential_type" ], "type":"object" }, "UserPersonalToken":{ "properties":{ "application":{ "readOnly":true, "title":"Application", "type":"integer", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "expires":{ "format":"date-time", "readOnly":true, "title":"Expires", "type":"string" }, "id":{ "readOnly":true, "title":"Id", "type":"integer" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "refresh_token":{ "readOnly":true, "title":"Refresh token", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scope":{ "default":"write", "description":"Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", "title":"Scope", "type":"string", "x-nullable":true }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "token":{ "readOnly":true, "title":"Token", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "user":{ "description":"The user representing the token owner", "readOnly":true, "title":"User", "type":"integer" } }, "type":"object" }, "WorkflowApproval":{ "properties":{ "approval_expiration":{ "readOnly":true, "title":"Approval expiration", "type":"string" }, "can_approve_or_deny":{ "readOnly":true, "title":"Can approve or deny", "type":"string" }, "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "event_processing_finished":{ "description":"Indicates whether all of the events generated by this unified job have been saved to the database.", "readOnly":true, "title":"Event processing finished", "type":"boolean" }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "job_args":{ "minLength":"1", "readOnly":true, "title":"Job args", "type":"string" }, "job_cwd":{ "minLength":"1", "readOnly":true, "title":"Job cwd", "type":"string" }, "job_env":{ "readOnly":true, "title":"job_env", "type":"object" }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "result_traceback":{ "minLength":"1", "readOnly":true, "title":"Result traceback", "type":"string" }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timed_out":{ "readOnly":true, "title":"Timed out", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "WorkflowApprovalList":{ "properties":{ "approval_expiration":{ "readOnly":true, "title":"Approval expiration", "type":"string" }, "can_approve_or_deny":{ "readOnly":true, "title":"Can approve or deny", "type":"string" }, "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timed_out":{ "readOnly":true, "title":"Timed out", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "WorkflowApprovalTemplate":{ "properties":{ "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "last_job_failed":{ "readOnly":true, "title":"Last job failed", "type":"boolean" }, "last_job_run":{ "format":"date-time", "readOnly":true, "title":"Last job run", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "next_job_run":{ "format":"date-time", "readOnly":true, "title":"Next job run", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "description":"The amount of time (in seconds) before the approval node expires and fails.", "title":"Timeout", "type":"integer" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" } }, "required":[ "name" ], "type":"object" }, "WorkflowApprovalView":{ "properties":{ }, "type":"object" }, "WorkflowJob":{ "properties":{ "allow_simultaneous":{ "title":"Allow simultaneous", "type":"boolean", "x-nullable":true }, "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "extra_vars":{ "title":"Extra vars", "type":"string", "x-nullable":true }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory":{ "description":"Inventory applied as a prompt, assuming job template prompts for inventory", "title":"Inventory", "type":"integer", "x-nullable":true }, "is_sliced_job":{ "title":"Is sliced job", "type":"boolean", "x-nullable":true }, "job_args":{ "minLength":"1", "readOnly":true, "title":"Job args", "type":"string" }, "job_cwd":{ "minLength":"1", "readOnly":true, "title":"Job cwd", "type":"string" }, "job_env":{ "readOnly":true, "title":"job_env", "type":"object" }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "job_tags":{ "title":"Job tags", "type":"string", "x-nullable":true }, "job_template":{ "description":"If automatically created for a sliced job run, the job template the workflow job was created from.", "title":"Job template", "type":"string", "x-nullable":true }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "result_traceback":{ "minLength":"1", "readOnly":true, "title":"Result traceback", "type":"string" }, "scm_branch":{ "title":"Scm branch", "type":"string", "x-nullable":true }, "skip_tags":{ "title":"Skip tags", "type":"string", "x-nullable":true }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "webhook_credential":{ "description":"Personal Access Token for posting back the status to the service API", "title":"Webhook credential", "type":"integer", "x-nullable":true }, "webhook_guid":{ "description":"Unique identifier of the event that triggered this webhook", "maxLength":"128", "title":"Webhook guid", "type":"string", "x-nullable":true }, "webhook_service":{ "description":"Service that webhook requests will be accepted from", "enum":[ "github", "gitlab", "bitbucket_dc" ], "title":"Webhook service", "type":"string", "x-nullable":true }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true }, "workflow_job_template":{ "title":"Workflow job template", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "WorkflowJobCancel":{ "properties":{ "can_cancel":{ "readOnly":true, "title":"Can cancel", "type":"boolean" } }, "type":"object" }, "WorkflowJobLaunch":{ "properties":{ "ask_inventory_on_launch":{ "readOnly":true, "title":"Ask inventory on launch", "type":"boolean", "x-nullable":true }, "ask_labels_on_launch":{ "readOnly":true, "title":"Ask labels on launch", "type":"boolean", "x-nullable":true }, "ask_limit_on_launch":{ "readOnly":true, "title":"Ask limit on launch", "type":"boolean", "x-nullable":true }, "ask_scm_branch_on_launch":{ "readOnly":true, "title":"Ask scm branch on launch", "type":"boolean", "x-nullable":true }, "ask_skip_tags_on_launch":{ "readOnly":true, "title":"Ask skip tags on launch", "type":"boolean", "x-nullable":true }, "ask_tags_on_launch":{ "readOnly":true, "title":"Ask tags on launch", "type":"boolean", "x-nullable":true }, "ask_variables_on_launch":{ "readOnly":true, "title":"Ask variables on launch", "type":"boolean", "x-nullable":true }, "can_start_without_user_input":{ "readOnly":true, "title":"Can start without user input", "type":"boolean" }, "defaults":{ "readOnly":true, "title":"Defaults", "type":"string" }, "extra_vars":{ "title":"Extra vars", "type":"string" }, "inventory":{ "title":"Inventory", "type":"integer" }, "job_tags":{ "title":"Job tags", "type":"string" }, "labels":{ "items":{ "type":"integer" }, "type":"array", "uniqueItems":true }, "limit":{ "title":"Limit", "type":"string" }, "node_prompts_rejected":{ "readOnly":true, "title":"Node prompts rejected", "type":"string" }, "node_templates_missing":{ "readOnly":true, "title":"Node templates missing", "type":"string" }, "scm_branch":{ "title":"Scm branch", "type":"string" }, "skip_tags":{ "title":"Skip tags", "type":"string" }, "survey_enabled":{ "readOnly":true, "title":"Survey enabled", "type":"string" }, "variables_needed_to_start":{ "readOnly":true, "title":"Variables needed to start", "type":"string" }, "workflow_job_template_data":{ "readOnly":true, "title":"Workflow job template data", "type":"string" } }, "type":"object" }, "WorkflowJobList":{ "properties":{ "allow_simultaneous":{ "title":"Allow simultaneous", "type":"boolean", "x-nullable":true }, "canceled_on":{ "description":"The date and time when the cancel request was sent.", "format":"date-time", "readOnly":true, "title":"Canceled on", "type":"string", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "elapsed":{ "description":"Elapsed time in seconds that the job ran.", "format":"decimal", "readOnly":true, "title":"Elapsed", "type":"string" }, "extra_vars":{ "title":"Extra vars", "type":"string", "x-nullable":true }, "failed":{ "readOnly":true, "title":"Failed", "type":"boolean" }, "finished":{ "description":"The date and time the job finished execution.", "format":"date-time", "readOnly":true, "title":"Finished", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory":{ "description":"Inventory applied as a prompt, assuming job template prompts for inventory", "title":"Inventory", "type":"integer", "x-nullable":true }, "is_sliced_job":{ "title":"Is sliced job", "type":"boolean", "x-nullable":true }, "job_explanation":{ "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout", "minLength":"1", "readOnly":true, "title":"Job explanation", "type":"string" }, "job_tags":{ "title":"Job tags", "type":"string", "x-nullable":true }, "job_template":{ "description":"If automatically created for a sliced job run, the job template the workflow job was created from.", "title":"Job template", "type":"string", "x-nullable":true }, "launch_type":{ "enum":[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "readOnly":true, "title":"Launch type", "type":"string" }, "launched_by":{ "readOnly":true, "title":"Launched by", "type":"string" }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "title":"Scm branch", "type":"string", "x-nullable":true }, "skip_tags":{ "title":"Skip tags", "type":"string", "x-nullable":true }, "started":{ "description":"The date and time the job was queued for starting.", "format":"date-time", "readOnly":true, "title":"Started", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "readOnly":true, "title":"unified job template", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "webhook_credential":{ "description":"Personal Access Token for posting back the status to the service API", "title":"Webhook credential", "type":"integer", "x-nullable":true }, "webhook_guid":{ "description":"Unique identifier of the event that triggered this webhook", "maxLength":"128", "title":"Webhook guid", "type":"string", "x-nullable":true }, "webhook_service":{ "description":"Service that webhook requests will be accepted from", "enum":[ "github", "gitlab", "bitbucket_dc" ], "title":"Webhook service", "type":"string", "x-nullable":true }, "work_unit_id":{ "description":"The Receptor work unit ID associated with this job.", "minLength":"1", "readOnly":true, "title":"Work unit id", "type":"string", "x-nullable":true }, "workflow_job_template":{ "title":"Workflow job template", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "WorkflowJobNodeDetail":{ "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", "title":"All parents must converge", "type":"boolean", "x-nullable":true }, "always_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "diff_mode":{ "title":"Diff mode", "type":"boolean", "x-nullable":true }, "do_not_run":{ "description":"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.", "title":"Do not run", "type":"boolean", "x-nullable":true }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "extra_data":{ "title":"Extra data", "type":"object" }, "failure_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "forks":{ "minimum":"0", "title":"Forks", "type":"integer", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "identifier":{ "description":"An identifier coresponding to the workflow job template node that this node was created from.", "maxLength":"512", "title":"Identifier", "type":"string", "x-nullable":true }, "inventory":{ "description":"Inventory applied as a prompt, assuming job template prompts for inventory", "title":"Inventory", "type":"integer", "x-nullable":true }, "job":{ "title":"Job", "type":"integer", "x-nullable":true }, "job_slice_count":{ "minimum":"0", "title":"Job slice count", "type":"integer", "x-nullable":true }, "job_tags":{ "title":"Job tags", "type":"string", "x-nullable":true }, "job_type":{ "enum":[ "run", "check" ], "title":"Job type", "type":"string", "x-nullable":true }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "title":"Scm branch", "type":"string", "x-nullable":true }, "skip_tags":{ "title":"Skip tags", "type":"string", "x-nullable":true }, "success_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "title":"Timeout", "type":"integer", "x-nullable":true }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "title":"Unified job template", "type":"integer", "x-nullable":true }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "verbosity":{ "enum":[ "0", "1", "2", "3", "4", "5" ], "title":"Verbosity", "type":"string", "x-nullable":true }, "workflow_job":{ "title":"Workflow job", "type":"string", "x-nullable":true } }, "type":"object" }, "WorkflowJobNodeList":{ "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", "title":"All parents must converge", "type":"boolean", "x-nullable":true }, "always_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "diff_mode":{ "title":"Diff mode", "type":"boolean", "x-nullable":true }, "do_not_run":{ "description":"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.", "title":"Do not run", "type":"boolean", "x-nullable":true }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "extra_data":{ "title":"Extra data", "type":"object" }, "failure_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "forks":{ "minimum":"0", "title":"Forks", "type":"integer", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "identifier":{ "description":"An identifier coresponding to the workflow job template node that this node was created from.", "maxLength":"512", "title":"Identifier", "type":"string", "x-nullable":true }, "inventory":{ "description":"Inventory applied as a prompt, assuming job template prompts for inventory", "title":"Inventory", "type":"integer", "x-nullable":true }, "job":{ "title":"Job", "type":"integer", "x-nullable":true }, "job_slice_count":{ "minimum":"0", "title":"Job slice count", "type":"integer", "x-nullable":true }, "job_tags":{ "title":"Job tags", "type":"string", "x-nullable":true }, "job_type":{ "enum":[ "run", "check" ], "title":"Job type", "type":"string", "x-nullable":true }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "title":"Scm branch", "type":"string", "x-nullable":true }, "skip_tags":{ "title":"Skip tags", "type":"string", "x-nullable":true }, "success_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "title":"Timeout", "type":"integer", "x-nullable":true }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "title":"Unified job template", "type":"integer", "x-nullable":true }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "verbosity":{ "enum":[ "0", "1", "2", "3", "4", "5" ], "title":"Verbosity", "type":"string", "x-nullable":true }, "workflow_job":{ "title":"Workflow job", "type":"string", "x-nullable":true } }, "type":"object" }, "WorkflowJobTemplate":{ "properties":{ "allow_simultaneous":{ "title":"Allow simultaneous", "type":"boolean", "x-nullable":true }, "ask_inventory_on_launch":{ "title":"Ask inventory on launch", "type":"boolean", "x-nullable":true }, "ask_labels_on_launch":{ "title":"Ask labels on launch", "type":"boolean", "x-nullable":true }, "ask_limit_on_launch":{ "title":"Ask limit on launch", "type":"boolean", "x-nullable":true }, "ask_scm_branch_on_launch":{ "title":"Ask scm branch on launch", "type":"boolean", "x-nullable":true }, "ask_skip_tags_on_launch":{ "title":"Ask skip tags on launch", "type":"boolean", "x-nullable":true }, "ask_tags_on_launch":{ "title":"Ask tags on launch", "type":"boolean", "x-nullable":true }, "ask_variables_on_launch":{ "title":"Ask variables on launch", "type":"boolean", "x-nullable":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "description":{ "title":"Description", "type":"string", "x-nullable":true }, "extra_vars":{ "title":"Extra vars", "type":"string", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "inventory":{ "description":"Inventory applied as a prompt, assuming job template prompts for inventory", "title":"Inventory", "type":"integer", "x-nullable":true }, "job_tags":{ "title":"Job tags", "type":"string", "x-nullable":true }, "last_job_failed":{ "readOnly":true, "title":"Last job failed", "type":"boolean" }, "last_job_run":{ "format":"date-time", "readOnly":true, "title":"Last job run", "type":"string", "x-nullable":true }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "next_job_run":{ "format":"date-time", "readOnly":true, "title":"Next job run", "type":"string", "x-nullable":true }, "organization":{ "description":"The organization used to determine access to this template.", "title":"Organization", "type":"integer", "x-nullable":true }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "title":"Scm branch", "type":"string", "x-nullable":true }, "skip_tags":{ "title":"Skip tags", "type":"string", "x-nullable":true }, "status":{ "enum":[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ], "readOnly":true, "title":"Status", "type":"string" }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "survey_enabled":{ "title":"Survey enabled", "type":"boolean", "x-nullable":true }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "webhook_credential":{ "description":"Personal Access Token for posting back the status to the service API", "title":"Webhook credential", "type":"integer", "x-nullable":true }, "webhook_service":{ "description":"Service that webhook requests will be accepted from", "enum":[ "github", "gitlab", "bitbucket_dc" ], "title":"Webhook service", "type":"string", "x-nullable":true } }, "required":[ "name" ], "type":"object" }, "WorkflowJobTemplateNode":{ "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", "title":"All parents must converge", "type":"boolean", "x-nullable":true }, "always_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "diff_mode":{ "title":"Diff mode", "type":"boolean", "x-nullable":true }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "extra_data":{ "title":"Extra data", "type":"object" }, "failure_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "forks":{ "minimum":"0", "title":"Forks", "type":"integer", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "identifier":{ "default":"00000000-0000-0000-0000-000000000000", "description":"An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", "maxLength":"512", "minLength":"1", "title":"Identifier", "type":"string", "x-nullable":true }, "inventory":{ "description":"Inventory applied as a prompt, assuming job template prompts for inventory", "title":"Inventory", "type":"integer", "x-nullable":true }, "job_slice_count":{ "minimum":"0", "title":"Job slice count", "type":"integer", "x-nullable":true }, "job_tags":{ "title":"Job tags", "type":"string", "x-nullable":true }, "job_type":{ "enum":[ "run", "check" ], "title":"Job type", "type":"string", "x-nullable":true }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "title":"Scm branch", "type":"string", "x-nullable":true }, "skip_tags":{ "title":"Skip tags", "type":"string", "x-nullable":true }, "success_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "title":"Timeout", "type":"integer", "x-nullable":true }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "title":"Unified job template", "type":"integer", "x-nullable":true }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "verbosity":{ "enum":[ "0", "1", "2", "3", "4", "5" ], "title":"Verbosity", "type":"string", "x-nullable":true }, "workflow_job_template":{ "title":"Workflow job template", "type":"string" } }, "required":[ "workflow_job_template" ], "type":"object" }, "WorkflowJobTemplateNodeCreateApproval":{ "properties":{ "description":{ "title":"Description", "type":"string", "x-nullable":true }, "name":{ "maxLength":"512", "minLength":"1", "title":"Name", "type":"string", "x-nullable":true }, "timeout":{ "description":"The amount of time (in seconds) before the approval node expires and fails.", "title":"Timeout", "type":"integer" } }, "required":[ "name" ], "type":"object" }, "WorkflowJobTemplateNodeDetail":{ "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", "title":"All parents must converge", "type":"boolean", "x-nullable":true }, "always_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "created":{ "readOnly":true, "title":"Created", "type":"string" }, "diff_mode":{ "title":"Diff mode", "type":"boolean", "x-nullable":true }, "execution_environment":{ "description":"The container image to be used for execution.", "title":"Execution environment", "type":"integer", "x-nullable":true }, "extra_data":{ "title":"Extra data", "type":"object" }, "failure_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "forks":{ "minimum":"0", "title":"Forks", "type":"integer", "x-nullable":true }, "id":{ "readOnly":true, "title":"ID", "type":"integer" }, "identifier":{ "default":"00000000-0000-0000-0000-000000000000", "description":"An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", "maxLength":"512", "minLength":"1", "title":"Identifier", "type":"string", "x-nullable":true }, "inventory":{ "description":"Inventory applied as a prompt, assuming job template prompts for inventory", "title":"Inventory", "type":"integer", "x-nullable":true }, "job_slice_count":{ "minimum":"0", "title":"Job slice count", "type":"integer", "x-nullable":true }, "job_tags":{ "title":"Job tags", "type":"string", "x-nullable":true }, "job_type":{ "enum":[ "run", "check" ], "title":"Job type", "type":"string", "x-nullable":true }, "limit":{ "title":"Limit", "type":"string", "x-nullable":true }, "modified":{ "readOnly":true, "title":"Modified", "type":"string" }, "related":{ "readOnly":true, "title":"Related", "type":"string" }, "scm_branch":{ "title":"Scm branch", "type":"string", "x-nullable":true }, "skip_tags":{ "title":"Skip tags", "type":"string", "x-nullable":true }, "success_nodes":{ "items":{ "type":"integer" }, "readOnly":true, "type":"array", "uniqueItems":true }, "summary_fields":{ "readOnly":true, "title":"Summary fields", "type":"string" }, "timeout":{ "title":"Timeout", "type":"integer", "x-nullable":true }, "type":{ "readOnly":true, "title":"Type", "type":"string" }, "unified_job_template":{ "title":"Unified job template", "type":"integer", "x-nullable":true }, "url":{ "readOnly":true, "title":"Url", "type":"string" }, "verbosity":{ "enum":[ "0", "1", "2", "3", "4", "5" ], "title":"Verbosity", "type":"string", "x-nullable":true }, "workflow_job_template":{ "title":"Workflow job template", "type":"string" } }, "required":[ "workflow_job_template" ], "type":"object" } }, "info":{ "contact":{ "email":"contact@snippets.local" }, "description":"This document describes the Oracle Linux Automation Manager Command Line Interface and REST API.", "license":{ "name":"BSD License" }, "termsOfService":"https://www.google.com/policies/terms/", "title":"Oracle Linux Automation Manager CLI and API Reference Guide", "version":"2024.11.06", "x-summary":"This document describes the Oracle Linux Automation Manager Command Line Interface and REST API." }, "paths":{ "/api/":{ "get":{ "description":"

List supported API versions

", "operationId":"api_list", "parameters":[ ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "available_versions":{ "v2":"/api/v2/" }, "current_version":"/api/v2/", "custom_login_info":"", "custom_logo":"", "description":"Oracle Linux Automation Manager REST API", "login_redirect_override":"", "oauth2":"/api/o/", "swagger":"/api/swagger/" } } } }, "tags":[ "API" ], "summary":"List", "x-internal-id":"api--get", "x-filename-id":"api-get" }, "parameters":[ ] }, "/api/debug/":{ "get":{ "description":"

List of available debug urls

", "operationId":"api_debug_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "API" ], "summary":"Debug List", "x-internal-id":"api-debug--get", "x-filename-id":"api-debug-get" }, "parameters":[ ] }, "/api/debug/dependency_manager/":{ "get":{ "description":"", "operationId":"api_debug_dependency_manager_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Dependency Manager" ], "summary":"Debug Dependency Manager List", "x-internal-id":"api-debug-dependency_manager--get", "x-filename-id":"api-debug-dependency_manager-get" }, "parameters":[ ] }, "/api/debug/task_manager/":{ "get":{ "description":"", "operationId":"api_debug_task_manager_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Task Manager" ], "summary":"Debug Task Manager List", "x-internal-id":"api-debug-task_manager--get", "x-filename-id":"api-debug-task_manager-get" }, "parameters":[ ] }, "/api/debug/workflow_manager/":{ "get":{ "description":"", "operationId":"api_debug_workflow_manager_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Workflow Manager" ], "summary":"Debug Workflow Manager List", "x-internal-id":"api-debug-workflow_manager--get", "x-filename-id":"api-debug-workflow_manager-get" }, "parameters":[ ] }, "/api/o/":{ "get":{ "description":"

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:

\n

Create Token for an Application using Authorization code grant type

\n

Given an application \"AuthCodeApp\" of grant type authorization-code, \nfrom the client app, the user makes a GET to the Authorize endpoint with

\n
    \n
  • response_type
    • \n
  • client_id
    • \n
  • redirect_uris
    • \n
  • scope
    • \n
\n

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

\n
    \n
  • code
    • \n
  • client_id
    • \n
  • client_secret
    • \n
  • grant_type
    • \n
  • redirect_uri
    • \n
\n

AWX 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.

\n

Create Token for an Application using Password grant type

\n

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

\n
    \n
  • grant_type: Required to be \"password\"
    • \n
  • username
    • \n
  • password
    • \n
  • client_id: Associated application must have grant_type \"password\"
    • \n
  • client_secret
    • \n
\n

For example:

\n
curl -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\n
\n

In 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.

\n

Upon success, access token, refresh token and other information are given in the response body in JSON

", "operationId":"api_o_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "summary":"Token Handling Using OAuth2", "tags":[ "API" ], "x-internal-id":"api-o--get", "x-filename-id":"api-o-get" }, "parameters":[ ] }, "/api/v2/":{ "get":{ "description":"

List top level resources

", "operationId":"api_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/", "analytics":"/api/v2/analytics/", "applications":"/api/v2/applications/", "bulk":"/api/v2/bulk/", "config":"/api/v2/config/", "constructed_inventory":"/api/v2/constructed_inventories/", "credential_input_sources":"/api/v2/credential_input_sources/", "credential_types":"/api/v2/credential_types/", "credentials":"/api/v2/credentials/", "dashboard":"/api/v2/dashboard/", "execution_environments":"/api/v2/execution_environments/", "groups":"/api/v2/groups/", "host_metric_summary_monthly":"/api/v2/host_metric_summary_monthly/", "host_metrics":"/api/v2/host_metrics/", "hosts":"/api/v2/hosts/", "instance_groups":"/api/v2/instance_groups/", "instances":"/api/v2/instances/", "inventory":"/api/v2/inventories/", "inventory_sources":"/api/v2/inventory_sources/", "inventory_updates":"/api/v2/inventory_updates/", "job_templates":"/api/v2/job_templates/", "jobs":"/api/v2/jobs/", "labels":"/api/v2/labels/", "me":"/api/v2/me/", "mesh_visualizer":"/api/v2/mesh_visualizer/", "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/" } } } }, "tags":[ "API" ], "summary":"Read", "x-internal-id":"api-v2--get", "x-filename-id":"api-v2-get" }, "parameters":[ ] }, "/api/v2/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nactivity streams.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams", "tags":[ "Activity Stream" ], "x-internal-id":"api-v2-activity_stream--get", "x-filename-id":"api-v2-activity_stream-get" }, "parameters":[ ] }, "/api/v2/activity_stream/{id}/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single activity stream\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
", "operationId":"api_activity_stream_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/ActivityStream" } } }, "summary":"Retrieve an Activity Stream", "tags":[ "Activity Stream" ], "x-internal-id":"api-v2-activity_stream-{id}--get", "x-filename-id":"api-v2-activity_stream-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/ad_hoc_command_events/{id}/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single ad hoc command event\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this ad hoc command event. (integer)
    • \n
  • type: Data type for this ad hoc command event. (choice)
    • \n
  • url: URL for this ad hoc command event. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this ad hoc command event was created. (datetime)
    • \n
  • modified: Timestamp when this ad hoc command event was last modified. (datetime)
    • \n
  • ad_hoc_command: (id)
    • \n
  • event: (choice)
      \n
    • runner_on_failed: Host Failed
      • \n
    • runner_on_ok: Host OK
      • \n
    • runner_on_unreachable: Host Unreachable
      • \n
    • runner_on_skipped: Host Skipped
      • \n
    • debug: Debug
      • \n
    • verbose: Verbose
      • \n
    • deprecated: Deprecated
      • \n
    • warning: Warning
      • \n
    • system_warning: System Warning
      • \n
    • error: Error
      • \n
    \n
    • \n
  • counter: (integer)
    • \n
  • event_display: (string)
    • \n
  • event_data: (json)
    • \n
  • failed: (boolean)
    • \n
  • changed: (boolean)
    • \n
  • uuid: (string)
    • \n
  • host: (id)
    • \n
  • host_name: (string)
    • \n
  • stdout: (string)
    • \n
  • start_line: (integer)
    • \n
  • end_line: (integer)
    • \n
  • verbosity: (integer)
    • \n
", "operationId":"api_ad_hoc_command_events_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/AdHocCommandEvent" } } }, "summary":"Retrieve an Ad Hoc Command Event", "tags":[ "Ad Hoc Command Events" ], "x-internal-id":"api-v2-ad_hoc_command_events-{id}--get", "x-filename-id":"api-v2-ad_hoc_command_events-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/ad_hoc_commands/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nad hoc commands.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each ad hoc command data structure includes the following fields:

\n
    \n
  • id: Database ID for this ad hoc command. (integer)
    • \n
  • type: Data type for this ad hoc command. (choice)
    • \n
  • url: URL for this ad hoc command. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this ad hoc command was created. (datetime)
    • \n
  • modified: Timestamp when this ad hoc command was last modified. (datetime)
    • \n
  • name: Name of this ad hoc command. (string)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id)
    • \n
  • limit: (string)
    • \n
  • credential: (id)
    • \n
  • module_name: (choice)
      \n
    • command
      • \n
    • shell
      • \n
    • yum
      • \n
    • apt
      • \n
    • apt_key
      • \n
    • apt_repository
      • \n
    • apt_rpm
      • \n
    • service
      • \n
    • group
      • \n
    • user
      • \n
    • mount
      • \n
    • ping
      • \n
    • selinux
      • \n
    • setup
      • \n
    • win_ping
      • \n
    • win_service
      • \n
    • win_updates
      • \n
    • win_group
      • \n
    • win_user
      • \n
    \n
    • \n
  • module_args: (string)
    • \n
  • forks: (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (string)
    • \n
  • become_enabled: (boolean)
    • \n
  • diff_mode: (boolean)
    • \n
\n

Sorting

\n

To specify that ad hoc commands are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_ad_hoc_commands_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/AdHocCommandList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Ad Hoc Commands", "tags":[ "Ad Hoc Commands" ], "x-internal-id":"api-v2-ad_hoc_commands--get", "x-filename-id":"api-v2-ad_hoc_commands-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following ad hoc command\nfields to create a new ad hoc command:

\n
    \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • \n

    job_type: (choice)

    \n
      \n
    • run: Run (default)
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id, default=``)
    • \n
  • limit: (string, default=\"\")
    • \n
  • credential: (id, default=``)
    • \n
  • module_name: (choice)
      \n
    • command (default)
      • \n
    • shell
      • \n
    • yum
      • \n
    • apt
      • \n
    • apt_key
      • \n
    • apt_repository
      • \n
    • apt_rpm
      • \n
    • service
      • \n
    • group
      • \n
    • user
      • \n
    • mount
      • \n
    • ping
      • \n
    • selinux
      • \n
    • setup
      • \n
    • win_ping
      • \n
    • win_service
      • \n
    • win_updates
      • \n
    • win_group
      • \n
    • win_user
      • \n
    \n
    • \n
  • module_args: (string, default=\"\")
    • \n
  • forks: (integer, default=0)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal) (default)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (string, default=\"\")
    • \n
  • become_enabled: (boolean, default=False)
    • \n
  • diff_mode: (boolean, default=False)
    • \n
", "operationId":"api_ad_hoc_commands_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/AdHocCommandList" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/AdHocCommandList" } } }, "summary":"Create an Ad Hoc Command", "tags":[ "Ad Hoc Commands" ], "x-internal-id":"api-v2-ad_hoc_commands--post", "x-filename-id":"api-v2-ad_hoc_commands-post" } }, "/api/v2/ad_hoc_commands/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this ad hoc command.

", "operationId":"api_ad_hoc_commands_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this ad hoc command. (integer)
    • \n
  • type: Data type for this ad hoc command. (choice)
    • \n
  • url: URL for this ad hoc command. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this ad hoc command was created. (datetime)
    • \n
  • modified: Timestamp when this ad hoc command was last modified. (datetime)
    • \n
  • name: Name of this ad hoc command. (string)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_args: (string)
    • \n
  • job_cwd: (string)
    • \n
  • job_env: (json)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • result_traceback: (string)
    • \n
  • event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id)
    • \n
  • limit: (string)
    • \n
  • credential: (id)
    • \n
  • module_name: (choice)
      \n
    • command
      • \n
    • shell
      • \n
    • yum
      • \n
    • apt
      • \n
    • apt_key
      • \n
    • apt_repository
      • \n
    • apt_rpm
      • \n
    • service
      • \n
    • group
      • \n
    • user
      • \n
    • mount
      • \n
    • ping
      • \n
    • selinux
      • \n
    • setup
      • \n
    • win_ping
      • \n
    • win_service
      • \n
    • win_updates
      • \n
    • win_group
      • \n
    • win_user
      • \n
    \n
    • \n
  • module_args: (string)
    • \n
  • forks: (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (string)
    • \n
  • become_enabled: (boolean)
    • \n
  • diff_mode: (boolean)
    • \n
  • host_status_counts: Playbook stats from the Ansible playbook_on_stats event. (json)
    • \n
", "operationId":"api_ad_hoc_commands_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/AdHocCommandDetail" } } }, "summary":"Retrieve an Ad Hoc Command", "tags":[ "Ad Hoc Commands" ], "x-internal-id":"api-v2-ad_hoc_commands-{id}--get", "x-filename-id":"api-v2-ad_hoc_commands-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/ad_hoc_commands/{id}/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nad hoc command.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_ad_hoc_commands_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for an Ad Hoc Command", "tags":[ "Ad Hoc Commands" ], "x-internal-id":"api-v2-ad_hoc_commands-{id}-activity_stream--get", "x-filename-id":"api-v2-ad_hoc_commands-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/ad_hoc_commands/{id}/cancel/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:

\n
    \n
  • can_cancel: (boolean)
    • \n
", "operationId":"api_ad_hoc_commands_cancel_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/AdHocCommandCancel" } } }, "summary":"Retrieve an Ad Hoc Command", "tags":[ "Ad Hoc Commands" ], "x-internal-id":"api-v2-ad_hoc_commands-{id}-cancel--get", "x-filename-id":"api-v2-ad_hoc_commands-id-cancel-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:

\n
    \n
  • can_cancel: (boolean)
    • \n
", "operationId":"api_ad_hoc_commands_cancel_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/AdHocCommandCancel" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/AdHocCommandCancel" } } }, "summary":"Retrieve an Ad Hoc Command", "tags":[ "Ad Hoc Commands" ], "x-internal-id":"api-v2-ad_hoc_commands-{id}-cancel--post", "x-filename-id":"api-v2-ad_hoc_commands-id-cancel-post" } }, "/api/v2/ad_hoc_commands/{id}/events/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nad hoc command events associated with the selected\nad hoc command.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each ad hoc command event data structure includes the following fields:

\n
    \n
  • id: Database ID for this ad hoc command event. (integer)
    • \n
  • type: Data type for this ad hoc command event. (choice)
    • \n
  • url: URL for this ad hoc command event. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this ad hoc command event was created. (datetime)
    • \n
  • modified: Timestamp when this ad hoc command event was last modified. (datetime)
    • \n
  • ad_hoc_command: (id)
    • \n
  • event: (choice)
      \n
    • runner_on_failed: Host Failed
      • \n
    • runner_on_ok: Host OK
      • \n
    • runner_on_unreachable: Host Unreachable
      • \n
    • runner_on_skipped: Host Skipped
      • \n
    • debug: Debug
      • \n
    • verbose: Verbose
      • \n
    • deprecated: Deprecated
      • \n
    • warning: Warning
      • \n
    • system_warning: System Warning
      • \n
    • error: Error
      • \n
    \n
    • \n
  • counter: (integer)
    • \n
  • event_display: (string)
    • \n
  • event_data: (json)
    • \n
  • failed: (boolean)
    • \n
  • changed: (boolean)
    • \n
  • uuid: (string)
    • \n
  • host: (id)
    • \n
  • host_name: (string)
    • \n
  • stdout: (string)
    • \n
  • start_line: (integer)
    • \n
  • end_line: (integer)
    • \n
  • verbosity: (integer)
    • \n
\n

Sorting

\n

To specify that ad hoc command events are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_ad_hoc_commands_events_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/AdHocCommandEvent" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Ad Hoc Command Events for an Ad Hoc Command", "tags":[ "Ad Hoc Commands" ], "x-internal-id":"api-v2-ad_hoc_commands-{id}-events--get", "x-filename-id":"api-v2-ad_hoc_commands-id-events-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/ad_hoc_commands/{id}/notifications/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nad hoc command.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification. (integer)
    • \n
  • type: Data type for this notification. (choice)
    • \n
  • url: URL for this notification. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification was created. (datetime)
    • \n
  • modified: Timestamp when this notification was last modified. (datetime)
    • \n
  • notification_template: (id)
    • \n
  • error: (string)
    • \n
  • status: (choice)
      \n
    • pending: Pending
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    \n
    • \n
  • notifications_sent: (integer)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • recipients: (string)
    • \n
  • subject: (string)
    • \n
  • body: Notification body (json)
    • \n
\n

Sorting

\n

To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_ad_hoc_commands_notifications_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Notification" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notifications for an Ad Hoc Command", "tags":[ "Ad Hoc Commands" ], "x-internal-id":"api-v2-ad_hoc_commands-{id}-notifications--get", "x-filename-id":"api-v2-ad_hoc_commands-id-notifications-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/ad_hoc_commands/{id}/relaunch/":{ "get":{ "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":"api_ad_hoc_commands_relaunch_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/AdHocCommandRelaunch" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "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":"api_ad_hoc_commands_relaunch_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/AdHocCommandRelaunch" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/AdHocCommandRelaunch" } } }, "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.

\n

Format

\n

Use the format query string parameter to specify the output format.

\n
    \n
  • Browsable API: ?format=api
    • \n
  • HTML: ?format=html
    • \n
  • Plain Text: ?format=txt
    • \n
  • Plain Text with ANSI color codes: ?format=ansi
    • \n
  • JSON structure: ?format=json
    • \n
  • Downloaded Plain Text: ?format=txt_download
    • \n
  • Downloaded Plain Text with ANSI color codes: ?format=ansi_download
    • \n
\n

(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.

\n

Use dark=1 or dark=0 as a query string parameter to force or disable a\ndark background.

\n

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.

", "operationId":"api_ad_hoc_commands_stdout_read", "parameters":[ ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/UnifiedJobStdout" } } }, "summary":"Retrieve Ad Hoc Command Stdout", "tags":[ "Ad Hoc Commands" ], "x-internal-id":"api-v2-ad_hoc_commands-{id}-stdout--get", "x-filename-id":"api-v2-ad_hoc_commands-id-stdout-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/analytics/":{ "get":{ "description":"", "operationId":"api_analytics_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics List", "x-internal-id":"api-v2-analytics--get", "x-filename-id":"api-v2-analytics-get" }, "parameters":[ ] }, "/api/v2/analytics/adoption_rate/":{ "get":{ "description":"", "operationId":"api_analytics_adoption_rate_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Adoption Rate List", "x-internal-id":"api-v2-analytics-adoption_rate--get", "x-filename-id":"api-v2-analytics-adoption_rate-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_adoption_rate_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Adoption Rate Create", "x-internal-id":"api-v2-analytics-adoption_rate--post", "x-filename-id":"api-v2-analytics-adoption_rate-post" } }, "/api/v2/analytics/adoption_rate_options/":{ "get":{ "description":"", "operationId":"api_analytics_adoption_rate_options_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Adoption Rate Options List", "x-internal-id":"api-v2-analytics-adoption_rate_options--get", "x-filename-id":"api-v2-analytics-adoption_rate_options-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_adoption_rate_options_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Adoption Rate Options Create", "x-internal-id":"api-v2-analytics-adoption_rate_options--post", "x-filename-id":"api-v2-analytics-adoption_rate_options-post" } }, "/api/v2/analytics/authorized/":{ "get":{ "description":"", "operationId":"api_analytics_authorized_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Authorized List", "x-internal-id":"api-v2-analytics-authorized--get", "x-filename-id":"api-v2-analytics-authorized-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_authorized_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Authorized Create", "x-internal-id":"api-v2-analytics-authorized--post", "x-filename-id":"api-v2-analytics-authorized-post" } }, "/api/v2/analytics/event_explorer/":{ "get":{ "description":"", "operationId":"api_analytics_event_explorer_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Event Explorer List", "x-internal-id":"api-v2-analytics-event_explorer--get", "x-filename-id":"api-v2-analytics-event_explorer-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_event_explorer_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Event Explorer Create", "x-internal-id":"api-v2-analytics-event_explorer--post", "x-filename-id":"api-v2-analytics-event_explorer-post" } }, "/api/v2/analytics/event_explorer_options/":{ "get":{ "description":"", "operationId":"api_analytics_event_explorer_options_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Event Explorer Options List", "x-internal-id":"api-v2-analytics-event_explorer_options--get", "x-filename-id":"api-v2-analytics-event_explorer_options-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_event_explorer_options_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Event Explorer Options Create", "x-internal-id":"api-v2-analytics-event_explorer_options--post", "x-filename-id":"api-v2-analytics-event_explorer_options-post" } }, "/api/v2/analytics/host_explorer/":{ "get":{ "description":"", "operationId":"api_analytics_host_explorer_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Host Explorer List", "x-internal-id":"api-v2-analytics-host_explorer--get", "x-filename-id":"api-v2-analytics-host_explorer-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_host_explorer_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Host Explorer Create", "x-internal-id":"api-v2-analytics-host_explorer--post", "x-filename-id":"api-v2-analytics-host_explorer-post" } }, "/api/v2/analytics/host_explorer_options/":{ "get":{ "description":"", "operationId":"api_analytics_host_explorer_options_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Host Explorer Options List", "x-internal-id":"api-v2-analytics-host_explorer_options--get", "x-filename-id":"api-v2-analytics-host_explorer_options-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_host_explorer_options_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Host Explorer Options Create", "x-internal-id":"api-v2-analytics-host_explorer_options--post", "x-filename-id":"api-v2-analytics-host_explorer_options-post" } }, "/api/v2/analytics/job_explorer/":{ "get":{ "description":"", "operationId":"api_analytics_job_explorer_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Job Explorer List", "x-internal-id":"api-v2-analytics-job_explorer--get", "x-filename-id":"api-v2-analytics-job_explorer-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_job_explorer_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Job Explorer Create", "x-internal-id":"api-v2-analytics-job_explorer--post", "x-filename-id":"api-v2-analytics-job_explorer-post" } }, "/api/v2/analytics/job_explorer_options/":{ "get":{ "description":"", "operationId":"api_analytics_job_explorer_options_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Job Explorer Options List", "x-internal-id":"api-v2-analytics-job_explorer_options--get", "x-filename-id":"api-v2-analytics-job_explorer_options-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_job_explorer_options_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Job Explorer Options Create", "x-internal-id":"api-v2-analytics-job_explorer_options--post", "x-filename-id":"api-v2-analytics-job_explorer_options-post" } }, "/api/v2/analytics/probe_template_for_hosts/":{ "get":{ "description":"", "operationId":"api_analytics_probe_template_for_hosts_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Probe Template for Hosts List", "x-internal-id":"api-v2-analytics-probe_template_for_hosts--get", "x-filename-id":"api-v2-analytics-probe_template_for_hosts-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_probe_template_for_hosts_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Probe Template for Hosts Create", "x-internal-id":"api-v2-analytics-probe_template_for_hosts--post", "x-filename-id":"api-v2-analytics-probe_template_for_hosts-post" } }, "/api/v2/analytics/probe_template_for_hosts_options/":{ "get":{ "description":"", "operationId":"api_analytics_probe_template_for_hosts_options_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Probe Template for Hosts Options List", "x-internal-id":"api-v2-analytics-probe_template_for_hosts_options--get", "x-filename-id":"api-v2-analytics-probe_template_for_hosts_options-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_probe_template_for_hosts_options_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Probe Template for Hosts Options Create", "x-internal-id":"api-v2-analytics-probe_template_for_hosts_options--post", "x-filename-id":"api-v2-analytics-probe_template_for_hosts_options-post" } }, "/api/v2/analytics/probe_templates/":{ "get":{ "description":"", "operationId":"api_analytics_probe_templates_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Probe Templates List", "x-internal-id":"api-v2-analytics-probe_templates--get", "x-filename-id":"api-v2-analytics-probe_templates-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_probe_templates_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Probe Templates Create", "x-internal-id":"api-v2-analytics-probe_templates--post", "x-filename-id":"api-v2-analytics-probe_templates-post" } }, "/api/v2/analytics/probe_templates_options/":{ "get":{ "description":"", "operationId":"api_analytics_probe_templates_options_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Probe Templates Options List", "x-internal-id":"api-v2-analytics-probe_templates_options--get", "x-filename-id":"api-v2-analytics-probe_templates_options-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_probe_templates_options_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Probe Templates Options Create", "x-internal-id":"api-v2-analytics-probe_templates_options--post", "x-filename-id":"api-v2-analytics-probe_templates_options-post" } }, "/api/v2/analytics/report/{slug}/":{ "get":{ "description":"", "operationId":"api_analytics_report_read", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Report Read", "x-internal-id":"api-v2-analytics-report-{slug}--get", "x-filename-id":"api-v2-analytics-report-slug-get" }, "parameters":[ { "in":"path", "name":"slug", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_analytics_report_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Report Create", "x-internal-id":"api-v2-analytics-report-{slug}--post", "x-filename-id":"api-v2-analytics-report-slug-post" } }, "/api/v2/analytics/report_options/":{ "get":{ "description":"", "operationId":"api_analytics_report_options_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Report Options List", "x-internal-id":"api-v2-analytics-report_options--get", "x-filename-id":"api-v2-analytics-report_options-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_report_options_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Report Options Create", "x-internal-id":"api-v2-analytics-report_options--post", "x-filename-id":"api-v2-analytics-report_options-post" } }, "/api/v2/analytics/reports/":{ "get":{ "description":"", "operationId":"api_analytics_reports_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Reports List", "x-internal-id":"api-v2-analytics-reports--get", "x-filename-id":"api-v2-analytics-reports-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_reports_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Reports Create", "x-internal-id":"api-v2-analytics-reports--post", "x-filename-id":"api-v2-analytics-reports-post" } }, "/api/v2/analytics/roi_templates/":{ "get":{ "description":"", "operationId":"api_analytics_roi_templates_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Roi Templates List", "x-internal-id":"api-v2-analytics-roi_templates--get", "x-filename-id":"api-v2-analytics-roi_templates-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_roi_templates_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Roi Templates Create", "x-internal-id":"api-v2-analytics-roi_templates--post", "x-filename-id":"api-v2-analytics-roi_templates-post" } }, "/api/v2/analytics/roi_templates_options/":{ "get":{ "description":"", "operationId":"api_analytics_roi_templates_options_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Roi Templates Options List", "x-internal-id":"api-v2-analytics-roi_templates_options--get", "x-filename-id":"api-v2-analytics-roi_templates_options-get" }, "parameters":[ ], "post":{ "description":"", "operationId":"api_analytics_roi_templates_options_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Analytics" ], "summary":"Analytics Roi Templates Options Create", "x-internal-id":"api-v2-analytics-roi_templates_options--post", "x-filename-id":"api-v2-analytics-roi_templates_options-post" } }, "/api/v2/applications/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\napplications.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each application data structure includes the following fields:

\n
    \n
  • id: Database ID for this application. (integer)
    • \n
  • type: Data type for this application. (choice)
    • \n
  • url: URL for this application. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this application was created. (datetime)
    • \n
  • modified: Timestamp when this application was last modified. (datetime)
    • \n
  • name: Name of this application. (string)
    • \n
  • description: Optional description of this application. (string)
    • \n
  • client_id: (string)
    • \n
  • client_secret: Used for more stringent verification of access to an application when creating a token. (string)
    • \n
  • client_type: Set to Public or Confidential depending on how secure the client device is. (choice)
      \n
    • confidential: Confidential
      • \n
    • public: Public
      • \n
    \n
    • \n
  • redirect_uris: Allowed URIs list, space separated (string)
    • \n
  • authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice)
      \n
    • authorization-code: Authorization code
      • \n
    • password: Resource owner password-based
      • \n
    \n
    • \n
  • skip_authorization: Set True to skip authorization step for completely trusted applications. (boolean)
    • \n
  • organization: Organization containing this application. (id)
    • \n
\n

Sorting

\n

To specify that applications are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_applications_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/OAuth2Application" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Applications", "tags":[ "Applications" ], "x-internal-id":"api-v2-applications--get", "x-filename-id":"api-v2-applications-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following application\nfields to create a new application:

\n
    \n
  • name: Name of this application. (string, required)
    • \n
  • \n

    description: Optional description of this application. (string, default=\"\")

    \n
    • \n
  • \n

    client_type: Set to Public or Confidential depending on how secure the client device is. (choice, required)

    \n
      \n
    • confidential: Confidential
      • \n
    • public: Public
      • \n
    \n
    • \n
  • redirect_uris: Allowed URIs list, space separated (string, default=\"\")
    • \n
  • authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice, required)
      \n
    • authorization-code: Authorization code
      • \n
    • password: Resource owner password-based
      • \n
    \n
    • \n
  • skip_authorization: Set True to skip authorization step for completely trusted applications. (boolean, default=False)
    • \n
  • organization: Organization containing this application. (id, required)
    • \n
", "operationId":"api_applications_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/OAuth2Application" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/OAuth2Application" } } }, "summary":"Create an Application", "tags":[ "Applications" ], "x-internal-id":"api-v2-applications--post", "x-filename-id":"api-v2-applications-post" } }, "/api/v2/applications/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this application.

", "operationId":"api_applications_delete", "parameters":[ ], "responses":{ "204":{ "description":"" } }, "summary":"Delete an Application", "tags":[ "Applications" ], "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:

\n
    \n
  • id: Database ID for this application. (integer)
    • \n
  • type: Data type for this application. (choice)
    • \n
  • url: URL for this application. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this application was created. (datetime)
    • \n
  • modified: Timestamp when this application was last modified. (datetime)
    • \n
  • name: Name of this application. (string)
    • \n
  • description: Optional description of this application. (string)
    • \n
  • client_id: (string)
    • \n
  • client_secret: Used for more stringent verification of access to an application when creating a token. (string)
    • \n
  • client_type: Set to Public or Confidential depending on how secure the client device is. (choice)
      \n
    • confidential: Confidential
      • \n
    • public: Public
      • \n
    \n
    • \n
  • redirect_uris: Allowed URIs list, space separated (string)
    • \n
  • authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice)
      \n
    • authorization-code: Authorization code
      • \n
    • password: Resource owner password-based
      • \n
    \n
    • \n
  • skip_authorization: Set True to skip authorization step for completely trusted applications. (boolean)
    • \n
  • organization: Organization containing this application. (id)
    • \n
", "operationId":"api_applications_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/OAuth2Application" } } }, "summary":"Retrieve an Application", "tags":[ "Applications" ], "x-internal-id":"api-v2-applications-{id}--get", "x-filename-id":"api-v2-applications-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\napplication. The following fields may be modified:

\n
    \n
  • name: Name of this application. (string, required)
    • \n
  • \n

    description: Optional description of this application. (string, default=\"\")

    \n
    • \n
  • \n

    client_type: Set to Public or Confidential depending on how secure the client device is. (choice, required)

    \n
      \n
    • confidential: Confidential
      • \n
    • public: Public
      • \n
    \n
    • \n
  • redirect_uris: Allowed URIs list, space separated (string, default=\"\")
    • \n
  • authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice, required)
      \n
    • authorization-code: Authorization code
      • \n
    • password: Resource owner password-based
      • \n
    \n
    • \n
  • skip_authorization: Set True to skip authorization step for completely trusted applications. (boolean, default=False)
    • \n
  • organization: Organization containing this application. (id, required)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_applications_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/OAuth2Application" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/OAuth2Application" } } }, "summary":"Update an Application", "tags":[ "Applications" ], "x-internal-id":"api-v2-applications-{id}--patch", "x-filename-id":"api-v2-applications-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\napplication. The following fields may be modified:

\n
    \n
  • name: Name of this application. (string, required)
    • \n
  • \n

    description: Optional description of this application. (string, default=\"\")

    \n
    • \n
  • \n

    client_type: Set to Public or Confidential depending on how secure the client device is. (choice, required)

    \n
      \n
    • confidential: Confidential
      • \n
    • public: Public
      • \n
    \n
    • \n
  • redirect_uris: Allowed URIs list, space separated (string, default=\"\")
    • \n
  • authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice, required)
      \n
    • authorization-code: Authorization code
      • \n
    • password: Resource owner password-based
      • \n
    \n
    • \n
  • skip_authorization: Set True to skip authorization step for completely trusted applications. (boolean, default=False)
    • \n
  • organization: Organization containing this application. (id, required)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_applications_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/OAuth2Application" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/OAuth2Application" } } }, "summary":"Update an Application", "tags":[ "Applications" ], "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_applications_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for an Application", "tags":[ "Applications" ], "x-internal-id":"api-v2-applications-{id}-activity_stream--get", "x-filename-id":"api-v2-applications-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/applications/{id}/tokens/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\napplication.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each access token data structure includes the following fields:

\n
    \n
  • id: Database ID for this access token. (integer)
    • \n
  • type: Data type for this access token. (choice)
    • \n
  • url: URL for this access token. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this access token was created. (datetime)
    • \n
  • modified: Timestamp when this access token was last modified. (datetime)
    • \n
  • description: Optional description of this access token. (string)
    • \n
  • user: The user representing the token owner (id)
    • \n
  • token: (string)
    • \n
  • refresh_token: (field)
    • \n
  • application: (id)
    • \n
  • expires: (datetime)
    • \n
  • scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)
    • \n
\n

Sorting

\n

To specify that access tokens are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_applications_tokens_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/OAuth2Token" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Access Tokens for an Application", "tags":[ "Applications" ], "x-internal-id":"api-v2-applications-{id}-tokens--get", "x-filename-id":"api-v2-applications-id-tokens-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following access token\nfields to create a new access token associated with this\napplication.

\n
    \n
  • \n

    description: Optional description of this access token. (string, default=\"\")

    \n
    • \n
  • \n

    scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")

    \n
    • \n
", "operationId":"api_applications_tokens_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/OAuth2Token" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/OAuth2Token" } } }, "summary":"Create an Access Token for an Application", "tags":[ "Applications" ], "x-internal-id":"api-v2-applications-{id}-tokens--post", "x-filename-id":"api-v2-applications-id-tokens-post" } }, "/api/v2/auth/":{ "get":{ "description":"

List enabled single-sign-on endpoints

", "operationId":"api_auth_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Auth" ], "summary":"Auth List", "x-internal-id":"api-v2-auth--get", "x-filename-id":"api-v2-auth-get" }, "parameters":[ ] }, "/api/v2/bulk/":{ "get":{ "description":"

List top level resources

", "operationId":"api_bulk_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Bulk" ], "summary":"Bulk List", "x-internal-id":"api-v2-bulk--get", "x-filename-id":"api-v2-bulk-get" }, "parameters":[ ] }, "/api/v2/bulk/host_create/":{ "get":{ "description":"

This endpoint allows the client to create multiple hosts and associate them with an inventory. They may do this by providing the inventory ID and a list of json that would normally be provided to create hosts.

", "operationId":"api_bulk_host_create_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/BulkHostCreate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"Bulk Host Create", "tags":[ "Bulk" ], "x-internal-id":"api-v2-bulk-host_create--get", "x-filename-id":"api-v2-bulk-host_create-get" }, "parameters":[ ], "post":{ "description":"

This endpoint allows the client to create multiple hosts and associate them with an inventory. They may do this by providing the inventory ID and a list of json that would normally be provided to create hosts.

", "operationId":"api_bulk_host_create_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/BulkHostCreate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/BulkHostCreate" } } }, "summary":"Bulk Host Create", "tags":[ "Bulk" ], "x-internal-id":"api-v2-bulk-host_create--post", "x-filename-id":"api-v2-bulk-host_create-post" } }, "/api/v2/bulk/host_delete/":{ "get":{ "description":"

This endpoint allows the client to delete multiple hosts from inventories.\nThey may do this by providing a list of hosts ID's to be deleted.

", "operationId":"api_bulk_host_delete_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/BulkHostDelete" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"Bulk Host Delete", "tags":[ "Bulk" ], "x-internal-id":"api-v2-bulk-host_delete--get", "x-filename-id":"api-v2-bulk-host_delete-get" }, "parameters":[ ], "post":{ "description":"

This endpoint allows the client to delete multiple hosts from inventories.\nThey may do this by providing a list of hosts ID's to be deleted.

", "operationId":"api_bulk_host_delete_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/BulkHostDelete" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/BulkHostDelete" } } }, "summary":"Bulk Host Delete", "tags":[ "Bulk" ], "x-internal-id":"api-v2-bulk-host_delete--post", "x-filename-id":"api-v2-bulk-host_delete-post" } }, "/api/v2/bulk/job_launch/":{ "get":{ "description":"

This endpoint allows the client to launch multiple UnifiedJobTemplates at a time, along side any launch time parameters that they would normally set at launch time.

", "operationId":"api_bulk_job_launch_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/BulkJobLaunch" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"Bulk Job Launch", "tags":[ "Bulk" ], "x-internal-id":"api-v2-bulk-job_launch--get", "x-filename-id":"api-v2-bulk-job_launch-get" }, "parameters":[ ], "post":{ "description":"

This endpoint allows the client to launch multiple UnifiedJobTemplates at a time, along side any launch time parameters that they would normally set at launch time.

", "operationId":"api_bulk_job_launch_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/BulkJobLaunch" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/BulkJobLaunch" } } }, "summary":"Bulk Job Launch", "tags":[ "Bulk" ], "x-internal-id":"api-v2-bulk-job_launch--post", "x-filename-id":"api-v2-bulk-job_launch-post" } }, "/api/v2/config/":{ "delete":{ "description":"

(New in Ansible Tower 2.0.0) Make a DELETE request to this resource as a super\nuser to delete the existing license

", "operationId":"api_config_delete", "parameters":[ ], "responses":{ "204":{ "description":"" } }, "summary":"Delete an Existing License", "tags":[ "Config" ], "x-internal-id":"api-v2-config--delete", "x-filename-id":"api-v2-config-delete" }, "get":{ "description":"

Return various sitewide configuration settings

", "operationId":"api_config_list", "parameters":[ ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "analytics_collectors":{ "config":{ "description":"General platform configuration.", "name":"config", "version":"1.6" }, "counts":{ "description":"Counts of objects such as organizations, inventories, and projects", "name":"counts", "version":"1.2" }, "cred_type_counts":{ "description":"Counts of credentials by credential type", "name":"cred_type_counts", "version":"1.0" }, "events_table":{ "description":"Automation task records", "name":"events_table", "version":"1.5" }, "host_metric_summary_monthly_table":{ "description":"HostMetricSummaryMonthly export, full sync", "name":"host_metric_summary_monthly_table", "version":"1.0" }, "host_metric_table":{ "description":"Host Metric data, incremental/full sync", "name":"host_metric_table", "version":"1.0" }, "instance_info":{ "description":"Cluster topology and capacity", "name":"instance_info", "version":"1.3" }, "inventory_counts":{ "description":"Inventories, their inventory sources, and host counts", "name":"inventory_counts", "version":"1.2" }, "org_counts":{ "description":"Counts of users and teams by organization", "name":"org_counts", "version":"1.0" }, "projects_by_scm_type":{ "description":"Counts of projects by source control type", "name":"projects_by_scm_type", "version":"1.0" }, "query_info":{ "description":"Metadata about the analytics collected", "name":"query_info", "version":"1.0" }, "unified_job_template_table":{ "description":"Data on job templates", "name":"unified_job_template_table", "version":"1.1" }, "unified_jobs_table":{ "description":"Data on jobs run", "name":"unified_jobs_table", "version":"1.4" }, "workflow_job_node_table":{ "description":"Data on workflow runs", "name":"workflow_job_node_table", "version":"1.0" }, "workflow_job_template_node_table":{ "description":"Data on workflows", "name":"workflow_job_template_node_table", "version":"1.0" } }, "analytics_status":"off", "become_methods":[ [ "sudo", "Sudo" ], [ "su", "Su" ], [ "pbrun", "Pbrun" ], [ "pfexec", "Pfexec" ], [ "dzdo", "DZDO" ], [ "pmrun", "Pmrun" ], [ "runas", "Runas" ], [ "enable", "Enable" ], [ "doas", "Doas" ], [ "ksu", "Ksu" ], [ "machinectl", "Machinectl" ], [ "sesu", "Sesu" ] ], "custom_virtualenvs":[ ], "eula":"", "license_info":{ "license_type":"open", "product_name":"AWX", "subscription_name":"OPEN", "valid_key":true }, "project_base_dir":"/var/lib/awx/projects/", "project_local_paths":[ ], "time_zone":"UTC", "ui_next":false, "version":"23.7.0" } } } }, "tags":[ "Config" ], "summary":"Config List", "x-internal-id":"api-v2-config--get", "x-filename-id":"api-v2-config-get" }, "parameters":[ ], "post":{ "description":"

(New in Ansible Tower 2.0.0) Make a POST request to this resource as a super\nuser to install or update the existing license. The license data itself can\nbe POSTed as a normal json data structure.

\n

(New in Ansible Tower 2.1.1) The POST must include a eula_accepted boolean\nelement indicating acceptance of the End-User License Agreement.

", "operationId":"api_config_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "summary":"Install or Update an Existing License", "tags":[ "Config" ], "x-internal-id":"api-v2-config--post", "x-filename-id":"api-v2-config-post" } }, "/api/v2/config/attach/":{ "parameters":[ ], "post":{ "description":"", "operationId":"api_config_attach_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Config" ], "summary":"Config Attach Create", "x-internal-id":"api-v2-config-attach--post", "x-filename-id":"api-v2-config-attach-post" } }, "/api/v2/config/subscriptions/":{ "parameters":[ ], "post":{ "description":"", "operationId":"api_config_subscriptions_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Config" ], "summary":"Config Subscriptions Create", "x-internal-id":"api-v2-config-subscriptions--post", "x-filename-id":"api-v2-config-subscriptions-post" } }, "/api/v2/constructed_inventories/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\ninventories.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory. (integer)
    • \n
  • type: Data type for this inventory. (choice)
    • \n
  • url: URL for this inventory. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory was created. (datetime)
    • \n
  • modified: Timestamp when this inventory was last modified. (datetime)
    • \n
  • name: Name of this inventory. (string)
    • \n
  • description: Optional description of this inventory. (string)
    • \n
  • organization: Organization containing this inventory. (id)
    • \n
  • kind: Kind of inventory being represented. (choice)
      \n
    • \"\": Hosts have a direct link to this inventory.
      • \n
    • smart: Hosts for inventory generated using the host_filter property.
      • \n
    • constructed: Parse list of source inventories with the constructed inventory plugin.
      • \n
    \n
    • \n
  • variables: Inventory variables in JSON or YAML format. (json)
    • \n
  • 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)
    • \n
  • total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)
    • \n
  • inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)
    • \n
  • pending_deletion: Flag indicating the inventory is being deleted. (boolean)
    • \n
  • prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)
    • \n
  • source_vars: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)
    • \n
  • update_cache_timeout: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)
    • \n
  • limit: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)
    • \n
  • verbosity: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)
    • \n
\n

Sorting

\n

To specify that inventories are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_constructed_inventories_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ConstructedInventory" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventories", "tags":[ "Constructed Inventories" ], "x-internal-id":"api-v2-constructed_inventories--get", "x-filename-id":"api-v2-constructed_inventories-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following inventory\nfields to create a new inventory:

\n
    \n
  • name: Name of this inventory. (string, required)
    • \n
  • description: Optional description of this inventory. (string, default=\"\")
    • \n
  • \n

    organization: Organization containing this inventory. (id, required)

    \n
    • \n
  • \n

    variables: Inventory variables in JSON or YAML format. (json, default=``)

    \n
    • \n
  • \n

    prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)

    \n
    • \n
  • source_vars: The source_vars for the related auto-created inventory source, special to constructed inventory. (string, default=\"\")
    • \n
  • update_cache_timeout: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer, default=None)
    • \n
  • limit: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string, default=\"\")
    • \n
  • verbosity: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer, default=None)
    • \n
", "operationId":"api_constructed_inventories_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/ConstructedInventory" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/ConstructedInventory" } } }, "summary":"Create an Inventory", "tags":[ "Constructed Inventories" ], "x-internal-id":"api-v2-constructed_inventories--post", "x-filename-id":"api-v2-constructed_inventories-post" } }, "/api/v2/constructed_inventories/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this inventory.

", "operationId":"api_constructed_inventories_delete", "parameters":[ ], "responses":{ "204":{ "description":"" } }, "summary":"Delete an Inventory", "tags":[ "Constructed Inventories" ], "x-internal-id":"api-v2-constructed_inventories-{id}--delete", "x-filename-id":"api-v2-constructed_inventories-id-delete" }, "get":{ "description":"

Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this inventory. (integer)
    • \n
  • type: Data type for this inventory. (choice)
    • \n
  • url: URL for this inventory. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory was created. (datetime)
    • \n
  • modified: Timestamp when this inventory was last modified. (datetime)
    • \n
  • name: Name of this inventory. (string)
    • \n
  • description: Optional description of this inventory. (string)
    • \n
  • organization: Organization containing this inventory. (id)
    • \n
  • kind: Kind of inventory being represented. (choice)
      \n
    • \"\": Hosts have a direct link to this inventory.
      • \n
    • smart: Hosts for inventory generated using the host_filter property.
      • \n
    • constructed: Parse list of source inventories with the constructed inventory plugin.
      • \n
    \n
    • \n
  • variables: Inventory variables in JSON or YAML format. (json)
    • \n
  • 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)
    • \n
  • total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)
    • \n
  • inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)
    • \n
  • pending_deletion: Flag indicating the inventory is being deleted. (boolean)
    • \n
  • prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)
    • \n
  • source_vars: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)
    • \n
  • update_cache_timeout: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)
    • \n
  • limit: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)
    • \n
  • verbosity: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)
    • \n
", "operationId":"api_constructed_inventories_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/ConstructedInventory" } } }, "summary":"Retrieve an Inventory", "tags":[ "Constructed Inventories" ], "x-internal-id":"api-v2-constructed_inventories-{id}--get", "x-filename-id":"api-v2-constructed_inventories-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:

\n
    \n
  • name: Name of this inventory. (string, required)
    • \n
  • description: Optional description of this inventory. (string, default=\"\")
    • \n
  • \n

    organization: Organization containing this inventory. (id, required)

    \n
    • \n
  • \n

    variables: Inventory variables in JSON or YAML format. (json, default=``)

    \n
    • \n
  • \n

    prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)

    \n
    • \n
  • source_vars: The source_vars for the related auto-created inventory source, special to constructed inventory. (string, default=\"\")
    • \n
  • update_cache_timeout: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer, default=None)
    • \n
  • limit: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string, default=\"\")
    • \n
  • verbosity: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer, default=None)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_constructed_inventories_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/ConstructedInventory" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/ConstructedInventory" } } }, "summary":"Update an Inventory", "tags":[ "Constructed Inventories" ], "x-internal-id":"api-v2-constructed_inventories-{id}--patch", "x-filename-id":"api-v2-constructed_inventories-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:

\n
    \n
  • name: Name of this inventory. (string, required)
    • \n
  • description: Optional description of this inventory. (string, default=\"\")
    • \n
  • \n

    organization: Organization containing this inventory. (id, required)

    \n
    • \n
  • \n

    variables: Inventory variables in JSON or YAML format. (json, default=``)

    \n
    • \n
  • \n

    prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)

    \n
    • \n
  • source_vars: The source_vars for the related auto-created inventory source, special to constructed inventory. (string, default=\"\")
    • \n
  • update_cache_timeout: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer, default=None)
    • \n
  • limit: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string, default=\"\")
    • \n
  • verbosity: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer, default=None)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_constructed_inventories_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/ConstructedInventory" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/ConstructedInventory" } } }, "summary":"Update an Inventory", "tags":[ "Constructed Inventories" ], "x-internal-id":"api-v2-constructed_inventories-{id}--put", "x-filename-id":"api-v2-constructed_inventories-id-put" } }, "/api/v2/credential_input_sources/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\ncredential input sources.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential input source data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential input source. (integer)
    • \n
  • type: Data type for this credential input source. (choice)
    • \n
  • url: URL for this credential input source. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential input source was created. (datetime)
    • \n
  • modified: Timestamp when this credential input source was last modified. (datetime)
    • \n
  • description: Optional description of this credential input source. (string)
    • \n
  • input_field_name: (string)
    • \n
  • metadata: (json)
    • \n
  • target_credential: (id)
    • \n
  • source_credential: (id)
    • \n
\n

Sorting

\n

To specify that credential input sources are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_credential_input_sources_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/CredentialInputSource" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credential Input Sources", "tags":[ "Credential Input Sources" ], "x-internal-id":"api-v2-credential_input_sources--get", "x-filename-id":"api-v2-credential_input_sources-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following credential input source\nfields to create a new credential input source:

\n
    \n
  • description: Optional description of this credential input source. (string, default=\"\")
    • \n
  • input_field_name: (string, required)
    • \n
  • metadata: (json, default={})
    • \n
  • target_credential: (id, required)
    • \n
  • source_credential: (id, required)
    • \n
", "operationId":"api_credential_input_sources_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/CredentialInputSource" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/CredentialInputSource" } } }, "summary":"Create a Credential Input Source", "tags":[ "Credential Input Sources" ], "x-internal-id":"api-v2-credential_input_sources--post", "x-filename-id":"api-v2-credential_input_sources-post" } }, "/api/v2/credential_input_sources/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this credential input source.

", "operationId":"api_credential_input_sources_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this credential input source. (integer)
    • \n
  • type: Data type for this credential input source. (choice)
    • \n
  • url: URL for this credential input source. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential input source was created. (datetime)
    • \n
  • modified: Timestamp when this credential input source was last modified. (datetime)
    • \n
  • description: Optional description of this credential input source. (string)
    • \n
  • input_field_name: (string)
    • \n
  • metadata: (json)
    • \n
  • target_credential: (id)
    • \n
  • source_credential: (id)
    • \n
", "operationId":"api_credential_input_sources_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CredentialInputSource" } } }, "summary":"Retrieve a Credential Input Source", "tags":[ "Credential Input Sources" ], "x-internal-id":"api-v2-credential_input_sources-{id}--get", "x-filename-id":"api-v2-credential_input_sources-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\ncredential input source. The following fields may be modified:

\n
    \n
  • description: Optional description of this credential input source. (string, default=\"\")
    • \n
  • input_field_name: (string, required)
    • \n
  • metadata: (json, default={})
    • \n
  • target_credential: (id, required)
    • \n
  • source_credential: (id, required)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_credential_input_sources_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/CredentialInputSource" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CredentialInputSource" } } }, "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":{ "description":"

Make a PUT or PATCH request to this resource to update this\ncredential input source. The following fields may be modified:

\n
    \n
  • description: Optional description of this credential input source. (string, default=\"\")
    • \n
  • input_field_name: (string, required)
    • \n
  • metadata: (json, default={})
    • \n
  • target_credential: (id, required)
    • \n
  • source_credential: (id, required)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_credential_input_sources_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/CredentialInputSource" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CredentialInputSource" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential type data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential type. (integer)
    • \n
  • type: Data type for this credential type. (choice)
    • \n
  • url: URL for this credential type. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential type was created. (datetime)
    • \n
  • modified: Timestamp when this credential type was last modified. (datetime)
    • \n
  • name: Name of this credential type. (string)
    • \n
  • description: Optional description of this credential type. (string)
    • \n
  • kind: (choice)
      \n
    • ssh: Machine
      • \n
    • vault: Vault
      • \n
    • net: Network
      • \n
    • scm: Source Control
      • \n
    • cloud: Cloud
      • \n
    • registry: Container Registry
      • \n
    • token: Personal Access Token
      • \n
    • insights: Insights
      • \n
    • external: External
      • \n
    • kubernetes: Kubernetes
      • \n
    • galaxy: Galaxy/Automation Hub
      • \n
    • cryptography: Cryptography
      • \n
    \n
    • \n
  • namespace: (string)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • injectors: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
\n

Sorting

\n

To specify that credential types are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_credential_types_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/CredentialType" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credential Types", "tags":[ "Credential Types" ], "x-internal-id":"api-v2-credential_types--get", "x-filename-id":"api-v2-credential_types-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following credential type\nfields to create a new credential type:

\n
    \n
  • name: Name of this credential type. (string, required)
    • \n
  • description: Optional description of this credential type. (string, default=\"\")
    • \n
  • \n

    kind: (choice, required)

    \n
      \n
    • net: Network
      • \n
    • cloud: Cloud
      • \n
    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
  • injectors: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})
    • \n
", "operationId":"api_credential_types_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/CredentialType" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/CredentialType" } } }, "summary":"Create a Credential Type", "tags":[ "Credential Types" ], "x-internal-id":"api-v2-credential_types--post", "x-filename-id":"api-v2-credential_types-post" } }, "/api/v2/credential_types/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this credential type.

", "operationId":"api_credential_types_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this credential type. (integer)
    • \n
  • type: Data type for this credential type. (choice)
    • \n
  • url: URL for this credential type. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential type was created. (datetime)
    • \n
  • modified: Timestamp when this credential type was last modified. (datetime)
    • \n
  • name: Name of this credential type. (string)
    • \n
  • description: Optional description of this credential type. (string)
    • \n
  • kind: (choice)
      \n
    • ssh: Machine
      • \n
    • vault: Vault
      • \n
    • net: Network
      • \n
    • scm: Source Control
      • \n
    • cloud: Cloud
      • \n
    • registry: Container Registry
      • \n
    • token: Personal Access Token
      • \n
    • insights: Insights
      • \n
    • external: External
      • \n
    • kubernetes: Kubernetes
      • \n
    • galaxy: Galaxy/Automation Hub
      • \n
    • cryptography: Cryptography
      • \n
    \n
    • \n
  • namespace: (string)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • injectors: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
", "operationId":"api_credential_types_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CredentialType" } } }, "summary":"Retrieve a Credential Type", "tags":[ "Credential Types" ], "x-internal-id":"api-v2-credential_types-{id}--get", "x-filename-id":"api-v2-credential_types-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\ncredential type. The following fields may be modified:

\n
    \n
  • name: Name of this credential type. (string, required)
    • \n
  • description: Optional description of this credential type. (string, default=\"\")
    • \n
  • \n

    kind: (choice, required)

    \n
      \n
    • net: Network
      • \n
    • cloud: Cloud
      • \n
    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
  • injectors: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_credential_types_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/CredentialType" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CredentialType" } } }, "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":{ "description":"

Make a PUT or PATCH request to this resource to update this\ncredential type. The following fields may be modified:

\n
    \n
  • name: Name of this credential type. (string, required)
    • \n
  • description: Optional description of this credential type. (string, default=\"\")
    • \n
  • \n

    kind: (choice, required)

    \n
      \n
    • net: Network
      • \n
    • cloud: Cloud
      • \n
    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
  • injectors: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_credential_types_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/CredentialType" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CredentialType" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_credential_types_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for a Credential Type", "tags":[ "Credential Types" ], "x-internal-id":"api-v2-credential_types-{id}-activity_stream--get", "x-filename-id":"api-v2-credential_types-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/credential_types/{id}/credentials/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ncredential type.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • organization: (id)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_credential_types_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Credential" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials for a Credential Type", "tags":[ "Credential Types" ], "x-internal-id":"api-v2-credential_types-{id}-credentials--get", "x-filename-id":"api-v2-credential_types-id-credentials-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following credential\nfields to create a new credential associated with this\ncredential type.

\n
    \n
  • name: Name of this credential. (string, required)
    • \n
  • description: Optional description of this credential. (string, default=\"\")
    • \n
  • organization: (id, default=None)
    • \n
  • \n

    credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
", "operationId":"api_credential_types_credentials_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Credential" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Credential" } } }, "summary":"Create a Credential for a Credential Type", "tags":[ "Credential Types" ], "x-internal-id":"api-v2-credential_types-{id}-credentials--post", "x-filename-id":"api-v2-credential_types-id-credentials-post" } }, "/api/v2/credential_types/{id}/test/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:

", "operationId":"api_credential_types_test_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Empty" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:

", "operationId":"api_credential_types_test_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Empty" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Empty" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • organization: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/CredentialSerializerCreate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials--get", "x-filename-id":"api-v2-credentials-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following credential\nfields to create a new credential:

\n
    \n
  • name: Name of this credential. (string, required)
    • \n
  • description: Optional description of this credential. (string, default=\"\")
    • \n
  • organization: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id, default=None)
    • \n
  • \n

    credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
  • \n

    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)

    \n
    • \n
  • 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)
    • \n
", "operationId":"api_credentials_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/CredentialSerializerCreate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/CredentialSerializerCreate" } } }, "summary":"Create a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials--post", "x-filename-id":"api-v2-credentials-post" } }, "/api/v2/credentials/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this credential.

", "operationId":"api_credentials_delete", "parameters":[ ], "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:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • organization: (id)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
", "operationId":"api_credentials_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Credential" } } }, "summary":"Retrieve a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}--get", "x-filename-id":"api-v2-credentials-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\ncredential. The following fields may be modified:

\n
    \n
  • name: Name of this credential. (string, required)
    • \n
  • description: Optional description of this credential. (string, default=\"\")
    • \n
  • organization: (id, default=None)
    • \n
  • \n

    credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_credentials_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Credential" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Credential" } } }, "summary":"Update a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}--patch", "x-filename-id":"api-v2-credentials-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\ncredential. The following fields may be modified:

\n
    \n
  • name: Name of this credential. (string, required)
    • \n
  • description: Optional description of this credential. (string, default=\"\")
    • \n
  • organization: (id, default=None)
    • \n
  • \n

    credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_credentials_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Credential" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Credential" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_credentials_access_list_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ResourceAccessListElement" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}-access_list--get", "x-filename-id":"api-v2-credentials-id-access_list-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/credentials/{id}/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ncredential.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_credentials_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}-activity_stream--get", "x-filename-id":"api-v2-credentials-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/credentials/{id}/copy/":{ "get":{ "description":"", "operationId":"api_credentials_copy_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Copy" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "tags":[ "Credentials" ], "summary":"Credentials Copy List", "x-internal-id":"api-v2-credentials-{id}-copy--get", "x-filename-id":"api-v2-credentials-id-copy-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_credentials_copy_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Copy" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Copy" } } }, "tags":[ "Credentials" ], "summary":"Credentials Copy Create", "x-internal-id":"api-v2-credentials-{id}-copy--post", "x-filename-id":"api-v2-credentials-id-copy-post" } }, "/api/v2/credentials/{id}/input_sources/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ncredential input sources associated with the selected\ncredential.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential input source data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential input source. (integer)
    • \n
  • type: Data type for this credential input source. (choice)
    • \n
  • url: URL for this credential input source. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential input source was created. (datetime)
    • \n
  • modified: Timestamp when this credential input source was last modified. (datetime)
    • \n
  • description: Optional description of this credential input source. (string)
    • \n
  • input_field_name: (string)
    • \n
  • metadata: (json)
    • \n
  • target_credential: (id)
    • \n
  • source_credential: (id)
    • \n
\n

Sorting

\n

To specify that credential input sources are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_credentials_input_sources_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/CredentialInputSource" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credential Input Sources for a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}-input_sources--get", "x-filename-id":"api-v2-credentials-id-input_sources-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following credential input source\nfields to create a new credential input source associated with this\ncredential.

\n
    \n
  • description: Optional description of this credential input source. (string, default=\"\")
    • \n
  • input_field_name: (string, required)
    • \n
  • \n

    metadata: (json, default={})

    \n
    • \n
  • \n

    source_credential: (id, required)

    \n
    • \n
", "operationId":"api_credentials_input_sources_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/CredentialInputSource" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/CredentialInputSource" } } }, "summary":"Create a Credential Input Source for a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}-input_sources--post", "x-filename-id":"api-v2-credentials-id-input_sources-post" } }, "/api/v2/credentials/{id}/object_roles/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nroles associated with the selected\ncredential.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_credentials_object_roles_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Role" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles for a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}-object_roles--get", "x-filename-id":"api-v2-credentials-id-object_roles-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/credentials/{id}/owner_teams/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nteams associated with the selected\ncredential.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each team data structure includes the following fields:

\n
    \n
  • id: Database ID for this team. (integer)
    • \n
  • type: Data type for this team. (choice)
    • \n
  • url: URL for this team. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this team was created. (datetime)
    • \n
  • modified: Timestamp when this team was last modified. (datetime)
    • \n
  • name: Name of this team. (string)
    • \n
  • description: Optional description of this team. (string)
    • \n
  • organization: (id)
    • \n
\n

Sorting

\n

To specify that teams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_credentials_owner_teams_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Team" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Teams for a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}-owner_teams--get", "x-filename-id":"api-v2-credentials-id-owner_teams-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/credentials/{id}/owner_users/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nusers associated with the selected\ncredential.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_credentials_owner_users_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/User" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users for a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}-owner_users--get", "x-filename-id":"api-v2-credentials-id-owner_users-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/credentials/{id}/test/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:

", "operationId":"api_credentials_test_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Empty" } } }, "summary":"Retrieve a Credential", "tags":[ "Credentials" ], "x-internal-id":"api-v2-credentials-{id}-test--get", "x-filename-id":"api-v2-credentials-id-test-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:

", "operationId":"api_credentials_test_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Empty" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Empty" } } }, "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":"

Show Dashboard Details

", "operationId":"api_dashboard_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Dashboard" ], "summary":"Dashboard List", "x-internal-id":"api-v2-dashboard--get", "x-filename-id":"api-v2-dashboard-get" }, "parameters":[ ] }, "/api/v2/dashboard/graphs/jobs/":{ "get":{ "description":"

Make a GET request to this resource to retrieve aggregate statistics about job runs suitable for graphing.

\n

Parameters and Filtering

\n

The period of the data can be adjusted with:

\n
?period=month\n
\n

Where month can be replaced with week, two_weeks, or day. month is the default.

\n

The type of job can be filtered with:

\n
?job_type=all\n
\n

Where all can be replaced with inv_sync, playbook_run or scm_update. all is the default.

\n

Results

\n

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}\n
\n

Each element contains an epoch timestamp represented in seconds and a numerical value indicating\nthe number of events during that time period

", "operationId":"api_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" }, "parameters":[ ] }, "/api/v2/execution_environments/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nexecution environments.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The count field indicates the total number of execution environments\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 execution environment records.

\n

Results

\n

Each execution environment data structure includes the following fields:

\n
    \n
  • id: Database ID for this execution environment. (integer)
    • \n
  • type: Data type for this execution environment. (choice)
    • \n
  • url: URL for this execution environment. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this execution environment was created. (datetime)
    • \n
  • modified: Timestamp when this execution environment was last modified. (datetime)
    • \n
  • name: Name of this execution environment. (string)
    • \n
  • description: Optional description of this execution environment. (string)
    • \n
  • organization: The organization used to determine access to this execution environment. (id)
    • \n
  • image: The full image location, including the container registry, image name, and version tag. (string)
    • \n
  • managed: (boolean)
    • \n
  • credential: (id)
    • \n
  • pull: Pull image before running? (choice)
      \n
    • \"\": ---------
      • \n
    • always: Always pull container before running.
      • \n
    • missing: Only pull the image if not present before running.
      • \n
    • never: Never pull container before running.
      • \n
    \n
    • \n
\n

Sorting

\n

To specify that execution environments are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_execution_environments_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ExecutionEnvironment" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Execution Environments", "tags":[ "Execution Environments" ], "x-internal-id":"api-v2-execution_environments--get", "x-filename-id":"api-v2-execution_environments-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following execution environment\nfields to create a new execution environment:

\n
    \n
  • name: Name of this execution environment. (string, required)
    • \n
  • description: Optional description of this execution environment. (string, default=\"\")
    • \n
  • organization: The organization used to determine access to this execution environment. (id, default=``)
    • \n
  • \n

    image: The full image location, including the container registry, image name, and version tag. (string, required)

    \n
    • \n
  • \n

    credential: (id, default=``)

    \n
    • \n
  • pull: Pull image before running? (choice)
      \n
    • \"\": --------- (default)
      • \n
    • always: Always pull container before running.
      • \n
    • missing: Only pull the image if not present before running.
      • \n
    • never: Never pull container before running.
      • \n
    \n
    • \n
", "operationId":"api_execution_environments_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/ExecutionEnvironment" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/ExecutionEnvironment" } } }, "summary":"Create an Execution Environment", "tags":[ "Execution Environments" ], "x-internal-id":"api-v2-execution_environments--post", "x-filename-id":"api-v2-execution_environments-post" } }, "/api/v2/execution_environments/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this execution environment.

", "operationId":"api_execution_environments_delete", "parameters":[ ], "responses":{ "204":{ "description":"" } }, "summary":"Delete an Execution Environment", "tags":[ "Execution Environments" ], "x-internal-id":"api-v2-execution_environments-{id}--delete", "x-filename-id":"api-v2-execution_environments-id-delete" }, "get":{ "description":"

Make GET request to this resource to retrieve a single execution environment\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this execution environment. (integer)
    • \n
  • type: Data type for this execution environment. (choice)
    • \n
  • url: URL for this execution environment. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this execution environment was created. (datetime)
    • \n
  • modified: Timestamp when this execution environment was last modified. (datetime)
    • \n
  • name: Name of this execution environment. (string)
    • \n
  • description: Optional description of this execution environment. (string)
    • \n
  • organization: The organization used to determine access to this execution environment. (id)
    • \n
  • image: The full image location, including the container registry, image name, and version tag. (string)
    • \n
  • managed: (boolean)
    • \n
  • credential: (id)
    • \n
  • pull: Pull image before running? (choice)
      \n
    • \"\": ---------
      • \n
    • always: Always pull container before running.
      • \n
    • missing: Only pull the image if not present before running.
      • \n
    • never: Never pull container before running.
      • \n
    \n
    • \n
", "operationId":"api_execution_environments_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/ExecutionEnvironment" } } }, "summary":"Retrieve an Execution Environment", "tags":[ "Execution Environments" ], "x-internal-id":"api-v2-execution_environments-{id}--get", "x-filename-id":"api-v2-execution_environments-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\nexecution environment. The following fields may be modified:

\n
    \n
  • name: Name of this execution environment. (string, required)
    • \n
  • description: Optional description of this execution environment. (string, default=\"\")
    • \n
  • organization: The organization used to determine access to this execution environment. (id, default=``)
    • \n
  • \n

    image: The full image location, including the container registry, image name, and version tag. (string, required)

    \n
    • \n
  • \n

    credential: (id, default=``)

    \n
    • \n
  • pull: Pull image before running? (choice)
      \n
    • \"\": --------- (default)
      • \n
    • always: Always pull container before running.
      • \n
    • missing: Only pull the image if not present before running.
      • \n
    • never: Never pull container before running.
      • \n
    \n
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_execution_environments_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/ExecutionEnvironment" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/ExecutionEnvironment" } } }, "summary":"Update an Execution Environment", "tags":[ "Execution Environments" ], "x-internal-id":"api-v2-execution_environments-{id}--patch", "x-filename-id":"api-v2-execution_environments-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\nexecution environment. The following fields may be modified:

\n
    \n
  • name: Name of this execution environment. (string, required)
    • \n
  • description: Optional description of this execution environment. (string, default=\"\")
    • \n
  • organization: The organization used to determine access to this execution environment. (id, default=``)
    • \n
  • \n

    image: The full image location, including the container registry, image name, and version tag. (string, required)

    \n
    • \n
  • \n

    credential: (id, default=``)

    \n
    • \n
  • pull: Pull image before running? (choice)
      \n
    • \"\": --------- (default)
      • \n
    • always: Always pull container before running.
      • \n
    • missing: Only pull the image if not present before running.
      • \n
    • never: Never pull container before running.
      • \n
    \n
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_execution_environments_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/ExecutionEnvironment" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/ExecutionEnvironment" } } }, "summary":"Update an Execution Environment", "tags":[ "Execution Environments" ], "x-internal-id":"api-v2-execution_environments-{id}--put", "x-filename-id":"api-v2-execution_environments-id-put" } }, "/api/v2/execution_environments/{id}/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nexecution environment.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_execution_environments_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for an Execution Environment", "tags":[ "Execution Environments" ], "x-internal-id":"api-v2-execution_environments-{id}-activity_stream--get", "x-filename-id":"api-v2-execution_environments-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/execution_environments/{id}/copy/":{ "get":{ "description":"", "operationId":"api_execution_environments_copy_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Copy" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "tags":[ "Execution Environments" ], "summary":"Execution Environments Copy List", "x-internal-id":"api-v2-execution_environments-{id}-copy--get", "x-filename-id":"api-v2-execution_environments-id-copy-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_execution_environments_copy_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Copy" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Copy" } } }, "tags":[ "Execution Environments" ], "summary":"Execution Environments Copy Create", "x-internal-id":"api-v2-execution_environments-{id}-copy--post", "x-filename-id":"api-v2-execution_environments-id-copy-post" } }, "/api/v2/execution_environments/{id}/unified_job_templates/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nunified job templates associated with the selected\nexecution environment.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each unified job template data structure includes the following fields:

\n
    \n
  • id: Database ID for this unified job template. (integer)
    • \n
  • type: Data type for this unified job template. (choice)
    • \n
  • url: URL for this unified job template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this unified job template was created. (datetime)
    • \n
  • modified: Timestamp when this unified job template was last modified. (datetime)
    • \n
  • name: Name of this unified job template. (string)
    • \n
  • description: Optional description of this unified job template. (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    • none: No External Source
      • \n
    • updating: Updating
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
\n

Sorting

\n

To specify that unified job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_execution_environments_unified_job_templates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/UnifiedJobTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Unified Job Templates for an Execution Environment", "tags":[ "Execution Environments" ], "x-internal-id":"api-v2-execution_environments-{id}-unified_job_templates--get", "x-filename-id":"api-v2-execution_environments-id-unified_job_templates-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/groups/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\ngroups.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each group data structure includes the following fields:

\n
    \n
  • id: Database ID for this group. (integer)
    • \n
  • type: Data type for this group. (choice)
    • \n
  • url: URL for this group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this group was created. (datetime)
    • \n
  • modified: Timestamp when this group was last modified. (datetime)
    • \n
  • name: Name of this group. (string)
    • \n
  • description: Optional description of this group. (string)
    • \n
  • inventory: (id)
    • \n
  • variables: Group variables in JSON or YAML format. (json)
    • \n
\n

Sorting

\n

To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Group" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Groups", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups--get", "x-filename-id":"api-v2-groups-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following group\nfields to create a new group:

\n
    \n
  • name: Name of this group. (string, required)
    • \n
  • description: Optional description of this group. (string, default=\"\")
    • \n
  • inventory: (id, required)
    • \n
  • variables: Group variables in JSON or YAML format. (json, default=``)
    • \n
", "operationId":"api_groups_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Group" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Group" } } }, "summary":"Create a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups--post", "x-filename-id":"api-v2-groups-post" } }, "/api/v2/groups/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this group.

", "operationId":"api_groups_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this group. (integer)
    • \n
  • type: Data type for this group. (choice)
    • \n
  • url: URL for this group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this group was created. (datetime)
    • \n
  • modified: Timestamp when this group was last modified. (datetime)
    • \n
  • name: Name of this group. (string)
    • \n
  • description: Optional description of this group. (string)
    • \n
  • inventory: (id)
    • \n
  • variables: Group variables in JSON or YAML format. (json)
    • \n
", "operationId":"api_groups_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Group" } } }, "summary":"Retrieve a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}--get", "x-filename-id":"api-v2-groups-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\ngroup. The following fields may be modified:

\n
    \n
  • name: Name of this group. (string, required)
    • \n
  • description: Optional description of this group. (string, default=\"\")
    • \n
  • inventory: (id, required)
    • \n
  • variables: Group variables in JSON or YAML format. (json, default=``)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_groups_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Group" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Group" } } }, "summary":"Update a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}--patch", "x-filename-id":"api-v2-groups-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\ngroup. The following fields may be modified:

\n
    \n
  • name: Name of this group. (string, required)
    • \n
  • description: Optional description of this group. (string, default=\"\")
    • \n
  • inventory: (id, required)
    • \n
  • variables: Group variables in JSON or YAML format. (json, default=``)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_groups_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Group" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Group" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_groups_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-activity_stream--get", "x-filename-id":"api-v2-groups-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/groups/{id}/ad_hoc_commands/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\ngroup.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each ad hoc command data structure includes the following fields:

\n
    \n
  • id: Database ID for this ad hoc command. (integer)
    • \n
  • type: Data type for this ad hoc command. (choice)
    • \n
  • url: URL for this ad hoc command. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this ad hoc command was created. (datetime)
    • \n
  • modified: Timestamp when this ad hoc command was last modified. (datetime)
    • \n
  • name: Name of this ad hoc command. (string)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id)
    • \n
  • limit: (string)
    • \n
  • credential: (id)
    • \n
  • module_name: (choice)
      \n
    • command
      • \n
    • shell
      • \n
    • yum
      • \n
    • apt
      • \n
    • apt_key
      • \n
    • apt_repository
      • \n
    • apt_rpm
      • \n
    • service
      • \n
    • group
      • \n
    • user
      • \n
    • mount
      • \n
    • ping
      • \n
    • selinux
      • \n
    • setup
      • \n
    • win_ping
      • \n
    • win_service
      • \n
    • win_updates
      • \n
    • win_group
      • \n
    • win_user
      • \n
    \n
    • \n
  • module_args: (string)
    • \n
  • forks: (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (string)
    • \n
  • become_enabled: (boolean)
    • \n
  • diff_mode: (boolean)
    • \n
\n

Sorting

\n

To specify that ad hoc commands are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_groups_ad_hoc_commands_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/AdHocCommandList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Ad Hoc Commands for a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-ad_hoc_commands--get", "x-filename-id":"api-v2-groups-id-ad_hoc_commands-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following ad hoc command\nfields to create a new ad hoc command associated with this\ngroup.

\n
    \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • \n

    job_type: (choice)

    \n
      \n
    • run: Run (default)
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id, default=``)
    • \n
  • limit: (string, default=\"\")
    • \n
  • credential: (id, default=``)
    • \n
  • module_name: (choice)
      \n
    • command (default)
      • \n
    • shell
      • \n
    • yum
      • \n
    • apt
      • \n
    • apt_key
      • \n
    • apt_repository
      • \n
    • apt_rpm
      • \n
    • service
      • \n
    • group
      • \n
    • user
      • \n
    • mount
      • \n
    • ping
      • \n
    • selinux
      • \n
    • setup
      • \n
    • win_ping
      • \n
    • win_service
      • \n
    • win_updates
      • \n
    • win_group
      • \n
    • win_user
      • \n
    \n
    • \n
  • module_args: (string, default=\"\")
    • \n
  • forks: (integer, default=0)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal) (default)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (string, default=\"\")
    • \n
  • become_enabled: (boolean, default=False)
    • \n
  • diff_mode: (boolean, default=False)
    • \n
", "operationId":"api_groups_ad_hoc_commands_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/AdHocCommandList" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/AdHocCommandList" } } }, "summary":"Create an Ad Hoc Command for a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-ad_hoc_commands--post", "x-filename-id":"api-v2-groups-id-ad_hoc_commands-post" } }, "/api/v2/groups/{id}/all_hosts/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of all\nhosts directly or indirectly belonging to this\ngroup.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each host data structure includes the following fields:

\n
    \n
  • id: Database ID for this host. (integer)
    • \n
  • type: Data type for this host. (choice)
    • \n
  • url: URL for this host. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this host was created. (datetime)
    • \n
  • modified: Timestamp when this host was last modified. (datetime)
    • \n
  • name: Name of this host. (string)
    • \n
  • description: Optional description of this host. (string)
    • \n
  • inventory: (id)
    • \n
  • enabled: Is this host online and available for running jobs? (boolean)
    • \n
  • instance_id: The value used by the remote inventory source to uniquely identify the host (string)
    • \n
  • variables: Host variables in JSON or YAML format. (json)
    • \n
  • has_active_failures: (field)
    • \n
  • has_inventory_sources: (field)
    • \n
  • last_job: (id)
    • \n
  • last_job_host_summary: (id)
    • \n
  • ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)
    • \n
\n

Sorting

\n

To specify that hosts are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_groups_all_hosts_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Host" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List All Hosts for a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-all_hosts--get", "x-filename-id":"api-v2-groups-id-all_hosts-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/groups/{id}/children/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ngroup.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each group data structure includes the following fields:

\n
    \n
  • id: Database ID for this group. (integer)
    • \n
  • type: Data type for this group. (choice)
    • \n
  • url: URL for this group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this group was created. (datetime)
    • \n
  • modified: Timestamp when this group was last modified. (datetime)
    • \n
  • name: Name of this group. (string)
    • \n
  • description: Optional description of this group. (string)
    • \n
  • inventory: (id)
    • \n
  • variables: Group variables in JSON or YAML format. (json)
    • \n
\n

Sorting

\n

To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_groups_children_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Group" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Groups for a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-children--get", "x-filename-id":"api-v2-groups-id-children-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following group\nfields to create a new group associated with this\ngroup.

\n
    \n
  • name: Name of this group. (string, required)
    • \n
  • description: Optional description of this group. (string, default=\"\")
    • \n
  • inventory: (id, required)
    • \n
  • variables: Group variables in JSON or YAML format. (json, default=``)
    • \n
\n

Add Groups for a Group:

\n

Make a POST request to this resource with only an id field to associate an\nexisting group with this group.

\n

Remove Groups from this Group:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the group from this group\n without deleting the group.

", "operationId":"api_groups_children_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Group" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Group" } } }, "summary":"Create a Group for a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-children--post", "x-filename-id":"api-v2-groups-id-children-post" } }, "/api/v2/groups/{id}/hosts/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ngroup.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each host data structure includes the following fields:

\n
    \n
  • id: Database ID for this host. (integer)
    • \n
  • type: Data type for this host. (choice)
    • \n
  • url: URL for this host. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this host was created. (datetime)
    • \n
  • modified: Timestamp when this host was last modified. (datetime)
    • \n
  • name: Name of this host. (string)
    • \n
  • description: Optional description of this host. (string)
    • \n
  • inventory: (id)
    • \n
  • enabled: Is this host online and available for running jobs? (boolean)
    • \n
  • instance_id: The value used by the remote inventory source to uniquely identify the host (string)
    • \n
  • variables: Host variables in JSON or YAML format. (json)
    • \n
  • has_active_failures: (field)
    • \n
  • has_inventory_sources: (field)
    • \n
  • last_job: (id)
    • \n
  • last_job_host_summary: (id)
    • \n
  • ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)
    • \n
\n

Sorting

\n

To specify that hosts are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_groups_hosts_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Host" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Hosts for a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-hosts--get", "x-filename-id":"api-v2-groups-id-hosts-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following host\nfields to create a new host associated with this\ngroup.

\n
    \n
  • name: Name of this host. (string, required)
    • \n
  • description: Optional description of this host. (string, default=\"\")
    • \n
  • inventory: (id, required)
    • \n
  • enabled: Is this host online and available for running jobs? (boolean, default=True)
    • \n
  • instance_id: The value used by the remote inventory source to uniquely identify the host (string, default=\"\")
    • \n
  • variables: Host variables in JSON or YAML format. (json, default=``)
    • \n
\n

Add Hosts for a Group:

\n

Make a POST request to this resource with only an id field to associate an\nexisting host with this group.

\n

Remove Hosts from this Group:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the host from this group\n without deleting the host.

", "operationId":"api_groups_hosts_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Host" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Host" } } }, "summary":"Create a Host for a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-hosts--post", "x-filename-id":"api-v2-groups-id-hosts-post" } }, "/api/v2/groups/{id}/inventory_sources/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\ngroup.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory source data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory source. (integer)
    • \n
  • type: Data type for this inventory source. (choice)
    • \n
  • url: URL for this inventory source. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory source was created. (datetime)
    • \n
  • modified: Timestamp when this inventory source was last modified. (datetime)
    • \n
  • name: Name of this inventory source. (string)
    • \n
  • description: Optional description of this inventory source. (string)
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string)
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string)
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)
    • \n
  • credential: Cloud credential to use for inventory updates. (integer)
    • \n
  • 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)
    • \n
  • 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. If the key is not found then the host will be enabled (string)
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)
    • \n
  • overwrite_vars: Overwrite local variables from remote inventory source. (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • limit: Enter host, group or pattern match (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • none: No External Source
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • inventory: (id)
    • \n
  • update_on_launch: (boolean)
    • \n
  • update_cache_timeout: (integer)
    • \n
  • source_project: Project containing inventory file used as source. (id)
    • \n
  • last_update_failed: (boolean)
    • \n
  • last_updated: (datetime)
    • \n
\n

Sorting

\n

To specify that inventory sources are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_groups_inventory_sources_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InventorySource" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventory Sources for a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-inventory_sources--get", "x-filename-id":"api-v2-groups-id-inventory_sources-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/groups/{id}/job_events/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\njob events associated with the selected\ngroup.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each job event data structure includes the following fields:

\n
    \n
  • id: Database ID for this job event. (integer)
    • \n
  • type: Data type for this job event. (choice)
    • \n
  • url: URL for this job event. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job event was created. (datetime)
    • \n
  • modified: Timestamp when this job event was last modified. (datetime)
    • \n
  • job: (id)
    • \n
  • event: (choice)
      \n
    • runner_on_failed: Host Failed
      • \n
    • runner_on_start: Host Started
      • \n
    • runner_on_ok: Host OK
      • \n
    • runner_on_error: Host Failure
      • \n
    • runner_on_skipped: Host Skipped
      • \n
    • runner_on_unreachable: Host Unreachable
      • \n
    • runner_on_no_hosts: No Hosts Remaining
      • \n
    • runner_on_async_poll: Host Polling
      • \n
    • runner_on_async_ok: Host Async OK
      • \n
    • runner_on_async_failed: Host Async Failure
      • \n
    • runner_item_on_ok: Item OK
      • \n
    • runner_item_on_failed: Item Failed
      • \n
    • runner_item_on_skipped: Item Skipped
      • \n
    • runner_retry: Host Retry
      • \n
    • runner_on_file_diff: File Difference
      • \n
    • playbook_on_start: Playbook Started
      • \n
    • playbook_on_notify: Running Handlers
      • \n
    • playbook_on_include: Including File
      • \n
    • playbook_on_no_hosts_matched: No Hosts Matched
      • \n
    • playbook_on_no_hosts_remaining: No Hosts Remaining
      • \n
    • playbook_on_task_start: Task Started
      • \n
    • playbook_on_vars_prompt: Variables Prompted
      • \n
    • playbook_on_setup: Gathering Facts
      • \n
    • playbook_on_import_for_host: internal: on Import for Host
      • \n
    • playbook_on_not_import_for_host: internal: on Not Import for Host
      • \n
    • playbook_on_play_start: Play Started
      • \n
    • playbook_on_stats: Playbook Complete
      • \n
    • debug: Debug
      • \n
    • verbose: Verbose
      • \n
    • deprecated: Deprecated
      • \n
    • warning: Warning
      • \n
    • system_warning: System Warning
      • \n
    • error: Error
      • \n
    \n
    • \n
  • counter: (integer)
    • \n
  • event_display: (string)
    • \n
  • event_data: (json)
    • \n
  • event_level: (integer)
    • \n
  • failed: (boolean)
    • \n
  • changed: (boolean)
    • \n
  • uuid: (string)
    • \n
  • parent_uuid: (string)
    • \n
  • host: (id)
    • \n
  • host_name: (string)
    • \n
  • playbook: (string)
    • \n
  • play: (string)
    • \n
  • task: (string)
    • \n
  • role: (string)
    • \n
  • stdout: (string)
    • \n
  • start_line: (integer)
    • \n
  • end_line: (integer)
    • \n
  • verbosity: (integer)
    • \n
\n

Sorting

\n

To specify that job events are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_groups_job_events_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/JobEvent" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Job Events for a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-job_events--get", "x-filename-id":"api-v2-groups-id-job_events-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/groups/{id}/job_host_summaries/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\njob host summaries associated with the selected\ngroup.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each job host summary data structure includes the following fields:

\n
    \n
  • id: Database ID for this job host summary. (integer)
    • \n
  • type: Data type for this job host summary. (choice)
    • \n
  • url: URL for this job host summary. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job host summary was created. (datetime)
    • \n
  • modified: Timestamp when this job host summary was last modified. (datetime)
    • \n
  • job: (id)
    • \n
  • host: (id)
    • \n
  • constructed_host: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)
    • \n
  • host_name: (string)
    • \n
  • changed: (integer)
    • \n
  • dark: (integer)
    • \n
  • failures: (integer)
    • \n
  • ok: (integer)
    • \n
  • processed: (integer)
    • \n
  • skipped: (integer)
    • \n
  • failed: (boolean)
    • \n
  • ignored: (integer)
    • \n
  • rescued: (integer)
    • \n
\n

Sorting

\n

To specify that job host summaries are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_groups_job_host_summaries_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/JobHostSummary" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Job Host Summaries for a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-job_host_summaries--get", "x-filename-id":"api-v2-groups-id-job_host_summaries-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/groups/{id}/potential_children/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ngroups available to be added as children of the\ncurrent group.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each group data structure includes the following fields:

\n
    \n
  • id: Database ID for this group. (integer)
    • \n
  • type: Data type for this group. (choice)
    • \n
  • url: URL for this group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this group was created. (datetime)
    • \n
  • modified: Timestamp when this group was last modified. (datetime)
    • \n
  • name: Name of this group. (string)
    • \n
  • description: Optional description of this group. (string)
    • \n
  • inventory: (id)
    • \n
  • variables: Group variables in JSON or YAML format. (json)
    • \n
\n

Sorting

\n

To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_groups_potential_children_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Group" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Potential Child Groups for a Group", "tags":[ "Groups" ], "x-internal-id":"api-v2-groups-{id}-potential_children--get", "x-filename-id":"api-v2-groups-id-potential_children-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/groups/{id}/variable_data/":{ "get":{ "consumes":[ "application/json", "application/yaml" ], "description":"

Make a GET request to this resource to retrieve all variables defined for a\ngroup.

", "operationId":"api_groups_variable_data_read", "parameters":[ ], "produces":[ "application/json", "application/yaml" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/GroupVariableData" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "consumes":[ "application/json", "application/yaml" ], "description":"

Make a PUT or PATCH request to this resource to update variables defined for a\ngroup.

", "operationId":"api_groups_variable_data_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/GroupVariableData" } } ], "produces":[ "application/json", "application/yaml" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/GroupVariableData" } } }, "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", "application/yaml" ], "description":"

Make a PUT or PATCH request to this resource to update variables defined for a\ngroup.

", "operationId":"api_groups_variable_data_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/GroupVariableData" } } ], "produces":[ "application/json", "application/yaml" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/GroupVariableData" } } }, "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/host_metric_summary_monthly/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nhost metric summary monthlys.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The count field indicates the total number of host metric summary monthlys\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 metric summary monthly records.

\n

Results

\n

Each host metric summary monthly data structure includes the following fields:

\n
    \n
  • id: Database ID for this host metric summary monthly. (integer)
    • \n
  • date: (date)
    • \n
  • license_consumed: How many unique hosts are consumed from the license (integer)
    • \n
  • license_capacity: 'License capacity as max. number of unique hosts (integer)
    • \n
  • hosts_added: How many hosts were added in the associated month, consuming more license capacity (integer)
    • \n
  • hosts_deleted: How many hosts were deleted in the associated month, freeing the license capacity (integer)
    • \n
  • indirectly_managed_hosts: Manually entered number indirectly managed hosts for a certain month (integer)
    • \n
\n

Sorting

\n

To specify that host metric summary monthlys are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_host_metric_summary_monthly_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/HostMetricSummaryMonthly" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Host Metric Summary Monthlys", "tags":[ "Host Metric Summary Monthly" ], "x-internal-id":"api-v2-host_metric_summary_monthly--get", "x-filename-id":"api-v2-host_metric_summary_monthly-get" }, "parameters":[ ] }, "/api/v2/host_metrics/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nhost metrics.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The count field indicates the total number of host metrics\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 metric records.

\n

Results

\n

Each host metric data structure includes the following fields:

\n
    \n
  • id: Database ID for this host metric. (integer)
    • \n
  • hostname: (string)
    • \n
  • url: URL for this host metric. (string)
    • \n
  • first_automation: When the host was first automated against (datetime)
    • \n
  • last_automation: When the host was last automated against (datetime)
    • \n
  • last_deleted: When the host was last deleted (datetime)
    • \n
  • automated_counter: How many times was the host automated (integer)
    • \n
  • deleted_counter: How many times was the host deleted (integer)
    • \n
  • deleted: Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption (boolean)
    • \n
  • used_in_inventories: How many inventories contain this host (integer)
    • \n
\n

Sorting

\n

To specify that host metrics are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_host_metrics_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/HostMetric" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Host Metrics", "tags":[ "Host Metrics" ], "x-internal-id":"api-v2-host_metrics--get", "x-filename-id":"api-v2-host_metrics-get" }, "parameters":[ ] }, "/api/v2/host_metrics/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to soft-delete this host metric.

\n

A soft deletion will mark the deleted field as true and exclude the host\nmetric from license calculations.\nThis may be undone later if the same hostname is automated again afterwards.

", "operationId":"api_host_metrics_delete", "parameters":[ ], "responses":{ "204":{ "description":"" } }, "summary":"Delete a Host Metric", "tags":[ "Host Metrics" ], "x-internal-id":"api-v2-host_metrics-{id}--delete", "x-filename-id":"api-v2-host_metrics-id-delete" }, "get":{ "description":"

Make GET request to this resource to retrieve a single host metric\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this host metric. (integer)
    • \n
  • hostname: (string)
    • \n
  • url: URL for this host metric. (string)
    • \n
  • first_automation: When the host was first automated against (datetime)
    • \n
  • last_automation: When the host was last automated against (datetime)
    • \n
  • last_deleted: When the host was last deleted (datetime)
    • \n
  • automated_counter: How many times was the host automated (integer)
    • \n
  • deleted_counter: How many times was the host deleted (integer)
    • \n
  • deleted: Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption (boolean)
    • \n
  • used_in_inventories: How many inventories contain this host (integer)
    • \n
", "operationId":"api_host_metrics_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/HostMetric" } } }, "summary":"Retrieve a Host Metric", "tags":[ "Host Metrics" ], "x-internal-id":"api-v2-host_metrics-{id}--get", "x-filename-id":"api-v2-host_metrics-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/hosts/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nhosts.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each host data structure includes the following fields:

\n
    \n
  • id: Database ID for this host. (integer)
    • \n
  • type: Data type for this host. (choice)
    • \n
  • url: URL for this host. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this host was created. (datetime)
    • \n
  • modified: Timestamp when this host was last modified. (datetime)
    • \n
  • name: Name of this host. (string)
    • \n
  • description: Optional description of this host. (string)
    • \n
  • inventory: (id)
    • \n
  • enabled: Is this host online and available for running jobs? (boolean)
    • \n
  • instance_id: The value used by the remote inventory source to uniquely identify the host (string)
    • \n
  • variables: Host variables in JSON or YAML format. (json)
    • \n
  • has_active_failures: (field)
    • \n
  • has_inventory_sources: (field)
    • \n
  • last_job: (id)
    • \n
  • last_job_host_summary: (id)
    • \n
  • ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)
    • \n
\n

Sorting

\n

To specify that hosts are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_hosts_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Host" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Hosts", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts--get", "x-filename-id":"api-v2-hosts-get" }, "parameters":[ ], "post":{ "description":"

host_filter is available on this endpoint. The filter supports: relational queries, and or boolean logic, as well as expression grouping via ().

\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)\n
\n

host_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.

\n
?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\n
", "operationId":"api_hosts_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Host" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Host" } } }, "tags":[ "Hosts" ], "summary":"Hosts Create", "x-internal-id":"api-v2-hosts--post", "x-filename-id":"api-v2-hosts-post" } }, "/api/v2/hosts/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this host.

", "operationId":"api_hosts_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this host. (integer)
    • \n
  • type: Data type for this host. (choice)
    • \n
  • url: URL for this host. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this host was created. (datetime)
    • \n
  • modified: Timestamp when this host was last modified. (datetime)
    • \n
  • name: Name of this host. (string)
    • \n
  • description: Optional description of this host. (string)
    • \n
  • inventory: (id)
    • \n
  • enabled: Is this host online and available for running jobs? (boolean)
    • \n
  • instance_id: The value used by the remote inventory source to uniquely identify the host (string)
    • \n
  • variables: Host variables in JSON or YAML format. (json)
    • \n
  • has_active_failures: (field)
    • \n
  • has_inventory_sources: (field)
    • \n
  • last_job: (id)
    • \n
  • last_job_host_summary: (id)
    • \n
  • ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)
    • \n
", "operationId":"api_hosts_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Host" } } }, "summary":"Retrieve a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}--get", "x-filename-id":"api-v2-hosts-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\nhost. The following fields may be modified:

\n
    \n
  • name: Name of this host. (string, required)
    • \n
  • description: Optional description of this host. (string, default=\"\")
    • \n
  • inventory: (id, required)
    • \n
  • enabled: Is this host online and available for running jobs? (boolean, default=True)
    • \n
  • instance_id: The value used by the remote inventory source to uniquely identify the host (string, default=\"\")
    • \n
  • variables: Host variables in JSON or YAML format. (json, default=``)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_hosts_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Host" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Host" } } }, "summary":"Update a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}--patch", "x-filename-id":"api-v2-hosts-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\nhost. The following fields may be modified:

\n
    \n
  • name: Name of this host. (string, required)
    • \n
  • description: Optional description of this host. (string, default=\"\")
    • \n
  • inventory: (id, required)
    • \n
  • enabled: Is this host online and available for running jobs? (boolean, default=True)
    • \n
  • instance_id: The value used by the remote inventory source to uniquely identify the host (string, default=\"\")
    • \n
  • variables: Host variables in JSON or YAML format. (json, default=``)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_hosts_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Host" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Host" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_hosts_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-activity_stream--get", "x-filename-id":"api-v2-hosts-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/hosts/{id}/ad_hoc_command_events/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nad hoc command events associated with the selected\nhost.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each ad hoc command event data structure includes the following fields:

\n
    \n
  • id: Database ID for this ad hoc command event. (integer)
    • \n
  • type: Data type for this ad hoc command event. (choice)
    • \n
  • url: URL for this ad hoc command event. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this ad hoc command event was created. (datetime)
    • \n
  • modified: Timestamp when this ad hoc command event was last modified. (datetime)
    • \n
  • ad_hoc_command: (id)
    • \n
  • event: (choice)
      \n
    • runner_on_failed: Host Failed
      • \n
    • runner_on_ok: Host OK
      • \n
    • runner_on_unreachable: Host Unreachable
      • \n
    • runner_on_skipped: Host Skipped
      • \n
    • debug: Debug
      • \n
    • verbose: Verbose
      • \n
    • deprecated: Deprecated
      • \n
    • warning: Warning
      • \n
    • system_warning: System Warning
      • \n
    • error: Error
      • \n
    \n
    • \n
  • counter: (integer)
    • \n
  • event_display: (string)
    • \n
  • event_data: (json)
    • \n
  • failed: (boolean)
    • \n
  • changed: (boolean)
    • \n
  • uuid: (string)
    • \n
  • host: (id)
    • \n
  • host_name: (string)
    • \n
  • stdout: (string)
    • \n
  • start_line: (integer)
    • \n
  • end_line: (integer)
    • \n
  • verbosity: (integer)
    • \n
\n

Sorting

\n

To specify that ad hoc command events are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_hosts_ad_hoc_command_events_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/AdHocCommandEvent" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Ad Hoc Command Events for a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-ad_hoc_command_events--get", "x-filename-id":"api-v2-hosts-id-ad_hoc_command_events-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/hosts/{id}/ad_hoc_commands/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\nhost.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each ad hoc command data structure includes the following fields:

\n
    \n
  • id: Database ID for this ad hoc command. (integer)
    • \n
  • type: Data type for this ad hoc command. (choice)
    • \n
  • url: URL for this ad hoc command. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this ad hoc command was created. (datetime)
    • \n
  • modified: Timestamp when this ad hoc command was last modified. (datetime)
    • \n
  • name: Name of this ad hoc command. (string)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id)
    • \n
  • limit: (string)
    • \n
  • credential: (id)
    • \n
  • module_name: (choice)
      \n
    • command
      • \n
    • shell
      • \n
    • yum
      • \n
    • apt
      • \n
    • apt_key
      • \n
    • apt_repository
      • \n
    • apt_rpm
      • \n
    • service
      • \n
    • group
      • \n
    • user
      • \n
    • mount
      • \n
    • ping
      • \n
    • selinux
      • \n
    • setup
      • \n
    • win_ping
      • \n
    • win_service
      • \n
    • win_updates
      • \n
    • win_group
      • \n
    • win_user
      • \n
    \n
    • \n
  • module_args: (string)
    • \n
  • forks: (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (string)
    • \n
  • become_enabled: (boolean)
    • \n
  • diff_mode: (boolean)
    • \n
\n

Sorting

\n

To specify that ad hoc commands are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_hosts_ad_hoc_commands_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/AdHocCommandList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Ad Hoc Commands for a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-ad_hoc_commands--get", "x-filename-id":"api-v2-hosts-id-ad_hoc_commands-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following ad hoc command\nfields to create a new ad hoc command associated with this\nhost.

\n
    \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • \n

    job_type: (choice)

    \n
      \n
    • run: Run (default)
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id, default=``)
    • \n
  • limit: (string, default=\"\")
    • \n
  • credential: (id, default=``)
    • \n
  • module_name: (choice)
      \n
    • command (default)
      • \n
    • shell
      • \n
    • yum
      • \n
    • apt
      • \n
    • apt_key
      • \n
    • apt_repository
      • \n
    • apt_rpm
      • \n
    • service
      • \n
    • group
      • \n
    • user
      • \n
    • mount
      • \n
    • ping
      • \n
    • selinux
      • \n
    • setup
      • \n
    • win_ping
      • \n
    • win_service
      • \n
    • win_updates
      • \n
    • win_group
      • \n
    • win_user
      • \n
    \n
    • \n
  • module_args: (string, default=\"\")
    • \n
  • forks: (integer, default=0)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal) (default)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (string, default=\"\")
    • \n
  • become_enabled: (boolean, default=False)
    • \n
  • diff_mode: (boolean, default=False)
    • \n
", "operationId":"api_hosts_ad_hoc_commands_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/AdHocCommandList" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/AdHocCommandList" } } }, "summary":"Create an Ad Hoc Command for a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-ad_hoc_commands--post", "x-filename-id":"api-v2-hosts-id-ad_hoc_commands-post" } }, "/api/v2/hosts/{id}/all_groups/":{ "get":{ "description":"

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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each group data structure includes the following fields:

\n
    \n
  • id: Database ID for this group. (integer)
    • \n
  • type: Data type for this group. (choice)
    • \n
  • url: URL for this group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this group was created. (datetime)
    • \n
  • modified: Timestamp when this group was last modified. (datetime)
    • \n
  • name: Name of this group. (string)
    • \n
  • description: Optional description of this group. (string)
    • \n
  • inventory: (id)
    • \n
  • variables: Group variables in JSON or YAML format. (json)
    • \n
\n

Sorting

\n

To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_hosts_all_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Group" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List All Groups for a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-all_groups--get", "x-filename-id":"api-v2-hosts-id-all_groups-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/hosts/{id}/ansible_facts/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single host\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this host. (integer)
    • \n
  • type: Data type for this host. (choice)
    • \n
  • url: URL for this host. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this host was created. (datetime)
    • \n
  • modified: Timestamp when this host was last modified. (datetime)
    • \n
  • name: Name of this host. (string)
    • \n
  • description: Optional description of this host. (string)
    • \n
", "operationId":"api_hosts_ansible_facts_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/AnsibleFacts" } } }, "summary":"Retrieve a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-ansible_facts--get", "x-filename-id":"api-v2-hosts-id-ansible_facts-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/hosts/{id}/groups/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\nhost.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each group data structure includes the following fields:

\n
    \n
  • id: Database ID for this group. (integer)
    • \n
  • type: Data type for this group. (choice)
    • \n
  • url: URL for this group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this group was created. (datetime)
    • \n
  • modified: Timestamp when this group was last modified. (datetime)
    • \n
  • name: Name of this group. (string)
    • \n
  • description: Optional description of this group. (string)
    • \n
  • inventory: (id)
    • \n
  • variables: Group variables in JSON or YAML format. (json)
    • \n
\n

Sorting

\n

To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_hosts_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Group" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Groups for a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-groups--get", "x-filename-id":"api-v2-hosts-id-groups-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following group\nfields to create a new group associated with this\nhost.

\n
    \n
  • name: Name of this group. (string, required)
    • \n
  • description: Optional description of this group. (string, default=\"\")
    • \n
  • inventory: (id, required)
    • \n
  • variables: Group variables in JSON or YAML format. (json, default=``)
    • \n
\n

Add Groups for a Host:

\n

Make a POST request to this resource with only an id field to associate an\nexisting group with this host.

\n

Remove Groups from this Host:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the group from this host\n without deleting the group.

", "operationId":"api_hosts_groups_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Group" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Group" } } }, "summary":"Create a Group for a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-groups--post", "x-filename-id":"api-v2-hosts-id-groups-post" } }, "/api/v2/hosts/{id}/inventory_sources/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\nhost.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory source data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory source. (integer)
    • \n
  • type: Data type for this inventory source. (choice)
    • \n
  • url: URL for this inventory source. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory source was created. (datetime)
    • \n
  • modified: Timestamp when this inventory source was last modified. (datetime)
    • \n
  • name: Name of this inventory source. (string)
    • \n
  • description: Optional description of this inventory source. (string)
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string)
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string)
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)
    • \n
  • credential: Cloud credential to use for inventory updates. (integer)
    • \n
  • 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)
    • \n
  • 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. If the key is not found then the host will be enabled (string)
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)
    • \n
  • overwrite_vars: Overwrite local variables from remote inventory source. (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • limit: Enter host, group or pattern match (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • none: No External Source
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • inventory: (id)
    • \n
  • update_on_launch: (boolean)
    • \n
  • update_cache_timeout: (integer)
    • \n
  • source_project: Project containing inventory file used as source. (id)
    • \n
  • last_update_failed: (boolean)
    • \n
  • last_updated: (datetime)
    • \n
\n

Sorting

\n

To specify that inventory sources are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_hosts_inventory_sources_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InventorySource" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventory Sources for a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-inventory_sources--get", "x-filename-id":"api-v2-hosts-id-inventory_sources-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/hosts/{id}/job_events/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\njob events associated with the selected\nhost.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each job event data structure includes the following fields:

\n
    \n
  • id: Database ID for this job event. (integer)
    • \n
  • type: Data type for this job event. (choice)
    • \n
  • url: URL for this job event. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job event was created. (datetime)
    • \n
  • modified: Timestamp when this job event was last modified. (datetime)
    • \n
  • job: (id)
    • \n
  • event: (choice)
      \n
    • runner_on_failed: Host Failed
      • \n
    • runner_on_start: Host Started
      • \n
    • runner_on_ok: Host OK
      • \n
    • runner_on_error: Host Failure
      • \n
    • runner_on_skipped: Host Skipped
      • \n
    • runner_on_unreachable: Host Unreachable
      • \n
    • runner_on_no_hosts: No Hosts Remaining
      • \n
    • runner_on_async_poll: Host Polling
      • \n
    • runner_on_async_ok: Host Async OK
      • \n
    • runner_on_async_failed: Host Async Failure
      • \n
    • runner_item_on_ok: Item OK
      • \n
    • runner_item_on_failed: Item Failed
      • \n
    • runner_item_on_skipped: Item Skipped
      • \n
    • runner_retry: Host Retry
      • \n
    • runner_on_file_diff: File Difference
      • \n
    • playbook_on_start: Playbook Started
      • \n
    • playbook_on_notify: Running Handlers
      • \n
    • playbook_on_include: Including File
      • \n
    • playbook_on_no_hosts_matched: No Hosts Matched
      • \n
    • playbook_on_no_hosts_remaining: No Hosts Remaining
      • \n
    • playbook_on_task_start: Task Started
      • \n
    • playbook_on_vars_prompt: Variables Prompted
      • \n
    • playbook_on_setup: Gathering Facts
      • \n
    • playbook_on_import_for_host: internal: on Import for Host
      • \n
    • playbook_on_not_import_for_host: internal: on Not Import for Host
      • \n
    • playbook_on_play_start: Play Started
      • \n
    • playbook_on_stats: Playbook Complete
      • \n
    • debug: Debug
      • \n
    • verbose: Verbose
      • \n
    • deprecated: Deprecated
      • \n
    • warning: Warning
      • \n
    • system_warning: System Warning
      • \n
    • error: Error
      • \n
    \n
    • \n
  • counter: (integer)
    • \n
  • event_display: (string)
    • \n
  • event_data: (json)
    • \n
  • event_level: (integer)
    • \n
  • failed: (boolean)
    • \n
  • changed: (boolean)
    • \n
  • uuid: (string)
    • \n
  • parent_uuid: (string)
    • \n
  • host: (id)
    • \n
  • host_name: (string)
    • \n
  • playbook: (string)
    • \n
  • play: (string)
    • \n
  • task: (string)
    • \n
  • role: (string)
    • \n
  • stdout: (string)
    • \n
  • start_line: (integer)
    • \n
  • end_line: (integer)
    • \n
  • verbosity: (integer)
    • \n
\n

Sorting

\n

To specify that job events are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_hosts_job_events_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/JobEvent" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Job Events for a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-job_events--get", "x-filename-id":"api-v2-hosts-id-job_events-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/hosts/{id}/job_host_summaries/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\njob host summaries associated with the selected\nhost.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each job host summary data structure includes the following fields:

\n
    \n
  • id: Database ID for this job host summary. (integer)
    • \n
  • type: Data type for this job host summary. (choice)
    • \n
  • url: URL for this job host summary. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job host summary was created. (datetime)
    • \n
  • modified: Timestamp when this job host summary was last modified. (datetime)
    • \n
  • job: (id)
    • \n
  • host: (id)
    • \n
  • constructed_host: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)
    • \n
  • host_name: (string)
    • \n
  • changed: (integer)
    • \n
  • dark: (integer)
    • \n
  • failures: (integer)
    • \n
  • ok: (integer)
    • \n
  • processed: (integer)
    • \n
  • skipped: (integer)
    • \n
  • failed: (boolean)
    • \n
  • ignored: (integer)
    • \n
  • rescued: (integer)
    • \n
\n

Sorting

\n

To specify that job host summaries are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_hosts_job_host_summaries_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/JobHostSummary" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Job Host Summaries for a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-job_host_summaries--get", "x-filename-id":"api-v2-hosts-id-job_host_summaries-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/hosts/{id}/smart_inventories/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninventories associated with the selected\nhost.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory. (integer)
    • \n
  • type: Data type for this inventory. (choice)
    • \n
  • url: URL for this inventory. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory was created. (datetime)
    • \n
  • modified: Timestamp when this inventory was last modified. (datetime)
    • \n
  • name: Name of this inventory. (string)
    • \n
  • description: Optional description of this inventory. (string)
    • \n
  • organization: Organization containing this inventory. (id)
    • \n
  • kind: Kind of inventory being represented. (choice)
      \n
    • \"\": Hosts have a direct link to this inventory.
      • \n
    • smart: Hosts for inventory generated using the host_filter property.
      • \n
    • constructed: Parse list of source inventories with the constructed inventory plugin.
      • \n
    \n
    • \n
  • host_filter: Filter that will be applied to the hosts of this inventory. (string)
    • \n
  • variables: Inventory variables in JSON or YAML format. (json)
    • \n
  • 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)
    • \n
  • total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)
    • \n
  • inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)
    • \n
  • pending_deletion: Flag indicating the inventory is being deleted. (boolean)
    • \n
  • prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)
    • \n
\n

Sorting

\n

To specify that inventories are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_hosts_smart_inventories_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Inventory" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventories for a Host", "tags":[ "Hosts" ], "x-internal-id":"api-v2-hosts-{id}-smart_inventories--get", "x-filename-id":"api-v2-hosts-id-smart_inventories-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/hosts/{id}/variable_data/":{ "get":{ "consumes":[ "application/json", "application/yaml" ], "description":"

Make a GET request to this resource to retrieve all variables defined for a\nhost.

", "operationId":"api_hosts_variable_data_read", "parameters":[ ], "produces":[ "application/json", "application/yaml" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/HostVariableData" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "consumes":[ "application/json", "application/yaml" ], "description":"

Make a PUT or PATCH request to this resource to update variables defined for a\nhost.

", "operationId":"api_hosts_variable_data_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/HostVariableData" } } ], "produces":[ "application/json", "application/yaml" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/HostVariableData" } } }, "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", "application/yaml" ], "description":"

Make a PUT or PATCH request to this resource to update variables defined for a\nhost.

", "operationId":"api_hosts_variable_data_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/HostVariableData" } } ], "produces":[ "application/json", "application/yaml" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/HostVariableData" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each instance group data structure includes the following fields:

\n
    \n
  • id: Database ID for this instance group. (integer)
    • \n
  • type: Data type for this instance group. (choice)
    • \n
  • url: URL for this instance group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • name: Name of this instance group. (string)
    • \n
  • created: Timestamp when this instance group was created. (datetime)
    • \n
  • modified: Timestamp when this instance group was last modified. (datetime)
    • \n
  • capacity: (field)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: (field)
    • \n
  • max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance group (integer)
    • \n
  • instances: (field)
    • \n
  • is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)
    • \n
  • credential: (id)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json)
    • \n
  • pod_spec_override: (string)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
\n

Sorting

\n

To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_instance_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InstanceGroup" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Instance Groups", "tags":[ "Instance Groups" ], "x-internal-id":"api-v2-instance_groups--get", "x-filename-id":"api-v2-instance_groups-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following instance group\nfields to create a new instance group:

\n
    \n
  • \n

    name: Name of this instance group. (string, required)

    \n
    • \n
  • \n

    max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)

    \n
    • \n
  • credential: (id, default=``)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)
    • \n
  • pod_spec_override: (string, default=\"\")
    • \n
", "operationId":"api_instance_groups_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InstanceGroup" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InstanceGroup" } } }, "summary":"Create an Instance Group", "tags":[ "Instance Groups" ], "x-internal-id":"api-v2-instance_groups--post", "x-filename-id":"api-v2-instance_groups-post" } }, "/api/v2/instance_groups/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this instance group.

", "operationId":"api_instance_groups_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this instance group. (integer)
    • \n
  • type: Data type for this instance group. (choice)
    • \n
  • url: URL for this instance group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • name: Name of this instance group. (string)
    • \n
  • created: Timestamp when this instance group was created. (datetime)
    • \n
  • modified: Timestamp when this instance group was last modified. (datetime)
    • \n
  • capacity: (field)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: (field)
    • \n
  • max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance group (integer)
    • \n
  • instances: (field)
    • \n
  • is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)
    • \n
  • credential: (id)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json)
    • \n
  • pod_spec_override: (string)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
", "operationId":"api_instance_groups_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InstanceGroup" } } }, "summary":"Retrieve an Instance Group", "tags":[ "Instance Groups" ], "x-internal-id":"api-v2-instance_groups-{id}--get", "x-filename-id":"api-v2-instance_groups-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\ninstance group. The following fields may be modified:

\n
    \n
  • \n

    name: Name of this instance group. (string, required)

    \n
    • \n
  • \n

    max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)

    \n
    • \n
  • credential: (id, default=``)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)
    • \n
  • pod_spec_override: (string, default=\"\")
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_instance_groups_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InstanceGroup" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InstanceGroup" } } }, "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":{ "description":"

Make a PUT or PATCH request to this resource to update this\ninstance group. The following fields may be modified:

\n
    \n
  • \n

    name: Name of this instance group. (string, required)

    \n
    • \n
  • \n

    max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)

    \n
    • \n
  • credential: (id, default=``)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)
    • \n
  • pod_spec_override: (string, default=\"\")
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_instance_groups_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InstanceGroup" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InstanceGroup" } } }, "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}/access_list/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nusers.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_instance_groups_access_list_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ResourceAccessListElement" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users", "tags":[ "Instance Groups" ], "x-internal-id":"api-v2-instance_groups-{id}-access_list--get", "x-filename-id":"api-v2-instance_groups-id-access_list-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each instance data structure includes the following fields:

\n
    \n
  • id: Database ID for this instance. (integer)
    • \n
  • hostname: (string)
    • \n
  • type: Data type for this instance. (choice)
    • \n
  • url: URL for this instance. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • uuid: (string)
    • \n
  • created: Timestamp when this instance was created. (datetime)
    • \n
  • modified: Timestamp when this instance was last modified. (datetime)
    • \n
  • last_seen: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)
    • \n
  • health_check_started: The last time a health check was initiated on this instance. (datetime)
    • \n
  • health_check_pending: (field)
    • \n
  • last_health_check: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)
    • \n
  • errors: Any error details from the last health check. (string)
    • \n
  • capacity_adjustment: (decimal)
    • \n
  • version: (string)
    • \n
  • capacity: (integer)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: Count of jobs in the running or waiting state that are targeted for this instance (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance (integer)
    • \n
  • cpu: (decimal)
    • \n
  • memory: Total system memory of this instance in bytes. (integer)
    • \n
  • cpu_capacity: (integer)
    • \n
  • mem_capacity: (integer)
    • \n
  • enabled: (boolean)
    • \n
  • managed_by_policy: (boolean)
    • \n
  • node_type: Role that this node plays in the mesh. (choice)
      \n
    • control: Control plane node
      • \n
    • execution: Execution plane node
      • \n
    • hybrid: Controller and execution
      • \n
    • hop: Message-passing node, no execution capability
      • \n
    \n
    • \n
  • node_state: Indicates the current life cycle stage of this instance. (choice)
      \n
    • provisioning: Provisioning
      • \n
    • provision-fail: Provisioning Failure
      • \n
    • installed: Installed
      • \n
    • ready: Ready
      • \n
    • unavailable: Unavailable
      • \n
    • deprovisioning: De-provisioning
      • \n
    • deprovision-fail: De-provisioning Failure
      • \n
    \n
    • \n
  • ip_address: (string)
    • \n
  • listener_port: Port that Receptor will listen for incoming connections on. (integer)
    • \n
  • peers: (field)
    • \n
  • peers_from_control_nodes: If True, control plane cluster nodes should automatically peer to it. (boolean)
    • \n
\n

Sorting

\n

To specify that instances are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_instance_groups_instances_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Instance" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Instances for an Instance Group", "tags":[ "Instance Groups" ], "x-internal-id":"api-v2-instance_groups-{id}-instances--get", "x-filename-id":"api-v2-instance_groups-id-instances-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following instance\nfields to create a new instance associated with this\ninstance group.

\n
    \n
  • \n

    hostname: (string, required)

    \n
    • \n
  • \n

    capacity_adjustment: (decimal, default=1)

    \n
    • \n
  • \n

    enabled: (boolean, default=True)

    \n
    • \n
  • managed_by_policy: (boolean, default=True)
    • \n
  • node_type: Role that this node plays in the mesh. (choice)
      \n
    • control: Control plane node
      • \n
    • execution: Execution plane node (default)
      • \n
    • hybrid: Controller and execution
      • \n
    • hop: Message-passing node, no execution capability
      • \n
    \n
    • \n
  • \n

    node_state: Indicates the current life cycle stage of this instance. (choice)

    \n
      \n
    • provisioning: Provisioning
      • \n
    • provision-fail: Provisioning Failure
      • \n
    • installed: Installed (default)
      • \n
    • ready: Ready
      • \n
    • unavailable: Unavailable
      • \n
    • deprovisioning: De-provisioning
      • \n
    • deprovision-fail: De-provisioning Failure
      • \n
    \n
    • \n
  • \n

    listener_port: Port that Receptor will listen for incoming connections on. (integer, default=None)

    \n
    • \n
  • peers: (field, default=None)
    • \n
  • peers_from_control_nodes: If True, control plane cluster nodes should automatically peer to it. (boolean, default=False)
    • \n
\n

Add Instances for an Instance Group:

\n

Make a POST request to this resource with only an id field to associate an\nexisting instance with this instance group.

\n

Remove Instances from this Instance Group:

\n

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.

", "operationId":"api_instance_groups_instances_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Instance" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Instance" } } }, "summary":"Create an Instance for an Instance Group", "tags":[ "Instance Groups" ], "x-internal-id":"api-v2-instance_groups-{id}-instances--post", "x-filename-id":"api-v2-instance_groups-id-instances-post" } }, "/api/v2/instance_groups/{id}/jobs/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nunified jobs associated with the selected\ninstance group.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each unified job data structure includes the following fields:

\n
    \n
  • id: Database ID for this unified job. (integer)
    • \n
  • type: Data type for this unified job. (choice)
    • \n
  • url: URL for this unified job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this unified job was created. (datetime)
    • \n
  • modified: Timestamp when this unified job was last modified. (datetime)
    • \n
  • name: Name of this unified job. (string)
    • \n
  • description: Optional description of this unified job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
\n

Sorting

\n

To specify that unified jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_instance_groups_jobs_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/UnifiedJobList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Unified Jobs for an Instance Group", "tags":[ "Instance Groups" ], "x-internal-id":"api-v2-instance_groups-{id}-jobs--get", "x-filename-id":"api-v2-instance_groups-id-jobs-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/instance_groups/{id}/object_roles/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nroles associated with the selected\ninstance group.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_instance_groups_object_roles_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Role" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles for an Instance Group", "tags":[ "Instance Groups" ], "x-internal-id":"api-v2-instance_groups-{id}-object_roles--get", "x-filename-id":"api-v2-instance_groups-id-object_roles-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/instances/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\ninstances.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each instance data structure includes the following fields:

\n
    \n
  • id: Database ID for this instance. (integer)
    • \n
  • hostname: (string)
    • \n
  • type: Data type for this instance. (choice)
    • \n
  • url: URL for this instance. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • uuid: (string)
    • \n
  • created: Timestamp when this instance was created. (datetime)
    • \n
  • modified: Timestamp when this instance was last modified. (datetime)
    • \n
  • last_seen: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)
    • \n
  • health_check_started: The last time a health check was initiated on this instance. (datetime)
    • \n
  • health_check_pending: (field)
    • \n
  • last_health_check: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)
    • \n
  • errors: Any error details from the last health check. (string)
    • \n
  • capacity_adjustment: (decimal)
    • \n
  • version: (string)
    • \n
  • capacity: (integer)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: Count of jobs in the running or waiting state that are targeted for this instance (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance (integer)
    • \n
  • cpu: (decimal)
    • \n
  • memory: Total system memory of this instance in bytes. (integer)
    • \n
  • cpu_capacity: (integer)
    • \n
  • mem_capacity: (integer)
    • \n
  • enabled: (boolean)
    • \n
  • managed_by_policy: (boolean)
    • \n
  • node_type: Role that this node plays in the mesh. (choice)
      \n
    • control: Control plane node
      • \n
    • execution: Execution plane node
      • \n
    • hybrid: Controller and execution
      • \n
    • hop: Message-passing node, no execution capability
      • \n
    \n
    • \n
  • node_state: Indicates the current life cycle stage of this instance. (choice)
      \n
    • provisioning: Provisioning
      • \n
    • provision-fail: Provisioning Failure
      • \n
    • installed: Installed
      • \n
    • ready: Ready
      • \n
    • unavailable: Unavailable
      • \n
    • deprovisioning: De-provisioning
      • \n
    • deprovision-fail: De-provisioning Failure
      • \n
    \n
    • \n
  • ip_address: (string)
    • \n
  • listener_port: Port that Receptor will listen for incoming connections on. (integer)
    • \n
  • peers: (field)
    • \n
  • peers_from_control_nodes: If True, control plane cluster nodes should automatically peer to it. (boolean)
    • \n
\n

Sorting

\n

To specify that instances are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_instances_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Instance" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Instances", "tags":[ "Instances" ], "x-internal-id":"api-v2-instances--get", "x-filename-id":"api-v2-instances-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following instance\nfields to create a new instance:

\n
    \n
  • \n

    hostname: (string, required)

    \n
    • \n
  • \n

    capacity_adjustment: (decimal, default=1)

    \n
    • \n
  • \n

    enabled: (boolean, default=True)

    \n
    • \n
  • managed_by_policy: (boolean, default=True)
    • \n
  • node_type: Role that this node plays in the mesh. (choice)
      \n
    • control: Control plane node
      • \n
    • execution: Execution plane node (default)
      • \n
    • hybrid: Controller and execution
      • \n
    • hop: Message-passing node, no execution capability
      • \n
    \n
    • \n
  • \n

    node_state: Indicates the current life cycle stage of this instance. (choice)

    \n
      \n
    • provisioning: Provisioning
      • \n
    • provision-fail: Provisioning Failure
      • \n
    • installed: Installed (default)
      • \n
    • ready: Ready
      • \n
    • unavailable: Unavailable
      • \n
    • deprovisioning: De-provisioning
      • \n
    • deprovision-fail: De-provisioning Failure
      • \n
    \n
    • \n
  • \n

    listener_port: Port that Receptor will listen for incoming connections on. (integer, default=None)

    \n
    • \n
  • peers: (field, default=None)
    • \n
  • peers_from_control_nodes: If True, control plane cluster nodes should automatically peer to it. (boolean, default=False)
    • \n
", "operationId":"api_instances_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Instance" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Instance" } } }, "summary":"Create an Instance", "tags":[ "Instances" ], "x-internal-id":"api-v2-instances--post", "x-filename-id":"api-v2-instances-post" } }, "/api/v2/instances/{id}/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single instance\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this instance. (integer)
    • \n
  • hostname: (string)
    • \n
  • type: Data type for this instance. (choice)
    • \n
  • url: URL for this instance. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • uuid: (string)
    • \n
  • created: Timestamp when this instance was created. (datetime)
    • \n
  • modified: Timestamp when this instance was last modified. (datetime)
    • \n
  • last_seen: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)
    • \n
  • health_check_started: The last time a health check was initiated on this instance. (datetime)
    • \n
  • health_check_pending: (field)
    • \n
  • last_health_check: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)
    • \n
  • errors: Any error details from the last health check. (string)
    • \n
  • capacity_adjustment: (decimal)
    • \n
  • version: (string)
    • \n
  • capacity: (integer)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: Count of jobs in the running or waiting state that are targeted for this instance (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance (integer)
    • \n
  • cpu: (decimal)
    • \n
  • memory: Total system memory of this instance in bytes. (integer)
    • \n
  • cpu_capacity: (integer)
    • \n
  • mem_capacity: (integer)
    • \n
  • enabled: (boolean)
    • \n
  • managed_by_policy: (boolean)
    • \n
  • node_type: Role that this node plays in the mesh. (choice)
      \n
    • control: Control plane node
      • \n
    • execution: Execution plane node
      • \n
    • hybrid: Controller and execution
      • \n
    • hop: Message-passing node, no execution capability
      • \n
    \n
    • \n
  • node_state: Indicates the current life cycle stage of this instance. (choice)
      \n
    • provisioning: Provisioning
      • \n
    • provision-fail: Provisioning Failure
      • \n
    • installed: Installed
      • \n
    • ready: Ready
      • \n
    • unavailable: Unavailable
      • \n
    • deprovisioning: De-provisioning
      • \n
    • deprovision-fail: De-provisioning Failure
      • \n
    \n
    • \n
  • ip_address: (string)
    • \n
  • listener_port: Port that Receptor will listen for incoming connections on. (integer)
    • \n
  • peers: (field)
    • \n
  • peers_from_control_nodes: If True, control plane cluster nodes should automatically peer to it. (boolean)
    • \n
", "operationId":"api_instances_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Instance" } } }, "summary":"Retrieve an Instance", "tags":[ "Instances" ], "x-internal-id":"api-v2-instances-{id}--get", "x-filename-id":"api-v2-instances-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\ninstance. The following fields may be modified:

\n
    \n
  • \n

    hostname: (string, required)

    \n
    • \n
  • \n

    capacity_adjustment: (decimal, default=1)

    \n
    • \n
  • \n

    enabled: (boolean, default=True)

    \n
    • \n
  • managed_by_policy: (boolean, default=True)
    • \n
  • node_type: Role that this node plays in the mesh. (choice)
      \n
    • control: Control plane node
      • \n
    • execution: Execution plane node (default)
      • \n
    • hybrid: Controller and execution
      • \n
    • hop: Message-passing node, no execution capability
      • \n
    \n
    • \n
  • \n

    node_state: Indicates the current life cycle stage of this instance. (choice)

    \n
      \n
    • provisioning: Provisioning
      • \n
    • provision-fail: Provisioning Failure
      • \n
    • installed: Installed (default)
      • \n
    • ready: Ready
      • \n
    • unavailable: Unavailable
      • \n
    • deprovisioning: De-provisioning
      • \n
    • deprovision-fail: De-provisioning Failure
      • \n
    \n
    • \n
  • \n

    listener_port: Port that Receptor will listen for incoming connections on. (integer, default=None)

    \n
    • \n
  • peers: (field, default=None)
    • \n
  • peers_from_control_nodes: If True, control plane cluster nodes should automatically peer to it. (boolean, default=False)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_instances_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Instance" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Instance" } } }, "summary":"Update an Instance", "tags":[ "Instances" ], "x-internal-id":"api-v2-instances-{id}--patch", "x-filename-id":"api-v2-instances-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\ninstance. The following fields may be modified:

\n
    \n
  • \n

    hostname: (string, required)

    \n
    • \n
  • \n

    capacity_adjustment: (decimal, default=1)

    \n
    • \n
  • \n

    enabled: (boolean, default=True)

    \n
    • \n
  • managed_by_policy: (boolean, default=True)
    • \n
  • node_type: Role that this node plays in the mesh. (choice)
      \n
    • control: Control plane node
      • \n
    • execution: Execution plane node (default)
      • \n
    • hybrid: Controller and execution
      • \n
    • hop: Message-passing node, no execution capability
      • \n
    \n
    • \n
  • \n

    node_state: Indicates the current life cycle stage of this instance. (choice)

    \n
      \n
    • provisioning: Provisioning
      • \n
    • provision-fail: Provisioning Failure
      • \n
    • installed: Installed (default)
      • \n
    • ready: Ready
      • \n
    • unavailable: Unavailable
      • \n
    • deprovisioning: De-provisioning
      • \n
    • deprovision-fail: De-provisioning Failure
      • \n
    \n
    • \n
  • \n

    listener_port: Port that Receptor will listen for incoming connections on. (integer, default=None)

    \n
    • \n
  • peers: (field, default=None)
    • \n
  • peers_from_control_nodes: If True, control plane cluster nodes should automatically peer to it. (boolean, default=False)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_instances_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Instance" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Instance" } } }, "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}/health_check/":{ "get":{ "description":"

Health checks are used to obtain important data about an instance.\nInstance fields affected by the health check are shown in this view.\nFundamentally, health checks require running code on the machine in question.

\n
    \n
  • For instances with node_type of \"control\" or \"hybrid\", health checks are\nperformed as part of a periodic task that runs in the background.
    • \n
  • For instances with node_type of \"execution\", health checks are done by submitting\na work unit through the receptor mesh.
    • \n
\n

If ran through the receptor mesh, the invoked command is:

\n
ansible-runner worker --worker-info\n
\n

For execution nodes, these checks are not performed on a regular basis.\nHealth checks against functional nodes will be ran when the node is first discovered.\nHealth checks against nodes with errors will be repeated at a reduced frequency.

", "operationId":"api_instances_health_check_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InstanceHealthCheck" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"Health Check Data", "tags":[ "Instances" ], "x-internal-id":"api-v2-instances-{id}-health_check--get", "x-filename-id":"api-v2-instances-id-health_check-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Manually Initiate a Health Check

\n

For purposes of error remediation or debugging, a health check can be\nmanually initiated by making a POST request to this endpoint.

\n

This will submit the work unit to the target node through the receptor mesh and wait for it to finish.\nThe model will be updated with the result.\nUp-to-date values of the fields will be returned in the response data.

", "operationId":"api_instances_health_check_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InstanceHealthCheck" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InstanceHealthCheck" } } }, "tags":[ "Instances" ], "summary":"Instances Health Check Create", "x-internal-id":"api-v2-instances-{id}-health_check--post", "x-filename-id":"api-v2-instances-id-health_check-post" } }, "/api/v2/instances/{id}/install_bundle/":{ "get":{ "description":"", "operationId":"api_instances_install_bundle_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Instance" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "tags":[ "Instances" ], "summary":"Instances Install Bundle List", "x-internal-id":"api-v2-instances-{id}-install_bundle--get", "x-filename-id":"api-v2-instances-id-install_bundle-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each instance group data structure includes the following fields:

\n
    \n
  • id: Database ID for this instance group. (integer)
    • \n
  • type: Data type for this instance group. (choice)
    • \n
  • url: URL for this instance group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • name: Name of this instance group. (string)
    • \n
  • created: Timestamp when this instance group was created. (datetime)
    • \n
  • modified: Timestamp when this instance group was last modified. (datetime)
    • \n
  • capacity: (field)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: (field)
    • \n
  • max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance group (integer)
    • \n
  • instances: (field)
    • \n
  • is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)
    • \n
  • credential: (id)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json)
    • \n
  • pod_spec_override: (string)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
\n

Sorting

\n

To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_instances_instance_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InstanceGroup" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Instance Groups for an Instance", "tags":[ "Instances" ], "x-internal-id":"api-v2-instances-{id}-instance_groups--get", "x-filename-id":"api-v2-instances-id-instance_groups-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following instance group\nfields to create a new instance group associated with this\ninstance.

\n
    \n
  • \n

    name: Name of this instance group. (string, required)

    \n
    • \n
  • \n

    max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)

    \n
    • \n
  • credential: (id, default=``)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)
    • \n
  • pod_spec_override: (string, default=\"\")
    • \n
\n

Add Instance Groups for an Instance:

\n

Make a POST request to this resource with only an id field to associate an\nexisting instance group with this instance.

\n

Remove Instance Groups from this Instance:

\n

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.

", "operationId":"api_instances_instance_groups_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InstanceGroup" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InstanceGroup" } } }, "summary":"Create an Instance Group for an Instance", "tags":[ "Instances" ], "x-internal-id":"api-v2-instances-{id}-instance_groups--post", "x-filename-id":"api-v2-instances-id-instance_groups-post" } }, "/api/v2/instances/{id}/jobs/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nunified jobs associated with the selected\ninstance.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each unified job data structure includes the following fields:

\n
    \n
  • id: Database ID for this unified job. (integer)
    • \n
  • type: Data type for this unified job. (choice)
    • \n
  • url: URL for this unified job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this unified job was created. (datetime)
    • \n
  • modified: Timestamp when this unified job was last modified. (datetime)
    • \n
  • name: Name of this unified job. (string)
    • \n
  • description: Optional description of this unified job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
\n

Sorting

\n

To specify that unified jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_instances_jobs_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/UnifiedJobList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Unified Jobs for an Instance", "tags":[ "Instances" ], "x-internal-id":"api-v2-instances-{id}-jobs--get", "x-filename-id":"api-v2-instances-id-jobs-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/instances/{id}/peers/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninstances associated with the selected\ninstance.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each instance data structure includes the following fields:

\n
    \n
  • id: Database ID for this instance. (integer)
    • \n
  • hostname: (string)
    • \n
  • type: Data type for this instance. (choice)
    • \n
  • url: URL for this instance. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • uuid: (string)
    • \n
  • created: Timestamp when this instance was created. (datetime)
    • \n
  • modified: Timestamp when this instance was last modified. (datetime)
    • \n
  • last_seen: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)
    • \n
  • health_check_started: The last time a health check was initiated on this instance. (datetime)
    • \n
  • health_check_pending: (field)
    • \n
  • last_health_check: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)
    • \n
  • errors: Any error details from the last health check. (string)
    • \n
  • capacity_adjustment: (decimal)
    • \n
  • version: (string)
    • \n
  • capacity: (integer)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: Count of jobs in the running or waiting state that are targeted for this instance (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance (integer)
    • \n
  • cpu: (decimal)
    • \n
  • memory: Total system memory of this instance in bytes. (integer)
    • \n
  • cpu_capacity: (integer)
    • \n
  • mem_capacity: (integer)
    • \n
  • enabled: (boolean)
    • \n
  • managed_by_policy: (boolean)
    • \n
  • node_type: Role that this node plays in the mesh. (choice)
      \n
    • control: Control plane node
      • \n
    • execution: Execution plane node
      • \n
    • hybrid: Controller and execution
      • \n
    • hop: Message-passing node, no execution capability
      • \n
    \n
    • \n
  • node_state: Indicates the current life cycle stage of this instance. (choice)
      \n
    • provisioning: Provisioning
      • \n
    • provision-fail: Provisioning Failure
      • \n
    • installed: Installed
      • \n
    • ready: Ready
      • \n
    • unavailable: Unavailable
      • \n
    • deprovisioning: De-provisioning
      • \n
    • deprovision-fail: De-provisioning Failure
      • \n
    \n
    • \n
  • ip_address: (string)
    • \n
  • listener_port: Port that Receptor will listen for incoming connections on. (integer)
    • \n
  • peers: (field)
    • \n
  • peers_from_control_nodes: If True, control plane cluster nodes should automatically peer to it. (boolean)
    • \n
\n

Sorting

\n

To specify that instances are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_instances_peers_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Instance" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Instances for an Instance", "tags":[ "Instances" ], "x-internal-id":"api-v2-instances-{id}-peers--get", "x-filename-id":"api-v2-instances-id-peers-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventories/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\ninventories.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory. (integer)
    • \n
  • type: Data type for this inventory. (choice)
    • \n
  • url: URL for this inventory. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory was created. (datetime)
    • \n
  • modified: Timestamp when this inventory was last modified. (datetime)
    • \n
  • name: Name of this inventory. (string)
    • \n
  • description: Optional description of this inventory. (string)
    • \n
  • organization: Organization containing this inventory. (id)
    • \n
  • kind: Kind of inventory being represented. (choice)
      \n
    • \"\": Hosts have a direct link to this inventory.
      • \n
    • smart: Hosts for inventory generated using the host_filter property.
      • \n
    • constructed: Parse list of source inventories with the constructed inventory plugin.
      • \n
    \n
    • \n
  • host_filter: Filter that will be applied to the hosts of this inventory. (string)
    • \n
  • variables: Inventory variables in JSON or YAML format. (json)
    • \n
  • 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)
    • \n
  • total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)
    • \n
  • inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)
    • \n
  • pending_deletion: Flag indicating the inventory is being deleted. (boolean)
    • \n
  • prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)
    • \n
\n

Sorting

\n

To specify that inventories are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Inventory" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventories", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories--get", "x-filename-id":"api-v2-inventories-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following inventory\nfields to create a new inventory:

\n
    \n
  • name: Name of this inventory. (string, required)
    • \n
  • description: Optional description of this inventory. (string, default=\"\")
    • \n
  • organization: Organization containing this inventory. (id, required)
    • \n
  • kind: Kind of inventory being represented. (choice)
      \n
    • \"\": Hosts have a direct link to this inventory. (default)
      • \n
    • smart: Hosts for inventory generated using the host_filter property.
      • \n
    • constructed: Parse list of source inventories with the constructed inventory plugin.
      • \n
    \n
    • \n
  • host_filter: Filter that will be applied to the hosts of this inventory. (string, default=\"\")
    • \n
  • \n

    variables: Inventory variables in JSON or YAML format. (json, default=``)

    \n
    • \n
  • \n

    prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)

    \n
    • \n
", "operationId":"api_inventories_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Inventory" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Inventory" } } }, "summary":"Create an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories--post", "x-filename-id":"api-v2-inventories-post" } }, "/api/v2/inventories/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this inventory.

", "operationId":"api_inventories_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this inventory. (integer)
    • \n
  • type: Data type for this inventory. (choice)
    • \n
  • url: URL for this inventory. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory was created. (datetime)
    • \n
  • modified: Timestamp when this inventory was last modified. (datetime)
    • \n
  • name: Name of this inventory. (string)
    • \n
  • description: Optional description of this inventory. (string)
    • \n
  • organization: Organization containing this inventory. (id)
    • \n
  • kind: Kind of inventory being represented. (choice)
      \n
    • \"\": Hosts have a direct link to this inventory.
      • \n
    • smart: Hosts for inventory generated using the host_filter property.
      • \n
    • constructed: Parse list of source inventories with the constructed inventory plugin.
      • \n
    \n
    • \n
  • host_filter: Filter that will be applied to the hosts of this inventory. (string)
    • \n
  • variables: Inventory variables in JSON or YAML format. (json)
    • \n
  • 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)
    • \n
  • total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)
    • \n
  • inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)
    • \n
  • pending_deletion: Flag indicating the inventory is being deleted. (boolean)
    • \n
  • prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)
    • \n
", "operationId":"api_inventories_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Inventory" } } }, "summary":"Retrieve an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}--get", "x-filename-id":"api-v2-inventories-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:

\n
    \n
  • name: Name of this inventory. (string, required)
    • \n
  • description: Optional description of this inventory. (string, default=\"\")
    • \n
  • organization: Organization containing this inventory. (id, required)
    • \n
  • kind: Kind of inventory being represented. (choice)
      \n
    • \"\": Hosts have a direct link to this inventory. (default)
      • \n
    • smart: Hosts for inventory generated using the host_filter property.
      • \n
    • constructed: Parse list of source inventories with the constructed inventory plugin.
      • \n
    \n
    • \n
  • host_filter: Filter that will be applied to the hosts of this inventory. (string, default=\"\")
    • \n
  • \n

    variables: Inventory variables in JSON or YAML format. (json, default=``)

    \n
    • \n
  • \n

    prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)

    \n
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_inventories_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Inventory" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Inventory" } } }, "summary":"Update an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}--patch", "x-filename-id":"api-v2-inventories-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:

\n
    \n
  • name: Name of this inventory. (string, required)
    • \n
  • description: Optional description of this inventory. (string, default=\"\")
    • \n
  • organization: Organization containing this inventory. (id, required)
    • \n
  • kind: Kind of inventory being represented. (choice)
      \n
    • \"\": Hosts have a direct link to this inventory. (default)
      • \n
    • smart: Hosts for inventory generated using the host_filter property.
      • \n
    • constructed: Parse list of source inventories with the constructed inventory plugin.
      • \n
    \n
    • \n
  • host_filter: Filter that will be applied to the hosts of this inventory. (string, default=\"\")
    • \n
  • \n

    variables: Inventory variables in JSON or YAML format. (json, default=``)

    \n
    • \n
  • \n

    prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)

    \n
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_inventories_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Inventory" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Inventory" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_access_list_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ResourceAccessListElement" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-access_list--get", "x-filename-id":"api-v2-inventories-id-access_list-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventories/{id}/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ninventory.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-activity_stream--get", "x-filename-id":"api-v2-inventories-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventories/{id}/ad_hoc_commands/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\ninventory.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each ad hoc command data structure includes the following fields:

\n
    \n
  • id: Database ID for this ad hoc command. (integer)
    • \n
  • type: Data type for this ad hoc command. (choice)
    • \n
  • url: URL for this ad hoc command. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this ad hoc command was created. (datetime)
    • \n
  • modified: Timestamp when this ad hoc command was last modified. (datetime)
    • \n
  • name: Name of this ad hoc command. (string)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id)
    • \n
  • limit: (string)
    • \n
  • credential: (id)
    • \n
  • module_name: (choice)
      \n
    • command
      • \n
    • shell
      • \n
    • yum
      • \n
    • apt
      • \n
    • apt_key
      • \n
    • apt_repository
      • \n
    • apt_rpm
      • \n
    • service
      • \n
    • group
      • \n
    • user
      • \n
    • mount
      • \n
    • ping
      • \n
    • selinux
      • \n
    • setup
      • \n
    • win_ping
      • \n
    • win_service
      • \n
    • win_updates
      • \n
    • win_group
      • \n
    • win_user
      • \n
    \n
    • \n
  • module_args: (string)
    • \n
  • forks: (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (string)
    • \n
  • become_enabled: (boolean)
    • \n
  • diff_mode: (boolean)
    • \n
\n

Sorting

\n

To specify that ad hoc commands are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_ad_hoc_commands_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/AdHocCommandList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Ad Hoc Commands for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-ad_hoc_commands--get", "x-filename-id":"api-v2-inventories-id-ad_hoc_commands-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following ad hoc command\nfields to create a new ad hoc command associated with this\ninventory.

\n
    \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • \n

    job_type: (choice)

    \n
      \n
    • run: Run (default)
      • \n
    • check: Check
      • \n
    \n
    • \n
  • \n

    limit: (string, default=\"\")

    \n
    • \n
  • credential: (id, default=``)
    • \n
  • module_name: (choice)
      \n
    • command (default)
      • \n
    • shell
      • \n
    • yum
      • \n
    • apt
      • \n
    • apt_key
      • \n
    • apt_repository
      • \n
    • apt_rpm
      • \n
    • service
      • \n
    • group
      • \n
    • user
      • \n
    • mount
      • \n
    • ping
      • \n
    • selinux
      • \n
    • setup
      • \n
    • win_ping
      • \n
    • win_service
      • \n
    • win_updates
      • \n
    • win_group
      • \n
    • win_user
      • \n
    \n
    • \n
  • module_args: (string, default=\"\")
    • \n
  • forks: (integer, default=0)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal) (default)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (string, default=\"\")
    • \n
  • become_enabled: (boolean, default=False)
    • \n
  • diff_mode: (boolean, default=False)
    • \n
", "operationId":"api_inventories_ad_hoc_commands_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/AdHocCommandList" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/AdHocCommandList" } } }, "summary":"Create an Ad Hoc Command for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-ad_hoc_commands--post", "x-filename-id":"api-v2-inventories-id-ad_hoc_commands-post" } }, "/api/v2/inventories/{id}/copy/":{ "get":{ "description":"", "operationId":"api_inventories_copy_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Copy" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "tags":[ "Inventories" ], "summary":"Inventories Copy List", "x-internal-id":"api-v2-inventories-{id}-copy--get", "x-filename-id":"api-v2-inventories-id-copy-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_inventories_copy_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Copy" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Copy" } } }, "tags":[ "Inventories" ], "summary":"Inventories Copy Create", "x-internal-id":"api-v2-inventories-{id}-copy--post", "x-filename-id":"api-v2-inventories-id-copy-post" } }, "/api/v2/inventories/{id}/groups/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ninventory.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each group data structure includes the following fields:

\n
    \n
  • id: Database ID for this group. (integer)
    • \n
  • type: Data type for this group. (choice)
    • \n
  • url: URL for this group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this group was created. (datetime)
    • \n
  • modified: Timestamp when this group was last modified. (datetime)
    • \n
  • name: Name of this group. (string)
    • \n
  • description: Optional description of this group. (string)
    • \n
  • inventory: (id)
    • \n
  • variables: Group variables in JSON or YAML format. (json)
    • \n
\n

Sorting

\n

To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Group" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Groups for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-groups--get", "x-filename-id":"api-v2-inventories-id-groups-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following group\nfields to create a new group associated with this\ninventory.

\n
    \n
  • name: Name of this group. (string, required)
    • \n
  • \n

    description: Optional description of this group. (string, default=\"\")

    \n
    • \n
  • \n

    variables: Group variables in JSON or YAML format. (json, default=``)

    \n
    • \n
\n

Remove Inventory Groups:

\n

Make a POST request to this resource with id and disassociate fields to\ndelete the associated group.

\n
{\n    \"id\": 123,\n    \"disassociate\": true\n}\n
", "operationId":"api_inventories_groups_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Group" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Group" } } }, "summary":"Create a Group for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-groups--post", "x-filename-id":"api-v2-inventories-id-groups-post" } }, "/api/v2/inventories/{id}/hosts/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ninventory.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each host data structure includes the following fields:

\n
    \n
  • id: Database ID for this host. (integer)
    • \n
  • type: Data type for this host. (choice)
    • \n
  • url: URL for this host. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this host was created. (datetime)
    • \n
  • modified: Timestamp when this host was last modified. (datetime)
    • \n
  • name: Name of this host. (string)
    • \n
  • description: Optional description of this host. (string)
    • \n
  • inventory: (id)
    • \n
  • enabled: Is this host online and available for running jobs? (boolean)
    • \n
  • instance_id: The value used by the remote inventory source to uniquely identify the host (string)
    • \n
  • variables: Host variables in JSON or YAML format. (json)
    • \n
  • has_active_failures: (field)
    • \n
  • has_inventory_sources: (field)
    • \n
  • last_job: (id)
    • \n
  • last_job_host_summary: (id)
    • \n
  • ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)
    • \n
\n

Sorting

\n

To specify that hosts are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_hosts_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Host" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Hosts for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-hosts--get", "x-filename-id":"api-v2-inventories-id-hosts-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following host\nfields to create a new host associated with this\ninventory.

\n
    \n
  • name: Name of this host. (string, required)
    • \n
  • \n

    description: Optional description of this host. (string, default=\"\")

    \n
    • \n
  • \n

    enabled: Is this host online and available for running jobs? (boolean, default=True)

    \n
    • \n
  • instance_id: The value used by the remote inventory source to uniquely identify the host (string, default=\"\")
    • \n
  • variables: Host variables in JSON or YAML format. (json, default=``)
    • \n
\n

Remove Inventory Hosts:

\n

Make a POST request to this resource with id and disassociate fields to\ndelete the associated host.

\n
{\n    \"id\": 123,\n    \"disassociate\": true\n}\n
", "operationId":"api_inventories_hosts_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Host" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Host" } } }, "summary":"Create a Host for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-hosts--post", "x-filename-id":"api-v2-inventories-id-hosts-post" } }, "/api/v2/inventories/{id}/input_inventories/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninventories associated with the selected\ninventory.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory. (integer)
    • \n
  • type: Data type for this inventory. (choice)
    • \n
  • url: URL for this inventory. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory was created. (datetime)
    • \n
  • modified: Timestamp when this inventory was last modified. (datetime)
    • \n
  • name: Name of this inventory. (string)
    • \n
  • description: Optional description of this inventory. (string)
    • \n
  • organization: Organization containing this inventory. (id)
    • \n
  • kind: Kind of inventory being represented. (choice)
      \n
    • \"\": Hosts have a direct link to this inventory.
      • \n
    • smart: Hosts for inventory generated using the host_filter property.
      • \n
    • constructed: Parse list of source inventories with the constructed inventory plugin.
      • \n
    \n
    • \n
  • host_filter: Filter that will be applied to the hosts of this inventory. (string)
    • \n
  • variables: Inventory variables in JSON or YAML format. (json)
    • \n
  • 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)
    • \n
  • total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)
    • \n
  • inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)
    • \n
  • pending_deletion: Flag indicating the inventory is being deleted. (boolean)
    • \n
  • prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)
    • \n
\n

Sorting

\n

To specify that inventories are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_input_inventories_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Inventory" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventories for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-input_inventories--get", "x-filename-id":"api-v2-inventories-id-input_inventories-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following inventory\nfields to create a new inventory associated with this\ninventory.

\n
    \n
  • name: Name of this inventory. (string, required)
    • \n
  • description: Optional description of this inventory. (string, default=\"\")
    • \n
  • organization: Organization containing this inventory. (id, required)
    • \n
  • kind: Kind of inventory being represented. (choice)
      \n
    • \"\": Hosts have a direct link to this inventory. (default)
      • \n
    • smart: Hosts for inventory generated using the host_filter property.
      • \n
    • constructed: Parse list of source inventories with the constructed inventory plugin.
      • \n
    \n
    • \n
  • host_filter: Filter that will be applied to the hosts of this inventory. (string, default=\"\")
    • \n
  • \n

    variables: Inventory variables in JSON or YAML format. (json, default=``)

    \n
    • \n
  • \n

    prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)

    \n
    • \n
\n

Add Inventories for an Inventory:

\n

Make a POST request to this resource with only an id field to associate an\nexisting inventory with this inventory.

\n

Remove Inventories from this Inventory:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the inventory from this inventory\n without deleting the inventory.

", "operationId":"api_inventories_input_inventories_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Inventory" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Inventory" } } }, "summary":"Create an Inventory for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-input_inventories--post", "x-filename-id":"api-v2-inventories-id-input_inventories-post" } }, "/api/v2/inventories/{id}/instance_groups/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\ninventory.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each instance group data structure includes the following fields:

\n
    \n
  • id: Database ID for this instance group. (integer)
    • \n
  • type: Data type for this instance group. (choice)
    • \n
  • url: URL for this instance group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • name: Name of this instance group. (string)
    • \n
  • created: Timestamp when this instance group was created. (datetime)
    • \n
  • modified: Timestamp when this instance group was last modified. (datetime)
    • \n
  • capacity: (field)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: (field)
    • \n
  • max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance group (integer)
    • \n
  • instances: (field)
    • \n
  • is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)
    • \n
  • credential: (id)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json)
    • \n
  • pod_spec_override: (string)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
\n

Sorting

\n

To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_instance_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InstanceGroup" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Instance Groups for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-instance_groups--get", "x-filename-id":"api-v2-inventories-id-instance_groups-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following instance group\nfields to create a new instance group associated with this\ninventory.

\n
    \n
  • \n

    name: Name of this instance group. (string, required)

    \n
    • \n
  • \n

    max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)

    \n
    • \n
  • credential: (id, default=``)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)
    • \n
  • pod_spec_override: (string, default=\"\")
    • \n
\n

Add Instance Groups for an Inventory:

\n

Make a POST request to this resource with only an id field to associate an\nexisting instance group with this inventory.

\n

Remove Instance Groups from this Inventory:

\n

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.

", "operationId":"api_inventories_instance_groups_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InstanceGroup" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InstanceGroup" } } }, "summary":"Create an Instance Group for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-instance_groups--post", "x-filename-id":"api-v2-inventories-id-instance_groups-post" } }, "/api/v2/inventories/{id}/inventory_sources/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\ninventory.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory source data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory source. (integer)
    • \n
  • type: Data type for this inventory source. (choice)
    • \n
  • url: URL for this inventory source. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory source was created. (datetime)
    • \n
  • modified: Timestamp when this inventory source was last modified. (datetime)
    • \n
  • name: Name of this inventory source. (string)
    • \n
  • description: Optional description of this inventory source. (string)
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string)
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string)
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)
    • \n
  • credential: Cloud credential to use for inventory updates. (integer)
    • \n
  • 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)
    • \n
  • 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. If the key is not found then the host will be enabled (string)
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)
    • \n
  • overwrite_vars: Overwrite local variables from remote inventory source. (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • limit: Enter host, group or pattern match (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • none: No External Source
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • inventory: (id)
    • \n
  • update_on_launch: (boolean)
    • \n
  • update_cache_timeout: (integer)
    • \n
  • source_project: Project containing inventory file used as source. (id)
    • \n
  • last_update_failed: (boolean)
    • \n
  • last_updated: (datetime)
    • \n
\n

Sorting

\n

To specify that inventory sources are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_inventory_sources_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InventorySource" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventory Sources for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-inventory_sources--get", "x-filename-id":"api-v2-inventories-id-inventory_sources-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following inventory source\nfields to create a new inventory source associated with this\ninventory.

\n
    \n
  • name: Name of this inventory source. (string, required)
    • \n
  • description: Optional description of this inventory source. (string, default=\"\")
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string, default=\"\")
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string, default=\"\")
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=\"\")
    • \n
  • credential: Cloud credential to use for inventory updates. (integer, default=None)
    • \n
  • 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=\"\")
    • \n
  • 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. If the key is not found then the host will be enabled (string, default=\"\")
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=\"\")
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean, default=False)
    • \n
  • \n

    overwrite_vars: Overwrite local variables from remote inventory source. (boolean, default=False)

    \n
    • \n
  • \n

    timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)

    \n
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO) (default)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • \n

    limit: Enter host, group or pattern match (string, default=\"\")

    \n
    • \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • \n

    update_on_launch: (boolean, default=False)

    \n
    • \n
  • update_cache_timeout: (integer, default=0)
    • \n
  • source_project: Project containing inventory file used as source. (id, default=``)
    • \n
", "operationId":"api_inventories_inventory_sources_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InventorySource" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InventorySource" } } }, "summary":"Create an Inventory Source for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-inventory_sources--post", "x-filename-id":"api-v2-inventories-id-inventory_sources-post" } }, "/api/v2/inventories/{id}/job_templates/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\njob templates associated with the selected\ninventory.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each job template data structure includes the following fields:

\n
    \n
  • id: Database ID for this job template. (integer)
    • \n
  • type: Data type for this job template. (choice)
    • \n
  • url: URL for this job template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job template was created. (datetime)
    • \n
  • modified: Timestamp when this job template was last modified. (datetime)
    • \n
  • name: Name of this job template. (string)
    • \n
  • description: Optional description of this job template. (string)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id)
    • \n
  • project: (id)
    • \n
  • playbook: (string)
    • \n
  • 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)
    • \n
  • forks: (integer)
    • \n
  • limit: (string)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (json)
    • \n
  • job_tags: (string)
    • \n
  • force_handlers: (boolean)
    • \n
  • skip_tags: (string)
    • \n
  • start_at_task: (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • use_fact_cache: If enabled, the service 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)
    • \n
  • organization: The organization used to determine access to this template. (id)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • host_config_key: (string)
    • \n
  • ask_scm_branch_on_launch: (boolean)
    • \n
  • ask_diff_mode_on_launch: (boolean)
    • \n
  • ask_variables_on_launch: (boolean)
    • \n
  • ask_limit_on_launch: (boolean)
    • \n
  • ask_tags_on_launch: (boolean)
    • \n
  • ask_skip_tags_on_launch: (boolean)
    • \n
  • ask_job_type_on_launch: (boolean)
    • \n
  • ask_verbosity_on_launch: (boolean)
    • \n
  • ask_inventory_on_launch: (boolean)
    • \n
  • ask_credential_on_launch: (boolean)
    • \n
  • ask_execution_environment_on_launch: (boolean)
    • \n
  • ask_labels_on_launch: (boolean)
    • \n
  • ask_forks_on_launch: (boolean)
    • \n
  • ask_job_slice_count_on_launch: (boolean)
    • \n
  • ask_timeout_on_launch: (boolean)
    • \n
  • ask_instance_groups_on_launch: (boolean)
    • \n
  • survey_enabled: (boolean)
    • \n
  • become_enabled: (boolean)
    • \n
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • 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)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • prevent_instance_group_fallback: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)
    • \n
\n

Sorting

\n

To specify that job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_job_templates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/JobTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Job Templates for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-job_templates--get", "x-filename-id":"api-v2-inventories-id-job_templates-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventories/{id}/labels/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\ninventory.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each label data structure includes the following fields:

\n
    \n
  • id: Database ID for this label. (integer)
    • \n
  • type: Data type for this label. (choice)
    • \n
  • url: URL for this label. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this label was created. (datetime)
    • \n
  • modified: Timestamp when this label was last modified. (datetime)
    • \n
  • name: Name of this label. (string)
    • \n
  • organization: Organization this label belongs to. (id)
    • \n
\n

Sorting

\n

To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_labels_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Label" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Labels for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-labels--get", "x-filename-id":"api-v2-inventories-id-labels-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following label\nfields to create a new label associated with this\ninventory.

\n
    \n
  • name: Name of this label. (string, required)
    • \n
  • organization: Organization this label belongs to. (id, required)
    • \n
\n

Add Labels for an Inventory:

\n

Make a POST request to this resource with only an id field to associate an\nexisting label with this inventory.

\n

Remove Labels from this Inventory:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the label from this inventory\n.

", "operationId":"api_inventories_labels_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Label" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Label" } } }, "summary":"Create a Label for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-labels--post", "x-filename-id":"api-v2-inventories-id-labels-post" } }, "/api/v2/inventories/{id}/object_roles/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nroles associated with the selected\ninventory.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_object_roles_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Role" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-object_roles--get", "x-filename-id":"api-v2-inventories-id-object_roles-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventories/{id}/root_groups/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of root (top-level)\ngroups associated with this\ninventory.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each group data structure includes the following fields:

\n
    \n
  • id: Database ID for this group. (integer)
    • \n
  • type: Data type for this group. (choice)
    • \n
  • url: URL for this group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this group was created. (datetime)
    • \n
  • modified: Timestamp when this group was last modified. (datetime)
    • \n
  • name: Name of this group. (string)
    • \n
  • description: Optional description of this group. (string)
    • \n
  • inventory: (id)
    • \n
  • variables: Group variables in JSON or YAML format. (json)
    • \n
\n

Sorting

\n

To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventories_root_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Group" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Root Groups for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-root_groups--get", "x-filename-id":"api-v2-inventories-id-root_groups-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_inventories_root_groups_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Group" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Group" } } }, "tags":[ "Inventories" ], "summary":"Inventories Root Groups Create", "x-internal-id":"api-v2-inventories-{id}-root_groups--post", "x-filename-id":"api-v2-inventories-id-root_groups-post" } }, "/api/v2/inventories/{id}/script/":{ "get":{ "description":"

Refer to Dynamic Inventory\nfor more information on inventory scripts.

\n

List Response

\n

Make 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.

\n

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.

\n

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.

\n

Specify a query string of ?towervars=1 to add variables\nto the hostvars of each host that specifies its enabled state and database ID.

\n

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.

\n

To apply multiple query strings, join them with the & character, like ?hostvars=1&all=1.

\n

Host Response

\n

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.

", "operationId":"api_inventories_script_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InventoryScript" } } }, "summary":"Generate Inventory Group and Host Data as Needed for an Inventory Script.", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-script--get", "x-filename-id":"api-v2-inventories-id-script-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventories/{id}/tree/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a hierarchical view of groups\nassociated with the selected inventory.

\n

The resulting data structure contains a list of root groups, with each group\nalso containing a list of its children.

\n

Results

\n

Each group data structure includes the following fields:

\n
    \n
  • id: Database ID for this group. (integer)
    • \n
  • type: Data type for this group. (choice)
    • \n
  • url: URL for this group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this group was created. (datetime)
    • \n
  • modified: Timestamp when this group was last modified. (datetime)
    • \n
  • name: Name of this group. (string)
    • \n
  • description: Optional description of this group. (string)
    • \n
  • inventory: (id)
    • \n
  • variables: Group variables in JSON or YAML format. (json)
    • \n
  • children: (field)
    • \n
", "operationId":"api_inventories_tree_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/GroupTree" } } }, "summary":"Group Tree for an Inventory", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-tree--get", "x-filename-id":"api-v2-inventories-id-tree-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventories/{id}/update_inventory_sources/":{ "get":{ "description":"

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:

\n
    \n
  • inventory_source: ID of the inventory_source\n (integer, read-only)
    • \n
  • can_update: Flag indicating if this inventory source can be updated\n (boolean, read-only)
    • \n
\n

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:

\n
    \n
  • status: started or message why the update could not be started.\n (string, read-only)
    • \n
  • inventory_update: ID of the inventory update job that was started.\n (integer, read-only)
    • \n
  • project_update: ID of the project update job that was started if this inventory source is an SCM source.\n (integer, read-only, optional)
    • \n
", "operationId":"api_inventories_update_inventory_sources_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InventorySourceUpdate" } } }, "summary":"Update Inventory Sources", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-update_inventory_sources--get", "x-filename-id":"api-v2-inventories-id-update_inventory_sources-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

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:

\n
    \n
  • inventory_source: ID of the inventory_source\n (integer, read-only)
    • \n
  • can_update: Flag indicating if this inventory source can be updated\n (boolean, read-only)
    • \n
\n

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:

\n
    \n
  • status: started or message why the update could not be started.\n (string, read-only)
    • \n
  • inventory_update: ID of the inventory update job that was started.\n (integer, read-only)
    • \n
  • project_update: ID of the project update job that was started if this inventory source is an SCM source.\n (integer, read-only, optional)
    • \n
", "operationId":"api_inventories_update_inventory_sources_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InventorySourceUpdate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InventorySourceUpdate" } } }, "summary":"Update Inventory Sources", "tags":[ "Inventories" ], "x-internal-id":"api-v2-inventories-{id}-update_inventory_sources--post", "x-filename-id":"api-v2-inventories-id-update_inventory_sources-post" } }, "/api/v2/inventories/{id}/variable_data/":{ "get":{ "consumes":[ "application/json", "application/yaml" ], "description":"

Make a GET request to this resource to retrieve all variables defined for a\ninventory.

", "operationId":"api_inventories_variable_data_read", "parameters":[ ], "produces":[ "application/json", "application/yaml" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InventoryVariableData" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "consumes":[ "application/json", "application/yaml" ], "description":"

Make a PUT or PATCH request to this resource to update variables defined for a\ninventory.

", "operationId":"api_inventories_variable_data_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InventoryVariableData" } } ], "produces":[ "application/json", "application/yaml" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InventoryVariableData" } } }, "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", "application/yaml" ], "description":"

Make a PUT or PATCH request to this resource to update variables defined for a\ninventory.

", "operationId":"api_inventories_variable_data_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InventoryVariableData" } } ], "produces":[ "application/json", "application/yaml" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InventoryVariableData" } } }, "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_sources/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\ninventory sources.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory source data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory source. (integer)
    • \n
  • type: Data type for this inventory source. (choice)
    • \n
  • url: URL for this inventory source. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory source was created. (datetime)
    • \n
  • modified: Timestamp when this inventory source was last modified. (datetime)
    • \n
  • name: Name of this inventory source. (string)
    • \n
  • description: Optional description of this inventory source. (string)
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string)
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string)
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)
    • \n
  • credential: Cloud credential to use for inventory updates. (integer)
    • \n
  • 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)
    • \n
  • 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. If the key is not found then the host will be enabled (string)
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)
    • \n
  • overwrite_vars: Overwrite local variables from remote inventory source. (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • limit: Enter host, group or pattern match (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • none: No External Source
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • inventory: (id)
    • \n
  • update_on_launch: (boolean)
    • \n
  • update_cache_timeout: (integer)
    • \n
  • source_project: Project containing inventory file used as source. (id)
    • \n
  • last_update_failed: (boolean)
    • \n
  • last_updated: (datetime)
    • \n
\n

Sorting

\n

To specify that inventory sources are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_sources_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InventorySource" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventory Sources", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources--get", "x-filename-id":"api-v2-inventory_sources-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following inventory source\nfields to create a new inventory source:

\n
    \n
  • name: Name of this inventory source. (string, required)
    • \n
  • description: Optional description of this inventory source. (string, default=\"\")
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string, default=\"\")
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string, default=\"\")
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=\"\")
    • \n
  • credential: Cloud credential to use for inventory updates. (integer, default=None)
    • \n
  • 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=\"\")
    • \n
  • 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. If the key is not found then the host will be enabled (string, default=\"\")
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=\"\")
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean, default=False)
    • \n
  • \n

    overwrite_vars: Overwrite local variables from remote inventory source. (boolean, default=False)

    \n
    • \n
  • \n

    timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)

    \n
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO) (default)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • \n

    limit: Enter host, group or pattern match (string, default=\"\")

    \n
    • \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • inventory: (id, required)
    • \n
  • update_on_launch: (boolean, default=False)
    • \n
  • update_cache_timeout: (integer, default=0)
    • \n
  • source_project: Project containing inventory file used as source. (id, default=``)
    • \n
", "operationId":"api_inventory_sources_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InventorySource" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InventorySource" } } }, "summary":"Create an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources--post", "x-filename-id":"api-v2-inventory_sources-post" } }, "/api/v2/inventory_sources/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this inventory source.

", "operationId":"api_inventory_sources_delete", "parameters":[ ], "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:

\n
    \n
  • id: Database ID for this inventory source. (integer)
    • \n
  • type: Data type for this inventory source. (choice)
    • \n
  • url: URL for this inventory source. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory source was created. (datetime)
    • \n
  • modified: Timestamp when this inventory source was last modified. (datetime)
    • \n
  • name: Name of this inventory source. (string)
    • \n
  • description: Optional description of this inventory source. (string)
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string)
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string)
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)
    • \n
  • credential: Cloud credential to use for inventory updates. (integer)
    • \n
  • 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)
    • \n
  • 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. If the key is not found then the host will be enabled (string)
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)
    • \n
  • overwrite_vars: Overwrite local variables from remote inventory source. (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • limit: Enter host, group or pattern match (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • none: No External Source
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • inventory: (id)
    • \n
  • update_on_launch: (boolean)
    • \n
  • update_cache_timeout: (integer)
    • \n
  • source_project: Project containing inventory file used as source. (id)
    • \n
  • last_update_failed: (boolean)
    • \n
  • last_updated: (datetime)
    • \n
", "operationId":"api_inventory_sources_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InventorySource" } } }, "summary":"Retrieve an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}--get", "x-filename-id":"api-v2-inventory_sources-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\ninventory source. The following fields may be modified:

\n
    \n
  • name: Name of this inventory source. (string, required)
    • \n
  • description: Optional description of this inventory source. (string, default=\"\")
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string, default=\"\")
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string, default=\"\")
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=\"\")
    • \n
  • credential: Cloud credential to use for inventory updates. (integer, default=None)
    • \n
  • 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=\"\")
    • \n
  • 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. If the key is not found then the host will be enabled (string, default=\"\")
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=\"\")
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean, default=False)
    • \n
  • \n

    overwrite_vars: Overwrite local variables from remote inventory source. (boolean, default=False)

    \n
    • \n
  • \n

    timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)

    \n
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO) (default)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • \n

    limit: Enter host, group or pattern match (string, default=\"\")

    \n
    • \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • inventory: (id, required)
    • \n
  • update_on_launch: (boolean, default=False)
    • \n
  • update_cache_timeout: (integer, default=0)
    • \n
  • source_project: Project containing inventory file used as source. (id, default=``)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_inventory_sources_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InventorySource" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InventorySource" } } }, "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":{ "description":"

Make a PUT or PATCH request to this resource to update this\ninventory source. The following fields may be modified:

\n
    \n
  • name: Name of this inventory source. (string, required)
    • \n
  • description: Optional description of this inventory source. (string, default=\"\")
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string, default=\"\")
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string, default=\"\")
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=\"\")
    • \n
  • credential: Cloud credential to use for inventory updates. (integer, default=None)
    • \n
  • 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=\"\")
    • \n
  • 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. If the key is not found then the host will be enabled (string, default=\"\")
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=\"\")
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean, default=False)
    • \n
  • \n

    overwrite_vars: Overwrite local variables from remote inventory source. (boolean, default=False)

    \n
    • \n
  • \n

    timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)

    \n
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO) (default)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • \n

    limit: Enter host, group or pattern match (string, default=\"\")

    \n
    • \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • inventory: (id, required)
    • \n
  • update_on_launch: (boolean, default=False)
    • \n
  • update_cache_timeout: (integer, default=0)
    • \n
  • source_project: Project containing inventory file used as source. (id, default=``)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_inventory_sources_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InventorySource" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InventorySource" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_sources_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-activity_stream--get", "x-filename-id":"api-v2-inventory_sources-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventory_sources/{id}/credentials/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ninventory source.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • organization: (id)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_sources_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Credential" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-credentials--get", "x-filename-id":"api-v2-inventory_sources-id-credentials-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following credential\nfields to create a new credential associated with this\ninventory source.

\n
    \n
  • name: Name of this credential. (string, required)
    • \n
  • description: Optional description of this credential. (string, default=\"\")
    • \n
  • organization: (id, default=None)
    • \n
  • \n

    credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
\n

Add Credentials for an Inventory Source:

\n

Make a POST request to this resource with only an id field to associate an\nexisting credential with this inventory source.

\n

Remove Credentials from this Inventory Source:

\n

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.

", "operationId":"api_inventory_sources_credentials_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Credential" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Credential" } } }, "summary":"Create a Credential for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-credentials--post", "x-filename-id":"api-v2-inventory_sources-id-credentials-post" } }, "/api/v2/inventory_sources/{id}/groups/":{ "delete":{ "description":"

Make a POST request to this resource with the following group\nfields to create a new group associated with this\ninventory source.

\n
    \n
  • name: Name of this group. (string, required)
    • \n
  • description: Optional description of this group. (string, default=\"\")
    • \n
  • inventory: (id, required)
    • \n
  • variables: Group variables in JSON or YAML format. (json, default=``)
    • \n
\n

Delete all groups of this Inventory Source:

\n

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":"api_inventory_sources_groups_delete", "parameters":[ ], "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each group data structure includes the following fields:

\n
    \n
  • id: Database ID for this group. (integer)
    • \n
  • type: Data type for this group. (choice)
    • \n
  • url: URL for this group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this group was created. (datetime)
    • \n
  • modified: Timestamp when this group was last modified. (datetime)
    • \n
  • name: Name of this group. (string)
    • \n
  • description: Optional description of this group. (string)
    • \n
  • inventory: (id)
    • \n
  • variables: Group variables in JSON or YAML format. (json)
    • \n
\n

Sorting

\n

To specify that groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_sources_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Group" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Groups for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-groups--get", "x-filename-id":"api-v2-inventory_sources-id-groups-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventory_sources/{id}/hosts/":{ "delete":{ "description":"

Make a POST request to this resource with the following host\nfields to create a new host associated with this\ninventory source.

\n
    \n
  • name: Name of this host. (string, required)
    • \n
  • description: Optional description of this host. (string, default=\"\")
    • \n
  • inventory: (id, required)
    • \n
  • enabled: Is this host online and available for running jobs? (boolean, default=True)
    • \n
  • instance_id: The value used by the remote inventory source to uniquely identify the host (string, default=\"\")
    • \n
  • variables: Host variables in JSON or YAML format. (json, default=``)
    • \n
\n

Delete all hosts of this Inventory Source:

\n

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":"api_inventory_sources_hosts_delete", "parameters":[ ], "responses":{ "204":{ "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each host data structure includes the following fields:

\n
    \n
  • id: Database ID for this host. (integer)
    • \n
  • type: Data type for this host. (choice)
    • \n
  • url: URL for this host. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this host was created. (datetime)
    • \n
  • modified: Timestamp when this host was last modified. (datetime)
    • \n
  • name: Name of this host. (string)
    • \n
  • description: Optional description of this host. (string)
    • \n
  • inventory: (id)
    • \n
  • enabled: Is this host online and available for running jobs? (boolean)
    • \n
  • instance_id: The value used by the remote inventory source to uniquely identify the host (string)
    • \n
  • variables: Host variables in JSON or YAML format. (json)
    • \n
  • has_active_failures: (field)
    • \n
  • has_inventory_sources: (field)
    • \n
  • last_job: (id)
    • \n
  • last_job_host_summary: (id)
    • \n
  • ansible_facts_modified: The date and time ansible_facts was last modified. (datetime)
    • \n
\n

Sorting

\n

To specify that hosts are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_sources_hosts_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Host" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Hosts for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-hosts--get", "x-filename-id":"api-v2-inventory_sources-id-hosts-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventory_sources/{id}/inventory_updates/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninventory updates associated with the selected\ninventory source.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory update data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory update. (integer)
    • \n
  • type: Data type for this inventory update. (choice)
    • \n
  • url: URL for this inventory update. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory update was created. (datetime)
    • \n
  • modified: Timestamp when this inventory update was last modified. (datetime)
    • \n
  • name: Name of this inventory update. (string)
    • \n
  • description: Optional description of this inventory update. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string)
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string)
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)
    • \n
  • credential: Cloud credential to use for inventory updates. (integer)
    • \n
  • 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)
    • \n
  • 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. If the key is not found then the host will be enabled (string)
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)
    • \n
  • overwrite_vars: Overwrite local variables from remote inventory source. (boolean)
    • \n
  • custom_virtualenv: (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • limit: Enter host, group or pattern match (string)
    • \n
  • inventory: (id)
    • \n
  • inventory_source: (id)
    • \n
  • license_error: (boolean)
    • \n
  • org_host_limit_error: (boolean)
    • \n
  • source_project_update: Inventory files from this Project Update were used for the inventory update. (id)
    • \n
  • instance_group: The Instance group the job was run under (id)
    • \n
  • scm_revision: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)
    • \n
\n

Sorting

\n

To specify that inventory updates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_sources_inventory_updates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InventoryUpdateList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventory Updates for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-inventory_updates--get", "x-filename-id":"api-v2-inventory_sources-id-inventory_updates-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventory_sources/{id}/notification_templates_error/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_sources_notification_templates_error_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-notification_templates_error--get", "x-filename-id":"api-v2-inventory_sources-id-notification_templates_error-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\ninventory source.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for an Inventory Source:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this inventory source.

\n

Remove Notification Templates from this Inventory Source:

\n

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.

", "operationId":"api_inventory_sources_notification_templates_error_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-notification_templates_error--post", "x-filename-id":"api-v2-inventory_sources-id-notification_templates_error-post" } }, "/api/v2/inventory_sources/{id}/notification_templates_started/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_sources_notification_templates_started_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-notification_templates_started--get", "x-filename-id":"api-v2-inventory_sources-id-notification_templates_started-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\ninventory source.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for an Inventory Source:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this inventory source.

\n

Remove Notification Templates from this Inventory Source:

\n

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.

", "operationId":"api_inventory_sources_notification_templates_started_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-notification_templates_started--post", "x-filename-id":"api-v2-inventory_sources-id-notification_templates_started-post" } }, "/api/v2/inventory_sources/{id}/notification_templates_success/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_sources_notification_templates_success_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-notification_templates_success--get", "x-filename-id":"api-v2-inventory_sources-id-notification_templates_success-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\ninventory source.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for an Inventory Source:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this inventory source.

\n

Remove Notification Templates from this Inventory Source:

\n

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.

", "operationId":"api_inventory_sources_notification_templates_success_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-notification_templates_success--post", "x-filename-id":"api-v2-inventory_sources-id-notification_templates_success-post" } }, "/api/v2/inventory_sources/{id}/schedules/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\ninventory source.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each schedule data structure includes the following fields:

\n
    \n
  • rrule: A value representing the schedules iCal recurrence rule. (string)
    • \n
  • id: Database ID for this schedule. (integer)
    • \n
  • type: Data type for this schedule. (choice)
    • \n
  • url: URL for this schedule. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this schedule was created. (datetime)
    • \n
  • modified: Timestamp when this schedule was last modified. (datetime)
    • \n
  • name: Name of this schedule. (string)
    • \n
  • description: Optional description of this schedule. (string)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • unified_job_template: (id)
    • \n
  • enabled: Enables processing of this schedule. (boolean)
    • \n
  • dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)
    • \n
  • dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)
    • \n
  • next_run: The next time that the scheduled action will run. (datetime)
    • \n
  • timezone: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)
    • \n
  • until: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)
    • \n
\n

Sorting

\n

To specify that schedules are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_sources_schedules_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Schedule" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Schedules for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-schedules--get", "x-filename-id":"api-v2-inventory_sources-id-schedules-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following schedule\nfields to create a new schedule associated with this\ninventory source.

\n
    \n
  • \n

    rrule: A value representing the schedules iCal recurrence rule. (string, required)

    \n
    • \n
  • \n

    name: Name of this schedule. (string, required)

    \n
    • \n
  • description: Optional description of this schedule. (string, default=\"\")
    • \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • \n

    timeout: (integer, default=None)

    \n
    • \n
  • \n

    enabled: Enables processing of this schedule. (boolean, default=True)

    \n
    • \n
\n

POST requests to this resource must include a proper rrule value following\na particular format and conforming to subset of allowed rules.

\n

The following lists the expected format and details of our rrules:

\n
    \n
  • DTSTART is required and must follow the following format: DTSTART:YYYYMMDDTHHMMSSZ
    • \n
  • DTSTART is expected to be in UTC
    • \n
  • INTERVAL is required
    • \n
  • SECONDLY is not supported
    • \n
  • RRULE must precede the rule statements
    • \n
  • BYDAY is supported but not BYDAY with a numerical prefix
    • \n
  • BYYEARDAY and BYWEEKNO are not supported
    • \n
  • Only one rrule statement per schedule is supported
    • \n
  • COUNT must be < 1000
    • \n
\n

Here 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\"\n
", "operationId":"api_inventory_sources_schedules_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Schedule" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Schedule" } } }, "summary":"Create a Schedule for an Inventory Source", "tags":[ "Inventory Sources" ], "x-internal-id":"api-v2-inventory_sources-{id}-schedules--post", "x-filename-id":"api-v2-inventory_sources-id-schedules-post" } }, "/api/v2/inventory_sources/{id}/update/":{ "get":{ "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:

\n
    \n
  • can_update: Flag indicating if this inventory source can be updated\n (boolean, read-only)
    • \n
\n

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":"api_inventory_sources_update_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InventorySourceUpdate" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "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:

\n
    \n
  • can_update: Flag indicating if this inventory source can be updated\n (boolean, read-only)
    • \n
\n

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":"api_inventory_sources_update_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InventorySourceUpdate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InventorySourceUpdate" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory update data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory update. (integer)
    • \n
  • type: Data type for this inventory update. (choice)
    • \n
  • url: URL for this inventory update. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory update was created. (datetime)
    • \n
  • modified: Timestamp when this inventory update was last modified. (datetime)
    • \n
  • name: Name of this inventory update. (string)
    • \n
  • description: Optional description of this inventory update. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string)
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string)
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)
    • \n
  • credential: Cloud credential to use for inventory updates. (integer)
    • \n
  • 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)
    • \n
  • 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. If the key is not found then the host will be enabled (string)
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)
    • \n
  • overwrite_vars: Overwrite local variables from remote inventory source. (boolean)
    • \n
  • custom_virtualenv: (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • limit: Enter host, group or pattern match (string)
    • \n
  • inventory: (id)
    • \n
  • inventory_source: (id)
    • \n
  • license_error: (boolean)
    • \n
  • org_host_limit_error: (boolean)
    • \n
  • source_project_update: Inventory files from this Project Update were used for the inventory update. (id)
    • \n
  • instance_group: The Instance group the job was run under (id)
    • \n
  • scm_revision: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)
    • \n
\n

Sorting

\n

To specify that inventory updates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_updates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InventoryUpdateList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventory Updates", "tags":[ "Inventory Updates" ], "x-internal-id":"api-v2-inventory_updates--get", "x-filename-id":"api-v2-inventory_updates-get" }, "parameters":[ ] }, "/api/v2/inventory_updates/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this inventory update.

", "operationId":"api_inventory_updates_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this inventory update. (integer)
    • \n
  • type: Data type for this inventory update. (choice)
    • \n
  • url: URL for this inventory update. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory update was created. (datetime)
    • \n
  • modified: Timestamp when this inventory update was last modified. (datetime)
    • \n
  • name: Name of this inventory update. (string)
    • \n
  • description: Optional description of this inventory update. (string)
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string)
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string)
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)
    • \n
  • credential: Cloud credential to use for inventory updates. (integer)
    • \n
  • 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)
    • \n
  • 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. If the key is not found then the host will be enabled (string)
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)
    • \n
  • overwrite_vars: Overwrite local variables from remote inventory source. (boolean)
    • \n
  • custom_virtualenv: (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • limit: Enter host, group or pattern match (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_args: (string)
    • \n
  • job_cwd: (string)
    • \n
  • job_env: (json)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • result_traceback: (string)
    • \n
  • event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • inventory: (id)
    • \n
  • inventory_source: (id)
    • \n
  • license_error: (boolean)
    • \n
  • org_host_limit_error: (boolean)
    • \n
  • source_project_update: Inventory files from this Project Update were used for the inventory update. (id)
    • \n
  • instance_group: The Instance group the job was run under (id)
    • \n
  • scm_revision: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)
    • \n
  • source_project: The project used for this job. (field)
    • \n
", "operationId":"api_inventory_updates_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InventoryUpdateDetail" } } }, "summary":"Retrieve an Inventory Update", "tags":[ "Inventory Updates" ], "x-internal-id":"api-v2-inventory_updates-{id}--get", "x-filename-id":"api-v2-inventory_updates-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventory_updates/{id}/cancel/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:

\n
    \n
  • can_cancel: (boolean)
    • \n
", "operationId":"api_inventory_updates_cancel_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/InventoryUpdateCancel" } } }, "summary":"Retrieve an Inventory Update", "tags":[ "Inventory Updates" ], "x-internal-id":"api-v2-inventory_updates-{id}-cancel--get", "x-filename-id":"api-v2-inventory_updates-id-cancel-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:

\n
    \n
  • can_cancel: (boolean)
    • \n
", "operationId":"api_inventory_updates_cancel_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InventoryUpdateCancel" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InventoryUpdateCancel" } } }, "summary":"Retrieve an Inventory Update", "tags":[ "Inventory Updates" ], "x-internal-id":"api-v2-inventory_updates-{id}-cancel--post", "x-filename-id":"api-v2-inventory_updates-id-cancel-post" } }, "/api/v2/inventory_updates/{id}/credentials/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ninventory update.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • organization: (id)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_updates_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Credential" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials for an Inventory Update", "tags":[ "Inventory Updates" ], "x-internal-id":"api-v2-inventory_updates-{id}-credentials--get", "x-filename-id":"api-v2-inventory_updates-id-credentials-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventory_updates/{id}/events/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninventory update events associated with the selected\ninventory update.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory update event data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory update event. (integer)
    • \n
  • type: Data type for this inventory update event. (choice)
    • \n
  • url: URL for this inventory update event. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory update event was created. (datetime)
    • \n
  • modified: Timestamp when this inventory update event was last modified. (datetime)
    • \n
  • event: (field)
    • \n
  • counter: (integer)
    • \n
  • event_display: (string)
    • \n
  • event_data: (json)
    • \n
  • failed: (field)
    • \n
  • changed: (field)
    • \n
  • uuid: (string)
    • \n
  • stdout: (string)
    • \n
  • start_line: (integer)
    • \n
  • end_line: (integer)
    • \n
  • verbosity: (integer)
    • \n
  • inventory_update: (id)
    • \n
\n

Sorting

\n

To specify that inventory update events are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_updates_events_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InventoryUpdateEvent" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventory Update Events for an Inventory Update", "tags":[ "Inventory Updates" ], "x-internal-id":"api-v2-inventory_updates-{id}-events--get", "x-filename-id":"api-v2-inventory_updates-id-events-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventory_updates/{id}/notifications/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\ninventory update.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification. (integer)
    • \n
  • type: Data type for this notification. (choice)
    • \n
  • url: URL for this notification. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification was created. (datetime)
    • \n
  • modified: Timestamp when this notification was last modified. (datetime)
    • \n
  • notification_template: (id)
    • \n
  • error: (string)
    • \n
  • status: (choice)
      \n
    • pending: Pending
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    \n
    • \n
  • notifications_sent: (integer)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • recipients: (string)
    • \n
  • subject: (string)
    • \n
  • body: Notification body (json)
    • \n
\n

Sorting

\n

To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_inventory_updates_notifications_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Notification" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notifications for an Inventory Update", "tags":[ "Inventory Updates" ], "x-internal-id":"api-v2-inventory_updates-{id}-notifications--get", "x-filename-id":"api-v2-inventory_updates-id-notifications-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/inventory_updates/{id}/stdout/":{ "get":{ "description":"

Make GET request to this resource to retrieve the stdout from running this\ninventory update.

\n

Format

\n

Use the format query string parameter to specify the output format.

\n
    \n
  • Browsable API: ?format=api
    • \n
  • HTML: ?format=html
    • \n
  • Plain Text: ?format=txt
    • \n
  • Plain Text with ANSI color codes: ?format=ansi
    • \n
  • JSON structure: ?format=json
    • \n
  • Downloaded Plain Text: ?format=txt_download
    • \n
  • Downloaded Plain Text with ANSI color codes: ?format=ansi_download
    • \n
\n

(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.

\n

Use dark=1 or dark=0 as a query string parameter to force or disable a\ndark background.

\n

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.

", "operationId":"api_inventory_updates_stdout_read", "parameters":[ ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/UnifiedJobStdout" } } }, "summary":"Retrieve Inventory Update Stdout", "tags":[ "Inventory Updates" ], "x-internal-id":"api-v2-inventory_updates-{id}-stdout--get", "x-filename-id":"api-v2-inventory_updates-id-stdout-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/job_events/{id}/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single job event\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this job event. (integer)
    • \n
  • type: Data type for this job event. (choice)
    • \n
  • url: URL for this job event. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job event was created. (datetime)
    • \n
  • modified: Timestamp when this job event was last modified. (datetime)
    • \n
  • job: (id)
    • \n
  • event: (choice)
      \n
    • runner_on_failed: Host Failed
      • \n
    • runner_on_start: Host Started
      • \n
    • runner_on_ok: Host OK
      • \n
    • runner_on_error: Host Failure
      • \n
    • runner_on_skipped: Host Skipped
      • \n
    • runner_on_unreachable: Host Unreachable
      • \n
    • runner_on_no_hosts: No Hosts Remaining
      • \n
    • runner_on_async_poll: Host Polling
      • \n
    • runner_on_async_ok: Host Async OK
      • \n
    • runner_on_async_failed: Host Async Failure
      • \n
    • runner_item_on_ok: Item OK
      • \n
    • runner_item_on_failed: Item Failed
      • \n
    • runner_item_on_skipped: Item Skipped
      • \n
    • runner_retry: Host Retry
      • \n
    • runner_on_file_diff: File Difference
      • \n
    • playbook_on_start: Playbook Started
      • \n
    • playbook_on_notify: Running Handlers
      • \n
    • playbook_on_include: Including File
      • \n
    • playbook_on_no_hosts_matched: No Hosts Matched
      • \n
    • playbook_on_no_hosts_remaining: No Hosts Remaining
      • \n
    • playbook_on_task_start: Task Started
      • \n
    • playbook_on_vars_prompt: Variables Prompted
      • \n
    • playbook_on_setup: Gathering Facts
      • \n
    • playbook_on_import_for_host: internal: on Import for Host
      • \n
    • playbook_on_not_import_for_host: internal: on Not Import for Host
      • \n
    • playbook_on_play_start: Play Started
      • \n
    • playbook_on_stats: Playbook Complete
      • \n
    • debug: Debug
      • \n
    • verbose: Verbose
      • \n
    • deprecated: Deprecated
      • \n
    • warning: Warning
      • \n
    • system_warning: System Warning
      • \n
    • error: Error
      • \n
    \n
    • \n
  • counter: (integer)
    • \n
  • event_display: (string)
    • \n
  • event_data: (json)
    • \n
  • event_level: (integer)
    • \n
  • failed: (boolean)
    • \n
  • changed: (boolean)
    • \n
  • uuid: (string)
    • \n
  • parent_uuid: (string)
    • \n
  • host: (id)
    • \n
  • host_name: (string)
    • \n
  • playbook: (string)
    • \n
  • play: (string)
    • \n
  • task: (string)
    • \n
  • role: (string)
    • \n
  • stdout: (string)
    • \n
  • start_line: (integer)
    • \n
  • end_line: (integer)
    • \n
  • verbosity: (integer)
    • \n
", "operationId":"api_job_events_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/JobEvent" } } }, "summary":"Retrieve a Job Event", "tags":[ "Job Events" ], "x-internal-id":"api-v2-job_events-{id}--get", "x-filename-id":"api-v2-job_events-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/job_events/{id}/children/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\njob events associated with the selected\njob event.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each job event data structure includes the following fields:

\n
    \n
  • id: Database ID for this job event. (integer)
    • \n
  • type: Data type for this job event. (choice)
    • \n
  • url: URL for this job event. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job event was created. (datetime)
    • \n
  • modified: Timestamp when this job event was last modified. (datetime)
    • \n
  • job: (id)
    • \n
  • event: (choice)
      \n
    • runner_on_failed: Host Failed
      • \n
    • runner_on_start: Host Started
      • \n
    • runner_on_ok: Host OK
      • \n
    • runner_on_error: Host Failure
      • \n
    • runner_on_skipped: Host Skipped
      • \n
    • runner_on_unreachable: Host Unreachable
      • \n
    • runner_on_no_hosts: No Hosts Remaining
      • \n
    • runner_on_async_poll: Host Polling
      • \n
    • runner_on_async_ok: Host Async OK
      • \n
    • runner_on_async_failed: Host Async Failure
      • \n
    • runner_item_on_ok: Item OK
      • \n
    • runner_item_on_failed: Item Failed
      • \n
    • runner_item_on_skipped: Item Skipped
      • \n
    • runner_retry: Host Retry
      • \n
    • runner_on_file_diff: File Difference
      • \n
    • playbook_on_start: Playbook Started
      • \n
    • playbook_on_notify: Running Handlers
      • \n
    • playbook_on_include: Including File
      • \n
    • playbook_on_no_hosts_matched: No Hosts Matched
      • \n
    • playbook_on_no_hosts_remaining: No Hosts Remaining
      • \n
    • playbook_on_task_start: Task Started
      • \n
    • playbook_on_vars_prompt: Variables Prompted
      • \n
    • playbook_on_setup: Gathering Facts
      • \n
    • playbook_on_import_for_host: internal: on Import for Host
      • \n
    • playbook_on_not_import_for_host: internal: on Not Import for Host
      • \n
    • playbook_on_play_start: Play Started
      • \n
    • playbook_on_stats: Playbook Complete
      • \n
    • debug: Debug
      • \n
    • verbose: Verbose
      • \n
    • deprecated: Deprecated
      • \n
    • warning: Warning
      • \n
    • system_warning: System Warning
      • \n
    • error: Error
      • \n
    \n
    • \n
  • counter: (integer)
    • \n
  • event_display: (string)
    • \n
  • event_data: (json)
    • \n
  • event_level: (integer)
    • \n
  • failed: (boolean)
    • \n
  • changed: (boolean)
    • \n
  • uuid: (string)
    • \n
  • parent_uuid: (string)
    • \n
  • host: (id)
    • \n
  • host_name: (string)
    • \n
  • playbook: (string)
    • \n
  • play: (string)
    • \n
  • task: (string)
    • \n
  • role: (string)
    • \n
  • stdout: (string)
    • \n
  • start_line: (integer)
    • \n
  • end_line: (integer)
    • \n
  • verbosity: (integer)
    • \n
\n

Sorting

\n

To specify that job events are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_events_children_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/JobEvent" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Job Events for a Job Event", "tags":[ "Job Events" ], "x-internal-id":"api-v2-job_events-{id}-children--get", "x-filename-id":"api-v2-job_events-id-children-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/job_host_summaries/{id}/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single job host summary\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this job host summary. (integer)
    • \n
  • type: Data type for this job host summary. (choice)
    • \n
  • url: URL for this job host summary. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job host summary was created. (datetime)
    • \n
  • modified: Timestamp when this job host summary was last modified. (datetime)
    • \n
  • job: (id)
    • \n
  • host: (id)
    • \n
  • constructed_host: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)
    • \n
  • host_name: (string)
    • \n
  • changed: (integer)
    • \n
  • dark: (integer)
    • \n
  • failures: (integer)
    • \n
  • ok: (integer)
    • \n
  • processed: (integer)
    • \n
  • skipped: (integer)
    • \n
  • failed: (boolean)
    • \n
  • ignored: (integer)
    • \n
  • rescued: (integer)
    • \n
", "operationId":"api_job_host_summaries_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/JobHostSummary" } } }, "summary":"Retrieve a Job Host Summary", "tags":[ "Job Host Summaries" ], "x-internal-id":"api-v2-job_host_summaries-{id}--get", "x-filename-id":"api-v2-job_host_summaries-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/job_templates/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\njob templates.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each job template data structure includes the following fields:

\n
    \n
  • id: Database ID for this job template. (integer)
    • \n
  • type: Data type for this job template. (choice)
    • \n
  • url: URL for this job template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job template was created. (datetime)
    • \n
  • modified: Timestamp when this job template was last modified. (datetime)
    • \n
  • name: Name of this job template. (string)
    • \n
  • description: Optional description of this job template. (string)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id)
    • \n
  • project: (id)
    • \n
  • playbook: (string)
    • \n
  • 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)
    • \n
  • forks: (integer)
    • \n
  • limit: (string)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (json)
    • \n
  • job_tags: (string)
    • \n
  • force_handlers: (boolean)
    • \n
  • skip_tags: (string)
    • \n
  • start_at_task: (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • use_fact_cache: If enabled, the service 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)
    • \n
  • organization: The organization used to determine access to this template. (id)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • host_config_key: (string)
    • \n
  • ask_scm_branch_on_launch: (boolean)
    • \n
  • ask_diff_mode_on_launch: (boolean)
    • \n
  • ask_variables_on_launch: (boolean)
    • \n
  • ask_limit_on_launch: (boolean)
    • \n
  • ask_tags_on_launch: (boolean)
    • \n
  • ask_skip_tags_on_launch: (boolean)
    • \n
  • ask_job_type_on_launch: (boolean)
    • \n
  • ask_verbosity_on_launch: (boolean)
    • \n
  • ask_inventory_on_launch: (boolean)
    • \n
  • ask_credential_on_launch: (boolean)
    • \n
  • ask_execution_environment_on_launch: (boolean)
    • \n
  • ask_labels_on_launch: (boolean)
    • \n
  • ask_forks_on_launch: (boolean)
    • \n
  • ask_job_slice_count_on_launch: (boolean)
    • \n
  • ask_timeout_on_launch: (boolean)
    • \n
  • ask_instance_groups_on_launch: (boolean)
    • \n
  • survey_enabled: (boolean)
    • \n
  • become_enabled: (boolean)
    • \n
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • 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)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • prevent_instance_group_fallback: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)
    • \n
\n

Sorting

\n

To specify that job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/JobTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Job Templates", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates--get", "x-filename-id":"api-v2-job_templates-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following job template\nfields to create a new job template:

\n
    \n
  • name: Name of this job template. (string, required)
    • \n
  • description: Optional description of this job template. (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • run: Run (default)
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id, default=``)
    • \n
  • project: (id, default=``)
    • \n
  • playbook: (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • forks: (integer, default=0)
    • \n
  • limit: (string, default=\"\")
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal) (default)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (json, default=``)
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • force_handlers: (boolean, default=False)
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • start_at_task: (string, default=\"\")
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)
    • \n
  • \n

    use_fact_cache: If enabled, the service 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)

    \n
    • \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • host_config_key: (string, default=\"\")
    • \n
  • ask_scm_branch_on_launch: (boolean, default=False)
    • \n
  • ask_diff_mode_on_launch: (boolean, default=False)
    • \n
  • ask_variables_on_launch: (boolean, default=False)
    • \n
  • ask_limit_on_launch: (boolean, default=False)
    • \n
  • ask_tags_on_launch: (boolean, default=False)
    • \n
  • ask_skip_tags_on_launch: (boolean, default=False)
    • \n
  • ask_job_type_on_launch: (boolean, default=False)
    • \n
  • ask_verbosity_on_launch: (boolean, default=False)
    • \n
  • ask_inventory_on_launch: (boolean, default=False)
    • \n
  • ask_credential_on_launch: (boolean, default=False)
    • \n
  • ask_execution_environment_on_launch: (boolean, default=False)
    • \n
  • ask_labels_on_launch: (boolean, default=False)
    • \n
  • ask_forks_on_launch: (boolean, default=False)
    • \n
  • ask_job_slice_count_on_launch: (boolean, default=False)
    • \n
  • ask_timeout_on_launch: (boolean, default=False)
    • \n
  • ask_instance_groups_on_launch: (boolean, default=False)
    • \n
  • survey_enabled: (boolean, default=False)
    • \n
  • become_enabled: (boolean, default=False)
    • \n
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=False)
    • \n
  • \n

    allow_simultaneous: (boolean, default=False)

    \n
    • \n
  • \n

    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)

    \n
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)
    • \n
  • prevent_instance_group_fallback: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)
    • \n
", "operationId":"api_job_templates_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/JobTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/JobTemplate" } } }, "summary":"Create a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates--post", "x-filename-id":"api-v2-job_templates-post" } }, "/api/v2/job_templates/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this job template.

", "operationId":"api_job_templates_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this job template. (integer)
    • \n
  • type: Data type for this job template. (choice)
    • \n
  • url: URL for this job template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job template was created. (datetime)
    • \n
  • modified: Timestamp when this job template was last modified. (datetime)
    • \n
  • name: Name of this job template. (string)
    • \n
  • description: Optional description of this job template. (string)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id)
    • \n
  • project: (id)
    • \n
  • playbook: (string)
    • \n
  • 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)
    • \n
  • forks: (integer)
    • \n
  • limit: (string)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (json)
    • \n
  • job_tags: (string)
    • \n
  • force_handlers: (boolean)
    • \n
  • skip_tags: (string)
    • \n
  • start_at_task: (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • use_fact_cache: If enabled, the service 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)
    • \n
  • organization: The organization used to determine access to this template. (id)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • host_config_key: (string)
    • \n
  • ask_scm_branch_on_launch: (boolean)
    • \n
  • ask_diff_mode_on_launch: (boolean)
    • \n
  • ask_variables_on_launch: (boolean)
    • \n
  • ask_limit_on_launch: (boolean)
    • \n
  • ask_tags_on_launch: (boolean)
    • \n
  • ask_skip_tags_on_launch: (boolean)
    • \n
  • ask_job_type_on_launch: (boolean)
    • \n
  • ask_verbosity_on_launch: (boolean)
    • \n
  • ask_inventory_on_launch: (boolean)
    • \n
  • ask_credential_on_launch: (boolean)
    • \n
  • ask_execution_environment_on_launch: (boolean)
    • \n
  • ask_labels_on_launch: (boolean)
    • \n
  • ask_forks_on_launch: (boolean)
    • \n
  • ask_job_slice_count_on_launch: (boolean)
    • \n
  • ask_timeout_on_launch: (boolean)
    • \n
  • ask_instance_groups_on_launch: (boolean)
    • \n
  • survey_enabled: (boolean)
    • \n
  • become_enabled: (boolean)
    • \n
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • 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)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • prevent_instance_group_fallback: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)
    • \n
", "operationId":"api_job_templates_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/JobTemplate" } } }, "summary":"Retrieve a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}--get", "x-filename-id":"api-v2-job_templates-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\njob template. The following fields may be modified:

\n
    \n
  • name: Name of this job template. (string, required)
    • \n
  • description: Optional description of this job template. (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • run: Run (default)
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id, default=``)
    • \n
  • project: (id, default=``)
    • \n
  • playbook: (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • forks: (integer, default=0)
    • \n
  • limit: (string, default=\"\")
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal) (default)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (json, default=``)
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • force_handlers: (boolean, default=False)
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • start_at_task: (string, default=\"\")
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)
    • \n
  • \n

    use_fact_cache: If enabled, the service 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)

    \n
    • \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • host_config_key: (string, default=\"\")
    • \n
  • ask_scm_branch_on_launch: (boolean, default=False)
    • \n
  • ask_diff_mode_on_launch: (boolean, default=False)
    • \n
  • ask_variables_on_launch: (boolean, default=False)
    • \n
  • ask_limit_on_launch: (boolean, default=False)
    • \n
  • ask_tags_on_launch: (boolean, default=False)
    • \n
  • ask_skip_tags_on_launch: (boolean, default=False)
    • \n
  • ask_job_type_on_launch: (boolean, default=False)
    • \n
  • ask_verbosity_on_launch: (boolean, default=False)
    • \n
  • ask_inventory_on_launch: (boolean, default=False)
    • \n
  • ask_credential_on_launch: (boolean, default=False)
    • \n
  • ask_execution_environment_on_launch: (boolean, default=False)
    • \n
  • ask_labels_on_launch: (boolean, default=False)
    • \n
  • ask_forks_on_launch: (boolean, default=False)
    • \n
  • ask_job_slice_count_on_launch: (boolean, default=False)
    • \n
  • ask_timeout_on_launch: (boolean, default=False)
    • \n
  • ask_instance_groups_on_launch: (boolean, default=False)
    • \n
  • survey_enabled: (boolean, default=False)
    • \n
  • become_enabled: (boolean, default=False)
    • \n
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=False)
    • \n
  • \n

    allow_simultaneous: (boolean, default=False)

    \n
    • \n
  • \n

    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)

    \n
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)
    • \n
  • prevent_instance_group_fallback: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_job_templates_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/JobTemplate" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/JobTemplate" } } }, "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":{ "description":"

Make a PUT or PATCH request to this resource to update this\njob template. The following fields may be modified:

\n
    \n
  • name: Name of this job template. (string, required)
    • \n
  • description: Optional description of this job template. (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • run: Run (default)
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id, default=``)
    • \n
  • project: (id, default=``)
    • \n
  • playbook: (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • forks: (integer, default=0)
    • \n
  • limit: (string, default=\"\")
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal) (default)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (json, default=``)
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • force_handlers: (boolean, default=False)
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • start_at_task: (string, default=\"\")
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)
    • \n
  • \n

    use_fact_cache: If enabled, the service 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)

    \n
    • \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • host_config_key: (string, default=\"\")
    • \n
  • ask_scm_branch_on_launch: (boolean, default=False)
    • \n
  • ask_diff_mode_on_launch: (boolean, default=False)
    • \n
  • ask_variables_on_launch: (boolean, default=False)
    • \n
  • ask_limit_on_launch: (boolean, default=False)
    • \n
  • ask_tags_on_launch: (boolean, default=False)
    • \n
  • ask_skip_tags_on_launch: (boolean, default=False)
    • \n
  • ask_job_type_on_launch: (boolean, default=False)
    • \n
  • ask_verbosity_on_launch: (boolean, default=False)
    • \n
  • ask_inventory_on_launch: (boolean, default=False)
    • \n
  • ask_credential_on_launch: (boolean, default=False)
    • \n
  • ask_execution_environment_on_launch: (boolean, default=False)
    • \n
  • ask_labels_on_launch: (boolean, default=False)
    • \n
  • ask_forks_on_launch: (boolean, default=False)
    • \n
  • ask_job_slice_count_on_launch: (boolean, default=False)
    • \n
  • ask_timeout_on_launch: (boolean, default=False)
    • \n
  • ask_instance_groups_on_launch: (boolean, default=False)
    • \n
  • survey_enabled: (boolean, default=False)
    • \n
  • become_enabled: (boolean, default=False)
    • \n
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=False)
    • \n
  • \n

    allow_simultaneous: (boolean, default=False)

    \n
    • \n
  • \n

    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)

    \n
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)
    • \n
  • prevent_instance_group_fallback: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_job_templates_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/JobTemplate" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/JobTemplate" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_access_list_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ResourceAccessListElement" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-access_list--get", "x-filename-id":"api-v2-job_templates-id-access_list-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/job_templates/{id}/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\njob template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-activity_stream--get", "x-filename-id":"api-v2-job_templates-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/job_templates/{id}/bitbucket_dc/":{ "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_job_templates_bitbucket_dc_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Job Templates" ], "summary":"Job Templates Bitbucket Dc Create", "x-internal-id":"api-v2-job_templates-{id}-bitbucket_dc--post", "x-filename-id":"api-v2-job_templates-id-bitbucket_dc-post" } }, "/api/v2/job_templates/{id}/callback/":{ "get":{ "description":"

Configure 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.

\n

For example, using curl:

\n
curl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\"}'  http://server/api/v2/job_templates/N/callback/\n
\n

Or using wget:

\n
wget -O /dev/null --post-data='{\"host_config_key\": \"HOST_CONFIG_KEY\"}' --header=Content-Type:application/json http://server/api/v2/job_templates/N/callback/\n
\n

You may also pass extra_vars to the callback:

\n
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/\n
\n

The 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.

\n

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:

\n
curl http://user:password@server/api/v2/job_templates/N/callback/\n
\n

The 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}\n
", "operationId":"api_job_templates_callback_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Empty" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"The Job Template Callback Allows for Ephemeral Hosts to Launch a New Job.", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-callback--get", "x-filename-id":"api-v2-job_templates-id-callback-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Configure 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.

\n

For example, using curl:

\n
curl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\"}'  http://server/api/v2/job_templates/N/callback/\n
\n

Or using wget:

\n
wget -O /dev/null --post-data='{\"host_config_key\": \"HOST_CONFIG_KEY\"}' --header=Content-Type:application/json http://server/api/v2/job_templates/N/callback/\n
\n

You may also pass extra_vars to the callback:

\n
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/\n
\n

The 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.

\n

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:

\n
curl http://user:password@server/api/v2/job_templates/N/callback/\n
\n

The 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}\n
", "operationId":"api_job_templates_callback_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Empty" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Empty" } } }, "summary":"The Job Template Callback Allows for Ephemeral Hosts to Launch a New Job.", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-callback--post", "x-filename-id":"api-v2-job_templates-id-callback-post" } }, "/api/v2/job_templates/{id}/copy/":{ "get":{ "description":"", "operationId":"api_job_templates_copy_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Copy" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "tags":[ "Job Templates" ], "summary":"Job Templates Copy List", "x-internal-id":"api-v2-job_templates-{id}-copy--get", "x-filename-id":"api-v2-job_templates-id-copy-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_job_templates_copy_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Copy" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Copy" } } }, "tags":[ "Job Templates" ], "summary":"Job Templates Copy Create", "x-internal-id":"api-v2-job_templates-{id}-copy--post", "x-filename-id":"api-v2-job_templates-id-copy-post" } }, "/api/v2/job_templates/{id}/credentials/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\njob template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • organization: (id)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Credential" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-credentials--get", "x-filename-id":"api-v2-job_templates-id-credentials-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following credential\nfields to create a new credential associated with this\njob template.

\n
    \n
  • name: Name of this credential. (string, required)
    • \n
  • description: Optional description of this credential. (string, default=\"\")
    • \n
  • organization: (id, default=None)
    • \n
  • \n

    credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
\n

Add Credentials for a Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting credential with this job template.

\n

Remove Credentials from this Job Template:

\n

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.

", "operationId":"api_job_templates_credentials_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Credential" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Credential" } } }, "summary":"Create a Credential for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-credentials--post", "x-filename-id":"api-v2-job_templates-id-credentials-post" } }, "/api/v2/job_templates/{id}/github/":{ "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_job_templates_github_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Job Templates" ], "summary":"Job Templates Github Create", "x-internal-id":"api-v2-job_templates-{id}-github--post", "x-filename-id":"api-v2-job_templates-id-github-post" } }, "/api/v2/job_templates/{id}/gitlab/":{ "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_job_templates_gitlab_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Job Templates" ], "summary":"Job Templates Gitlab Create", "x-internal-id":"api-v2-job_templates-{id}-gitlab--post", "x-filename-id":"api-v2-job_templates-id-gitlab-post" } }, "/api/v2/job_templates/{id}/instance_groups/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\njob template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each instance group data structure includes the following fields:

\n
    \n
  • id: Database ID for this instance group. (integer)
    • \n
  • type: Data type for this instance group. (choice)
    • \n
  • url: URL for this instance group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • name: Name of this instance group. (string)
    • \n
  • created: Timestamp when this instance group was created. (datetime)
    • \n
  • modified: Timestamp when this instance group was last modified. (datetime)
    • \n
  • capacity: (field)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: (field)
    • \n
  • max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance group (integer)
    • \n
  • instances: (field)
    • \n
  • is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)
    • \n
  • credential: (id)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json)
    • \n
  • pod_spec_override: (string)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
\n

Sorting

\n

To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_instance_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InstanceGroup" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Instance Groups for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-instance_groups--get", "x-filename-id":"api-v2-job_templates-id-instance_groups-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following instance group\nfields to create a new instance group associated with this\njob template.

\n
    \n
  • \n

    name: Name of this instance group. (string, required)

    \n
    • \n
  • \n

    max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)

    \n
    • \n
  • credential: (id, default=``)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)
    • \n
  • pod_spec_override: (string, default=\"\")
    • \n
\n

Add Instance Groups for a Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting instance group with this job template.

\n

Remove Instance Groups from this Job Template:

\n

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.

", "operationId":"api_job_templates_instance_groups_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InstanceGroup" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InstanceGroup" } } }, "summary":"Create an Instance Group for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-instance_groups--post", "x-filename-id":"api-v2-job_templates-id-instance_groups-post" } }, "/api/v2/job_templates/{id}/jobs/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\njobs associated with the selected\njob template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each job data structure includes the following fields:

\n
    \n
  • id: Database ID for this job. (integer)
    • \n
  • type: Data type for this job. (choice)
    • \n
  • url: URL for this job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job was created. (datetime)
    • \n
  • modified: Timestamp when this job was last modified. (datetime)
    • \n
  • name: Name of this job. (string)
    • \n
  • description: Optional description of this job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    • scan: Scan
      • \n
    \n
    • \n
  • inventory: (id)
    • \n
  • project: (id)
    • \n
  • playbook: (string)
    • \n
  • 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)
    • \n
  • forks: (integer)
    • \n
  • limit: (string)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (json)
    • \n
  • job_tags: (string)
    • \n
  • force_handlers: (boolean)
    • \n
  • skip_tags: (string)
    • \n
  • start_at_task: (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • use_fact_cache: If enabled, the service 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)
    • \n
  • organization: The organization used to determine access to this unified job. (id)
    • \n
  • job_template: (id)
    • \n
  • passwords_needed_to_start: (field)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • artifacts: (json)
    • \n
  • scm_revision: The SCM Revision from the Project used for this job, if available (string)
    • \n
  • instance_group: The Instance group the job was run under (id)
    • \n
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • webhook_guid: Unique identifier of the event that triggered this webhook (string)
    • \n
\n

Sorting

\n

To specify that jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_jobs_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/JobList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Jobs for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-jobs--get", "x-filename-id":"api-v2-job_templates-id-jobs-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/job_templates/{id}/labels/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\njob template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each label data structure includes the following fields:

\n
    \n
  • id: Database ID for this label. (integer)
    • \n
  • type: Data type for this label. (choice)
    • \n
  • url: URL for this label. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this label was created. (datetime)
    • \n
  • modified: Timestamp when this label was last modified. (datetime)
    • \n
  • name: Name of this label. (string)
    • \n
  • organization: Organization this label belongs to. (id)
    • \n
\n

Sorting

\n

To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_labels_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Label" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Labels for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-labels--get", "x-filename-id":"api-v2-job_templates-id-labels-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following label\nfields to create a new label associated with this\njob template.

\n
    \n
  • name: Name of this label. (string, required)
    • \n
  • organization: Organization this label belongs to. (id, required)
    • \n
\n

Add Labels for a Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting label with this job template.

\n

Remove Labels from this Job Template:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the label from this job template\n.

\n

Labels not associated with any other resources are deleted. A label can become disassociated with a resource as a result of 3 events.

\n
    \n
  1. A label is explicitly disassociated with a related job template
    2. \n
  2. A job is deleted with labels
    3. \n
  3. A cleanup job deletes a job with labels
    4. \n
", "operationId":"api_job_templates_labels_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Label" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Label" } } }, "summary":"Create a Label for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-labels--post", "x-filename-id":"api-v2-job_templates-id-labels-post" } }, "/api/v2/job_templates/{id}/launch/":{ "get":{ "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:

\n
    \n
  • ask_variables_on_launch: Flag indicating whether the job_template is\n configured to prompt for variables upon launch (boolean, read-only)
    • \n
  • ask_tags_on_launch: Flag indicating whether the job_template is\n configured to prompt for tags upon launch (boolean, read-only)
    • \n
  • ask_skip_tags_on_launch: Flag indicating whether the job_template is\n configured to prompt for skip_tags upon launch (boolean, read-only)
    • \n
  • ask_job_type_on_launch: Flag indicating whether the job_template is\n configured to prompt for job_type upon launch (boolean, read-only)
    • \n
  • ask_limit_on_launch: Flag indicating whether the job_template is\n configured to prompt for limit upon launch (boolean, read-only)
    • \n
  • ask_inventory_on_launch: Flag indicating whether the job_template is\n configured to prompt for inventory upon launch (boolean, read-only)
    • \n
  • ask_credential_on_launch: Flag indicating whether the job_template is\n configured to prompt for credential upon launch (boolean, read-only)
    • \n
  • can_start_without_user_input: Flag indicating if the job_template can be\n launched without user-input (boolean, read-only)
    • \n
  • passwords_needed_to_start: Password names required to launch the\n job_template (array, read-only)
    • \n
  • variables_needed_to_start: Required variable names required to launch the\n job_template (array, read-only)
    • \n
  • survey_enabled: Flag indicating whether the job_template has an enabled\n survey (boolean, read-only)
    • \n
  • 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)
    • \n
", "operationId":"api_job_templates_launch_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/JobLaunch" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

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.

\n

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":"api_job_templates_launch_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/JobLaunch" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/JobLaunch" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_notification_templates_error_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-notification_templates_error--get", "x-filename-id":"api-v2-job_templates-id-notification_templates_error-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\njob template.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this job template.

\n

Remove Notification Templates from this Job Template:

\n

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.

", "operationId":"api_job_templates_notification_templates_error_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-notification_templates_error--post", "x-filename-id":"api-v2-job_templates-id-notification_templates_error-post" } }, "/api/v2/job_templates/{id}/notification_templates_started/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_notification_templates_started_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-notification_templates_started--get", "x-filename-id":"api-v2-job_templates-id-notification_templates_started-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\njob template.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this job template.

\n

Remove Notification Templates from this Job Template:

\n

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.

", "operationId":"api_job_templates_notification_templates_started_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-notification_templates_started--post", "x-filename-id":"api-v2-job_templates-id-notification_templates_started-post" } }, "/api/v2/job_templates/{id}/notification_templates_success/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_notification_templates_success_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-notification_templates_success--get", "x-filename-id":"api-v2-job_templates-id-notification_templates_success-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\njob template.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this job template.

\n

Remove Notification Templates from this Job Template:

\n

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.

", "operationId":"api_job_templates_notification_templates_success_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-notification_templates_success--post", "x-filename-id":"api-v2-job_templates-id-notification_templates_success-post" } }, "/api/v2/job_templates/{id}/object_roles/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nroles associated with the selected\njob template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_object_roles_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Role" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-object_roles--get", "x-filename-id":"api-v2-job_templates-id-object_roles-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/job_templates/{id}/schedules/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\njob template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each schedule data structure includes the following fields:

\n
    \n
  • rrule: A value representing the schedules iCal recurrence rule. (string)
    • \n
  • id: Database ID for this schedule. (integer)
    • \n
  • type: Data type for this schedule. (choice)
    • \n
  • url: URL for this schedule. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this schedule was created. (datetime)
    • \n
  • modified: Timestamp when this schedule was last modified. (datetime)
    • \n
  • name: Name of this schedule. (string)
    • \n
  • description: Optional description of this schedule. (string)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • unified_job_template: (id)
    • \n
  • enabled: Enables processing of this schedule. (boolean)
    • \n
  • dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)
    • \n
  • dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)
    • \n
  • next_run: The next time that the scheduled action will run. (datetime)
    • \n
  • timezone: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)
    • \n
  • until: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)
    • \n
\n

Sorting

\n

To specify that schedules are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_schedules_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Schedule" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Schedules for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-schedules--get", "x-filename-id":"api-v2-job_templates-id-schedules-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following schedule\nfields to create a new schedule associated with this\njob template.

\n
    \n
  • \n

    rrule: A value representing the schedules iCal recurrence rule. (string, required)

    \n
    • \n
  • \n

    name: Name of this schedule. (string, required)

    \n
    • \n
  • description: Optional description of this schedule. (string, default=\"\")
    • \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • \n

    timeout: (integer, default=None)

    \n
    • \n
  • \n

    enabled: Enables processing of this schedule. (boolean, default=True)

    \n
    • \n
\n

POST requests to this resource must include a proper rrule value following\na particular format and conforming to subset of allowed rules.

\n

The following lists the expected format and details of our rrules:

\n
    \n
  • DTSTART is required and must follow the following format: DTSTART:YYYYMMDDTHHMMSSZ
    • \n
  • DTSTART is expected to be in UTC
    • \n
  • INTERVAL is required
    • \n
  • SECONDLY is not supported
    • \n
  • RRULE must precede the rule statements
    • \n
  • BYDAY is supported but not BYDAY with a numerical prefix
    • \n
  • BYYEARDAY and BYWEEKNO are not supported
    • \n
  • Only one rrule statement per schedule is supported
    • \n
  • COUNT must be < 1000
    • \n
\n

Here 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\"\n
", "operationId":"api_job_templates_schedules_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Schedule" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Schedule" } } }, "summary":"Create a Schedule for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-schedules--post", "x-filename-id":"api-v2-job_templates-id-schedules-post" } }, "/api/v2/job_templates/{id}/slice_workflow_jobs/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nworkflow jobs associated with the selected\njob template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job. (integer)
    • \n
  • type: Data type for this workflow job. (choice)
    • \n
  • url: URL for this workflow job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job was last modified. (datetime)
    • \n
  • name: Name of this workflow job. (string)
    • \n
  • description: Optional description of this workflow job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • workflow_job_template: (id)
    • \n
  • extra_vars: (json)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • job_template: If automatically created for a sliced job run, the job template the workflow job was created from. (id)
    • \n
  • is_sliced_job: (boolean)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • limit: (string)
    • \n
  • scm_branch: (string)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • webhook_guid: Unique identifier of the event that triggered this webhook (string)
    • \n
  • skip_tags: (string)
    • \n
  • job_tags: (string)
    • \n
\n

Sorting

\n

To specify that workflow jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_job_templates_slice_workflow_jobs_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Jobs for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-slice_workflow_jobs--get", "x-filename-id":"api-v2-job_templates-id-slice_workflow_jobs-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following workflow job\nfields to create a new workflow job associated with this\njob template.

\n
    \n
  • name: Name of this workflow job. (string, required)
    • \n
  • \n

    description: Optional description of this workflow job. (string, default=\"\")

    \n
    • \n
  • \n

    workflow_job_template: (id, default=``)

    \n
    • \n
  • extra_vars: (json, default=``)
    • \n
  • \n

    allow_simultaneous: (boolean, default=False)

    \n
    • \n
  • \n

    is_sliced_job: (boolean, default=False)

    \n
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • limit: (string, default=\"\")
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)
    • \n
  • webhook_guid: Unique identifier of the event that triggered this webhook (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • job_tags: (string, default=\"\")
    • \n
", "operationId":"api_job_templates_slice_workflow_jobs_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobList" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobList" } } }, "summary":"Create a Workflow Job for a Job Template", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-slice_workflow_jobs--post", "x-filename-id":"api-v2-job_templates-id-slice_workflow_jobs-post" } }, "/api/v2/job_templates/{id}/survey_spec/":{ "delete":{ "description":"

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}\n
\n

name and description are required elements at the beginning of the survey specification. spec must be a\nlist of survey items.

\n

Within each survey item type must be one of:

\n
    \n
  • text: For survey questions expecting a textual answer
    • \n
  • password: For survey questions expecting a password or other sensitive information
    • \n
  • integer: For survey questions expecting a whole number answer
    • \n
  • float: For survey questions expecting a decimal number
    • \n
  • multiplechoice: For survey questions where one option from a list is required
    • \n
  • multiselect: For survey questions where multiple items from a presented list can be selected
    • \n
\n

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.

\n

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}\n
", "operationId":"api_job_templates_survey_spec_delete", "parameters":[ ], "responses":{ "204":{ "description":"" } }, "summary":"POST Requests to This Resource Should Include the Full Specification for a Job Template's Survey", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-survey_spec--delete", "x-filename-id":"api-v2-job_templates-id-survey_spec-delete" }, "get":{ "description":"

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}\n
\n

name and description are required elements at the beginning of the survey specification. spec must be a\nlist of survey items.

\n

Within each survey item type must be one of:

\n
    \n
  • text: For survey questions expecting a textual answer
    • \n
  • password: For survey questions expecting a password or other sensitive information
    • \n
  • integer: For survey questions expecting a whole number answer
    • \n
  • float: For survey questions expecting a decimal number
    • \n
  • multiplechoice: For survey questions where one option from a list is required
    • \n
  • multiselect: For survey questions where multiple items from a presented list can be selected
    • \n
\n

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.

\n

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}\n
", "operationId":"api_job_templates_survey_spec_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Empty" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"POST Requests to This Resource Should Include the Full Specification for a Job Template's Survey", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-survey_spec--get", "x-filename-id":"api-v2-job_templates-id-survey_spec-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

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}\n
\n

name and description are required elements at the beginning of the survey specification. spec must be a\nlist of survey items.

\n

Within each survey item type must be one of:

\n
    \n
  • text: For survey questions expecting a textual answer
    • \n
  • password: For survey questions expecting a password or other sensitive information
    • \n
  • integer: For survey questions expecting a whole number answer
    • \n
  • float: For survey questions expecting a decimal number
    • \n
  • multiplechoice: For survey questions where one option from a list is required
    • \n
  • multiselect: For survey questions where multiple items from a presented list can be selected
    • \n
\n

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.

\n

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}\n
", "operationId":"api_job_templates_survey_spec_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Empty" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Empty" } } }, "summary":"POST Requests to This Resource Should Include the Full Specification for a Job Template's Survey", "tags":[ "Job Templates" ], "x-internal-id":"api-v2-job_templates-{id}-survey_spec--post", "x-filename-id":"api-v2-job_templates-id-survey_spec-post" } }, "/api/v2/job_templates/{id}/webhook_key/":{ "get":{ "description":"", "operationId":"api_job_templates_webhook_key_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Empty" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "tags":[ "Job Templates" ], "summary":"Job Templates Webhook Key List", "x-internal-id":"api-v2-job_templates-{id}-webhook_key--get", "x-filename-id":"api-v2-job_templates-id-webhook_key-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_job_templates_webhook_key_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Empty" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Empty" } } }, "tags":[ "Job Templates" ], "summary":"Job Templates Webhook Key Create", "x-internal-id":"api-v2-job_templates-{id}-webhook_key--post", "x-filename-id":"api-v2-job_templates-id-webhook_key-post" } }, "/api/v2/jobs/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\njobs.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each job data structure includes the following fields:

\n
    \n
  • id: Database ID for this job. (integer)
    • \n
  • type: Data type for this job. (choice)
    • \n
  • url: URL for this job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job was created. (datetime)
    • \n
  • modified: Timestamp when this job was last modified. (datetime)
    • \n
  • name: Name of this job. (string)
    • \n
  • description: Optional description of this job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    • scan: Scan
      • \n
    \n
    • \n
  • inventory: (id)
    • \n
  • project: (id)
    • \n
  • playbook: (string)
    • \n
  • 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)
    • \n
  • forks: (integer)
    • \n
  • limit: (string)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (json)
    • \n
  • job_tags: (string)
    • \n
  • force_handlers: (boolean)
    • \n
  • skip_tags: (string)
    • \n
  • start_at_task: (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • use_fact_cache: If enabled, the service 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)
    • \n
  • organization: The organization used to determine access to this unified job. (id)
    • \n
  • job_template: (id)
    • \n
  • passwords_needed_to_start: (field)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • artifacts: (json)
    • \n
  • scm_revision: The SCM Revision from the Project used for this job, if available (string)
    • \n
  • instance_group: The Instance group the job was run under (id)
    • \n
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • webhook_guid: Unique identifier of the event that triggered this webhook (string)
    • \n
\n

Sorting

\n

To specify that jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_jobs_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/JobList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Jobs", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs--get", "x-filename-id":"api-v2-jobs-get" }, "parameters":[ ] }, "/api/v2/jobs/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this job.

", "operationId":"api_jobs_delete", "parameters":[ ], "responses":{ "204":{ "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\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this job. (integer)
    • \n
  • type: Data type for this job. (choice)
    • \n
  • url: URL for this job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job was created. (datetime)
    • \n
  • modified: Timestamp when this job was last modified. (datetime)
    • \n
  • name: Name of this job. (string)
    • \n
  • description: Optional description of this job. (string)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    • scan: Scan
      • \n
    \n
    • \n
  • inventory: (id)
    • \n
  • project: (id)
    • \n
  • playbook: (string)
    • \n
  • 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)
    • \n
  • forks: (integer)
    • \n
  • limit: (string)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (json)
    • \n
  • job_tags: (string)
    • \n
  • force_handlers: (boolean)
    • \n
  • skip_tags: (string)
    • \n
  • start_at_task: (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • use_fact_cache: If enabled, the service 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)
    • \n
  • organization: The organization used to determine access to this unified job. (id)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_args: (string)
    • \n
  • job_cwd: (string)
    • \n
  • job_env: (json)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • result_traceback: (string)
    • \n
  • event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • job_template: (id)
    • \n
  • passwords_needed_to_start: (field)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • artifacts: (json)
    • \n
  • scm_revision: The SCM Revision from the Project used for this job, if available (string)
    • \n
  • instance_group: The Instance group the job was run under (id)
    • \n
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • webhook_guid: Unique identifier of the event that triggered this webhook (string)
    • \n
  • host_status_counts: Playbook stats from the Ansible playbook_on_stats event. (json)
    • \n
  • playbook_counts: A count of all plays and tasks for the job run. (field)
    • \n
  • custom_virtualenv: (string)
    • \n
", "operationId":"api_jobs_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/JobDetail" } } }, "summary":"Retrieve a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}--get", "x-filename-id":"api-v2-jobs-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/jobs/{id}/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\njob.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_jobs_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-activity_stream--get", "x-filename-id":"api-v2-jobs-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/jobs/{id}/cancel/":{ "get":{ "description":"

Make a GET request to this resource to determine if the job can be canceled.\nThe response will include the following field:

\n
    \n
  • can_cancel: Indicates whether this job can be canceled (boolean, read-only)
    • \n
", "operationId":"api_jobs_cancel_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/JobCancel" } } }, "summary":"Determine if a Job Can Be Canceled", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-cancel--get", "x-filename-id":"api-v2-jobs-id-cancel-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Cancel a Job

\n

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":"api_jobs_cancel_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/JobCancel" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/JobCancel" } } }, "tags":[ "Jobs" ], "summary":"Jobs Cancel Create", "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.

\n

Jobs that were launched with user-provided passwords cannot have a schedule\ncreated from them.

\n

Make a GET request for information about what those prompts are and\nwhether or not a schedule can be created.

", "operationId":"api_jobs_create_schedule_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/JobCreateSchedule" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "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.

\n

Jobs that were launched with user-provided passwords cannot have a schedule\ncreated from them.

\n

Make a GET request for information about what those prompts are and\nwhether or not a schedule can be created.

", "operationId":"api_jobs_create_schedule_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/JobCreateSchedule" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/JobCreateSchedule" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • organization: (id)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_jobs_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Credential" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials for a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-credentials--get", "x-filename-id":"api-v2-jobs-id-credentials-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/jobs/{id}/job_events/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\njob events associated with the selected\njob.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each job event data structure includes the following fields:

\n
    \n
  • id: Database ID for this job event. (integer)
    • \n
  • type: Data type for this job event. (choice)
    • \n
  • url: URL for this job event. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job event was created. (datetime)
    • \n
  • modified: Timestamp when this job event was last modified. (datetime)
    • \n
  • job: (id)
    • \n
  • event: (choice)
      \n
    • runner_on_failed: Host Failed
      • \n
    • runner_on_start: Host Started
      • \n
    • runner_on_ok: Host OK
      • \n
    • runner_on_error: Host Failure
      • \n
    • runner_on_skipped: Host Skipped
      • \n
    • runner_on_unreachable: Host Unreachable
      • \n
    • runner_on_no_hosts: No Hosts Remaining
      • \n
    • runner_on_async_poll: Host Polling
      • \n
    • runner_on_async_ok: Host Async OK
      • \n
    • runner_on_async_failed: Host Async Failure
      • \n
    • runner_item_on_ok: Item OK
      • \n
    • runner_item_on_failed: Item Failed
      • \n
    • runner_item_on_skipped: Item Skipped
      • \n
    • runner_retry: Host Retry
      • \n
    • runner_on_file_diff: File Difference
      • \n
    • playbook_on_start: Playbook Started
      • \n
    • playbook_on_notify: Running Handlers
      • \n
    • playbook_on_include: Including File
      • \n
    • playbook_on_no_hosts_matched: No Hosts Matched
      • \n
    • playbook_on_no_hosts_remaining: No Hosts Remaining
      • \n
    • playbook_on_task_start: Task Started
      • \n
    • playbook_on_vars_prompt: Variables Prompted
      • \n
    • playbook_on_setup: Gathering Facts
      • \n
    • playbook_on_import_for_host: internal: on Import for Host
      • \n
    • playbook_on_not_import_for_host: internal: on Not Import for Host
      • \n
    • playbook_on_play_start: Play Started
      • \n
    • playbook_on_stats: Playbook Complete
      • \n
    • debug: Debug
      • \n
    • verbose: Verbose
      • \n
    • deprecated: Deprecated
      • \n
    • warning: Warning
      • \n
    • system_warning: System Warning
      • \n
    • error: Error
      • \n
    \n
    • \n
  • counter: (integer)
    • \n
  • event_display: (string)
    • \n
  • event_data: (json)
    • \n
  • event_level: (integer)
    • \n
  • failed: (boolean)
    • \n
  • changed: (boolean)
    • \n
  • uuid: (string)
    • \n
  • parent_uuid: (string)
    • \n
  • host: (id)
    • \n
  • host_name: (string)
    • \n
  • playbook: (string)
    • \n
  • play: (string)
    • \n
  • task: (string)
    • \n
  • role: (string)
    • \n
  • stdout: (string)
    • \n
  • start_line: (integer)
    • \n
  • end_line: (integer)
    • \n
  • verbosity: (integer)
    • \n
\n

Sorting

\n

To specify that job events are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_jobs_job_events_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/JobEvent" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Job Events for a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-job_events--get", "x-filename-id":"api-v2-jobs-id-job_events-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/jobs/{id}/job_events/children_summary/":{ "get":{ "description":"

Special view to facilitate processing job output in the UI.\nIn order to collapse events and their children, the UI needs to know how\nmany children exist for a given event.\nThe UI also needs to know the order of the event (0 based index), which\nusually matches the counter, but not always.\nThis view returns a JSON object where the key is the event counter, and the value\nincludes the number of children (and grandchildren) events.\nOnly events with children are included in the output.

\n

Example

\n

e.g. Demo Job Template job\ntuple(event counter, uuid, parent_uuid)

\n
(1, '00000000-0000-0000-0000-000000000000', '')\n(2, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')\n(3, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')\n(4, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')\n(5, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')\n(6, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')\n(7, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')\n(8, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')\n(9, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')\n
\n

output

\n
{\n"1": {\n    "rowNumber": 0,\n    "numChildren": 8\n},\n"2": {\n    "rowNumber": 1,\n    "numChildren": 6\n},\n"3": {\n    "rowNumber": 2,\n    "numChildren": 2\n},\n"6": {\n    "rowNumber": 5,\n    "numChildren": 2\n}\n}\n"meta_event_nested_parent_uuid": {}\n}\n
\n

counter 1 is event 0, and has 8 children\ncounter 2 is event 1, and has 6 children\netc.

\n

The UI also needs to be able to collapse over \"meta\" events -- events that\nshow up due to verbosity or warnings from the system while the play is running.\nThese events have a 0 level event, with no parent uuid.

\n
playbook_on_start\nverbose\n  playbook_on_play_start\n    playbook_on_task_start\n      runner_on_start        <- level 3\nverbose                      <- jump to level 0\nverbose\n        runner_on_ok         <- jump back to level 3\n      playbook_on_task_start\n        runner_on_start\n        runner_on_ok\nverbose\nverbose\n      playbook_on_stats\n
\n

These verbose statements that fall in the middle of a series of children events\nare problematic for the UI.\nTo help, this view will attempt to place the events into the hierarchy, without\nthe event level jumps.

\n
playbook_on_start\n  verbose\n  playbook_on_play_start\n    playbook_on_task_start\n      runner_on_start        <- A\n        verbose              <- this maps to the uuid of A\n        verbose\n        runner_on_ok\n      playbook_on_task_start <- B\n        runner_on_start\n        runner_on_ok\n        verbose              <- this maps to the uuid of B\n        verbose\n      playbook_on_stats\n
\n

The output will include a JSON object where the key is the event counter,\nand the value is the assigned nested uuid.

", "operationId":"api_jobs_job_events_children_summary_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "summary":"View a Summary of Children Events", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-job_events-children_summary--get", "x-filename-id":"api-v2-jobs-id-job_events-children_summary-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/jobs/{id}/job_host_summaries/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\njob host summaries associated with the selected\njob.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each job host summary data structure includes the following fields:

\n
    \n
  • id: Database ID for this job host summary. (integer)
    • \n
  • type: Data type for this job host summary. (choice)
    • \n
  • url: URL for this job host summary. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job host summary was created. (datetime)
    • \n
  • modified: Timestamp when this job host summary was last modified. (datetime)
    • \n
  • job: (id)
    • \n
  • host: (id)
    • \n
  • constructed_host: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)
    • \n
  • host_name: (string)
    • \n
  • changed: (integer)
    • \n
  • dark: (integer)
    • \n
  • failures: (integer)
    • \n
  • ok: (integer)
    • \n
  • processed: (integer)
    • \n
  • skipped: (integer)
    • \n
  • failed: (boolean)
    • \n
  • ignored: (integer)
    • \n
  • rescued: (integer)
    • \n
\n

Sorting

\n

To specify that job host summaries are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_jobs_job_host_summaries_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/JobHostSummary" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Job Host Summaries for a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-job_host_summaries--get", "x-filename-id":"api-v2-jobs-id-job_host_summaries-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/jobs/{id}/labels/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\njob.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each label data structure includes the following fields:

\n
    \n
  • id: Database ID for this label. (integer)
    • \n
  • type: Data type for this label. (choice)
    • \n
  • url: URL for this label. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this label was created. (datetime)
    • \n
  • modified: Timestamp when this label was last modified. (datetime)
    • \n
  • name: Name of this label. (string)
    • \n
  • organization: Organization this label belongs to. (id)
    • \n
\n

Sorting

\n

To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_jobs_labels_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Label" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Labels for a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-labels--get", "x-filename-id":"api-v2-jobs-id-labels-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/jobs/{id}/notifications/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\njob.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification. (integer)
    • \n
  • type: Data type for this notification. (choice)
    • \n
  • url: URL for this notification. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification was created. (datetime)
    • \n
  • modified: Timestamp when this notification was last modified. (datetime)
    • \n
  • notification_template: (id)
    • \n
  • error: (string)
    • \n
  • status: (choice)
      \n
    • pending: Pending
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    \n
    • \n
  • notifications_sent: (integer)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • recipients: (string)
    • \n
  • subject: (string)
    • \n
  • body: Notification body (json)
    • \n
\n

Sorting

\n

To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_jobs_notifications_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Notification" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notifications for a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-notifications--get", "x-filename-id":"api-v2-jobs-id-notifications-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/jobs/{id}/relaunch/":{ "get":{ "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":"api_jobs_relaunch_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/JobRelaunch" } } }, "summary":"Relaunch a Job", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-relaunch--get", "x-filename-id":"api-v2-jobs-id-relaunch-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "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":"api_jobs_relaunch_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/JobRelaunch" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/JobRelaunch" } } }, "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.

\n

Format

\n

Use the format query string parameter to specify the output format.

\n
    \n
  • Browsable API: ?format=api
    • \n
  • HTML: ?format=html
    • \n
  • Plain Text: ?format=txt
    • \n
  • Plain Text with ANSI color codes: ?format=ansi
    • \n
  • JSON structure: ?format=json
    • \n
  • Downloaded Plain Text: ?format=txt_download
    • \n
  • Downloaded Plain Text with ANSI color codes: ?format=ansi_download
    • \n
\n

(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.

\n

Use dark=1 or dark=0 as a query string parameter to force or disable a\ndark background.

\n

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.

", "operationId":"api_jobs_stdout_read", "parameters":[ ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/UnifiedJobStdout" } } }, "summary":"Retrieve Job Stdout", "tags":[ "Jobs" ], "x-internal-id":"api-v2-jobs-{id}-stdout--get", "x-filename-id":"api-v2-jobs-id-stdout-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/labels/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nlabels.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each label data structure includes the following fields:

\n
    \n
  • id: Database ID for this label. (integer)
    • \n
  • type: Data type for this label. (choice)
    • \n
  • url: URL for this label. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this label was created. (datetime)
    • \n
  • modified: Timestamp when this label was last modified. (datetime)
    • \n
  • name: Name of this label. (string)
    • \n
  • organization: Organization this label belongs to. (id)
    • \n
\n

Sorting

\n

To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_labels_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Label" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Labels", "tags":[ "Labels" ], "x-internal-id":"api-v2-labels--get", "x-filename-id":"api-v2-labels-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following label\nfields to create a new label:

\n
    \n
  • name: Name of this label. (string, required)
    • \n
  • organization: Organization this label belongs to. (id, required)
    • \n
", "operationId":"api_labels_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Label" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Label" } } }, "summary":"Create a Label", "tags":[ "Labels" ], "x-internal-id":"api-v2-labels--post", "x-filename-id":"api-v2-labels-post" } }, "/api/v2/labels/{id}/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single label\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this label. (integer)
    • \n
  • type: Data type for this label. (choice)
    • \n
  • url: URL for this label. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this label was created. (datetime)
    • \n
  • modified: Timestamp when this label was last modified. (datetime)
    • \n
  • name: Name of this label. (string)
    • \n
  • organization: Organization this label belongs to. (id)
    • \n
", "operationId":"api_labels_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Label" } } }, "summary":"Retrieve a Label", "tags":[ "Labels" ], "x-internal-id":"api-v2-labels-{id}--get", "x-filename-id":"api-v2-labels-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\nlabel. The following fields may be modified:

\n
    \n
  • name: Name of this label. (string, required)
    • \n
  • organization: Organization this label belongs to. (id, required)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_labels_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Label" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Label" } } }, "summary":"Update a Label", "tags":[ "Labels" ], "x-internal-id":"api-v2-labels-{id}--patch", "x-filename-id":"api-v2-labels-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\nlabel. The following fields may be modified:

\n
    \n
  • name: Name of this label. (string, required)
    • \n
  • organization: Organization this label belongs to. (id, required)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_labels_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Label" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Label" } } }, "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.

\n

One result should be returned containing the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Use the primary URL for the user (/api/v2/users/N/) to modify the user.

", "operationId":"api_me_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/User" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"Retrieve Information About the Current User", "tags":[ "Me" ], "x-internal-id":"api-v2-me--get", "x-filename-id":"api-v2-me-get" }, "parameters":[ ] }, "/api/v2/mesh_visualizer/":{ "get":{ "description":"

Make a GET request to this resource to obtain a list all Receptor Nodes and their links.

", "operationId":"api_mesh_visualizer_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Mesh Visualizer" ], "summary":"Mesh Visualizer List", "x-internal-id":"api-v2-mesh_visualizer--get", "x-filename-id":"api-v2-mesh_visualizer-get" }, "parameters":[ ] }, "/api/v2/metrics/":{ "get":{ "description":"

Show Metrics Details

", "operationId":"api_metrics_list", "parameters":[ ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"" } }, "tags":[ "Metrics" ], "summary":"Metrics List", "x-internal-id":"api-v2-metrics--get", "x-filename-id":"api-v2-metrics-get" }, "parameters":[ ] }, "/api/v2/notification_templates/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nnotification templates.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_notification_templates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates", "tags":[ "Notification Templates" ], "x-internal-id":"api-v2-notification_templates--get", "x-filename-id":"api-v2-notification_templates-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template:

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
", "operationId":"api_notification_templates_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template", "tags":[ "Notification Templates" ], "x-internal-id":"api-v2-notification_templates--post", "x-filename-id":"api-v2-notification_templates-post" } }, "/api/v2/notification_templates/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this notification template.

", "operationId":"api_notification_templates_delete", "parameters":[ ], "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:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
", "operationId":"api_notification_templates_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Retrieve a Notification Template", "tags":[ "Notification Templates" ], "x-internal-id":"api-v2-notification_templates-{id}--get", "x-filename-id":"api-v2-notification_templates-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\nnotification template. The following fields may be modified:

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_notification_templates_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "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":{ "description":"

Make a PUT or PATCH request to this resource to update this\nnotification template. The following fields may be modified:

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_notification_templates_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "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":{ "description":"", "operationId":"api_notification_templates_copy_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Copy" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_notification_templates_copy_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Copy" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Copy" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification. (integer)
    • \n
  • type: Data type for this notification. (choice)
    • \n
  • url: URL for this notification. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification was created. (datetime)
    • \n
  • modified: Timestamp when this notification was last modified. (datetime)
    • \n
  • notification_template: (id)
    • \n
  • error: (string)
    • \n
  • status: (choice)
      \n
    • pending: Pending
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    \n
    • \n
  • notifications_sent: (integer)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • recipients: (string)
    • \n
  • subject: (string)
    • \n
  • body: Notification body (json)
    • \n
\n

Sorting

\n

To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_notification_templates_notifications_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Notification" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notifications for a Notification Template", "tags":[ "Notification Templates" ], "x-internal-id":"api-v2-notification_templates-{id}-notifications--get", "x-filename-id":"api-v2-notification_templates-id-notifications-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/notification_templates/{id}/test/":{ "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Test a Notification Template

", "operationId":"api_notification_templates_test_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Empty" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Empty" } } }, "tags":[ "Notification Templates" ], "summary":"Notification Templates Test Create", "x-internal-id":"api-v2-notification_templates-{id}-test--post", "x-filename-id":"api-v2-notification_templates-id-test-post" } }, "/api/v2/notifications/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nnotifications.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification. (integer)
    • \n
  • type: Data type for this notification. (choice)
    • \n
  • url: URL for this notification. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification was created. (datetime)
    • \n
  • modified: Timestamp when this notification was last modified. (datetime)
    • \n
  • notification_template: (id)
    • \n
  • error: (string)
    • \n
  • status: (choice)
      \n
    • pending: Pending
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    \n
    • \n
  • notifications_sent: (integer)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • recipients: (string)
    • \n
  • subject: (string)
    • \n
  • body: Notification body (json)
    • \n
\n

Sorting

\n

To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_notifications_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Notification" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notifications", "tags":[ "Notifications" ], "x-internal-id":"api-v2-notifications--get", "x-filename-id":"api-v2-notifications-get" }, "parameters":[ ] }, "/api/v2/notifications/{id}/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single notification\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this notification. (integer)
    • \n
  • type: Data type for this notification. (choice)
    • \n
  • url: URL for this notification. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification was created. (datetime)
    • \n
  • modified: Timestamp when this notification was last modified. (datetime)
    • \n
  • notification_template: (id)
    • \n
  • error: (string)
    • \n
  • status: (choice)
      \n
    • pending: Pending
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    \n
    • \n
  • notifications_sent: (integer)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • recipients: (string)
    • \n
  • subject: (string)
    • \n
  • body: Notification body (json)
    • \n
", "operationId":"api_notifications_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Notification" } } }, "summary":"Retrieve a Notification", "tags":[ "Notifications" ], "x-internal-id":"api-v2-notifications-{id}--get", "x-filename-id":"api-v2-notifications-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/organizations/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\norganizations.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each organization data structure includes the following fields:

\n
    \n
  • id: Database ID for this organization. (integer)
    • \n
  • type: Data type for this organization. (choice)
    • \n
  • url: URL for this organization. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this organization was created. (datetime)
    • \n
  • modified: Timestamp when this organization was last modified. (datetime)
    • \n
  • name: Name of this organization. (string)
    • \n
  • description: Optional description of this organization. (string)
    • \n
  • max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • default_environment: The default execution environment for jobs run by this organization. (id)
    • \n
\n

Sorting

\n

To specify that organizations are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Organization" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Organizations", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations--get", "x-filename-id":"api-v2-organizations-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following organization\nfields to create a new organization:

\n
    \n
  • name: Name of this organization. (string, required)
    • \n
  • description: Optional description of this organization. (string, default=\"\")
    • \n
  • \n

    max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer, default=0)

    \n
    • \n
  • \n

    default_environment: The default execution environment for jobs run by this organization. (id, default=``)

    \n
    • \n
", "operationId":"api_organizations_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Organization" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Organization" } } }, "summary":"Create an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations--post", "x-filename-id":"api-v2-organizations-post" } }, "/api/v2/organizations/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this organization.

", "operationId":"api_organizations_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this organization. (integer)
    • \n
  • type: Data type for this organization. (choice)
    • \n
  • url: URL for this organization. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this organization was created. (datetime)
    • \n
  • modified: Timestamp when this organization was last modified. (datetime)
    • \n
  • name: Name of this organization. (string)
    • \n
  • description: Optional description of this organization. (string)
    • \n
  • max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • default_environment: The default execution environment for jobs run by this organization. (id)
    • \n
", "operationId":"api_organizations_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Organization" } } }, "summary":"Retrieve an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}--get", "x-filename-id":"api-v2-organizations-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\norganization. The following fields may be modified:

\n
    \n
  • name: Name of this organization. (string, required)
    • \n
  • description: Optional description of this organization. (string, default=\"\")
    • \n
  • \n

    max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer, default=0)

    \n
    • \n
  • \n

    default_environment: The default execution environment for jobs run by this organization. (id, default=``)

    \n
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_organizations_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Organization" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Organization" } } }, "summary":"Update an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}--patch", "x-filename-id":"api-v2-organizations-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\norganization. The following fields may be modified:

\n
    \n
  • name: Name of this organization. (string, required)
    • \n
  • description: Optional description of this organization. (string, default=\"\")
    • \n
  • \n

    max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer, default=0)

    \n
    • \n
  • \n

    default_environment: The default execution environment for jobs run by this organization. (id, default=``)

    \n
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_organizations_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Organization" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Organization" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_access_list_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ResourceAccessListElement" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-access_list--get", "x-filename-id":"api-v2-organizations-id-access_list-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/organizations/{id}/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-activity_stream--get", "x-filename-id":"api-v2-organizations-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/organizations/{id}/admins/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nadmin users associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each admin user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that admin users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_admins_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/User" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Admin Users for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-admins--get", "x-filename-id":"api-v2-organizations-id-admins-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following admin user\nfields to create a new admin user associated with this\norganization.

\n
    \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)
    • \n
  • first_name: (string, default=\"\")
    • \n
  • last_name: (string, default=\"\")
    • \n
  • email: (string, default=\"\")
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)
    • \n
  • is_system_auditor: (boolean, default=False)
    • \n
  • password: Field used to change the password. (string, default=\"\")
    • \n
\n

Add Admin Users for an Organization:

\n

Make a POST request to this resource with only an id field to associate an\nexisting admin user with this organization.

\n

Remove Admin Users from this Organization:

\n

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.

", "operationId":"api_organizations_admins_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/User" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/User" } } }, "summary":"Create an Admin User for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-admins--post", "x-filename-id":"api-v2-organizations-id-admins-post" } }, "/api/v2/organizations/{id}/applications/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\napplications associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each application data structure includes the following fields:

\n
    \n
  • id: Database ID for this application. (integer)
    • \n
  • type: Data type for this application. (choice)
    • \n
  • url: URL for this application. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this application was created. (datetime)
    • \n
  • modified: Timestamp when this application was last modified. (datetime)
    • \n
  • name: Name of this application. (string)
    • \n
  • description: Optional description of this application. (string)
    • \n
  • client_id: (string)
    • \n
  • client_secret: Used for more stringent verification of access to an application when creating a token. (string)
    • \n
  • client_type: Set to Public or Confidential depending on how secure the client device is. (choice)
      \n
    • confidential: Confidential
      • \n
    • public: Public
      • \n
    \n
    • \n
  • redirect_uris: Allowed URIs list, space separated (string)
    • \n
  • authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice)
      \n
    • authorization-code: Authorization code
      • \n
    • password: Resource owner password-based
      • \n
    \n
    • \n
  • skip_authorization: Set True to skip authorization step for completely trusted applications. (boolean)
    • \n
  • organization: Organization containing this application. (id)
    • \n
\n

Sorting

\n

To specify that applications are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_applications_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/OAuth2Application" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Applications for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-applications--get", "x-filename-id":"api-v2-organizations-id-applications-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following application\nfields to create a new application associated with this\norganization.

\n
    \n
  • name: Name of this application. (string, required)
    • \n
  • \n

    description: Optional description of this application. (string, default=\"\")

    \n
    • \n
  • \n

    client_type: Set to Public or Confidential depending on how secure the client device is. (choice, required)

    \n
      \n
    • confidential: Confidential
      • \n
    • public: Public
      • \n
    \n
    • \n
  • redirect_uris: Allowed URIs list, space separated (string, default=\"\")
    • \n
  • authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice, required)
      \n
    • authorization-code: Authorization code
      • \n
    • password: Resource owner password-based
      • \n
    \n
    • \n
  • skip_authorization: Set True to skip authorization step for completely trusted applications. (boolean, default=False)
    • \n
", "operationId":"api_organizations_applications_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/OAuth2Application" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/OAuth2Application" } } }, "summary":"Create an Application for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-applications--post", "x-filename-id":"api-v2-organizations-id-applications-post" } }, "/api/v2/organizations/{id}/credentials/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • organization: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/OrganizationCredentialSerializerCreate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-credentials--get", "x-filename-id":"api-v2-organizations-id-credentials-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following credential\nfields to create a new credential associated with this\norganization.

\n
    \n
  • name: Name of this credential. (string, required)
    • \n
  • \n

    description: Optional description of this credential. (string, default=\"\")

    \n
    • \n
  • \n

    credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
", "operationId":"api_organizations_credentials_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/OrganizationCredentialSerializerCreate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/OrganizationCredentialSerializerCreate" } } }, "summary":"Create a Credential for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-credentials--post", "x-filename-id":"api-v2-organizations-id-credentials-post" } }, "/api/v2/organizations/{id}/execution_environments/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nexecution environments associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The count field indicates the total number of execution environments\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 execution environment records.

\n

Results

\n

Each execution environment data structure includes the following fields:

\n
    \n
  • id: Database ID for this execution environment. (integer)
    • \n
  • type: Data type for this execution environment. (choice)
    • \n
  • url: URL for this execution environment. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this execution environment was created. (datetime)
    • \n
  • modified: Timestamp when this execution environment was last modified. (datetime)
    • \n
  • name: Name of this execution environment. (string)
    • \n
  • description: Optional description of this execution environment. (string)
    • \n
  • organization: The organization used to determine access to this execution environment. (id)
    • \n
  • image: The full image location, including the container registry, image name, and version tag. (string)
    • \n
  • managed: (boolean)
    • \n
  • credential: (id)
    • \n
  • pull: Pull image before running? (choice)
      \n
    • \"\": ---------
      • \n
    • always: Always pull container before running.
      • \n
    • missing: Only pull the image if not present before running.
      • \n
    • never: Never pull container before running.
      • \n
    \n
    • \n
\n

Sorting

\n

To specify that execution environments are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_execution_environments_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ExecutionEnvironment" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Execution Environments for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-execution_environments--get", "x-filename-id":"api-v2-organizations-id-execution_environments-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following execution environment\nfields to create a new execution environment associated with this\norganization.

\n
    \n
  • name: Name of this execution environment. (string, required)
    • \n
  • \n

    description: Optional description of this execution environment. (string, default=\"\")

    \n
    • \n
  • \n

    image: The full image location, including the container registry, image name, and version tag. (string, required)

    \n
    • \n
  • \n

    credential: (id, default=``)

    \n
    • \n
  • pull: Pull image before running? (choice)
      \n
    • \"\": --------- (default)
      • \n
    • always: Always pull container before running.
      • \n
    • missing: Only pull the image if not present before running.
      • \n
    • never: Never pull container before running.
      • \n
    \n
    • \n
\n

Remove Organization Execution Environments:

\n

Make a POST request to this resource with id and disassociate fields to\ndelete the associated execution environment.

\n
{\n    \"id\": 123,\n    \"disassociate\": true\n}\n
", "operationId":"api_organizations_execution_environments_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/ExecutionEnvironment" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/ExecutionEnvironment" } } }, "summary":"Create an Execution Environment for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-execution_environments--post", "x-filename-id":"api-v2-organizations-id-execution_environments-post" } }, "/api/v2/organizations/{id}/galaxy_credentials/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • organization: (id)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_galaxy_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Credential" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-galaxy_credentials--get", "x-filename-id":"api-v2-organizations-id-galaxy_credentials-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following credential\nfields to create a new credential associated with this\norganization.

\n
    \n
  • name: Name of this credential. (string, required)
    • \n
  • description: Optional description of this credential. (string, default=\"\")
    • \n
  • organization: (id, default=None)
    • \n
  • \n

    credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
\n

Add Credentials for an Organization:

\n

Make a POST request to this resource with only an id field to associate an\nexisting credential with this organization.

\n

Remove Credentials from this Organization:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the credential from this organization\n without deleting the credential.

", "operationId":"api_organizations_galaxy_credentials_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Credential" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Credential" } } }, "summary":"Create a Credential for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-galaxy_credentials--post", "x-filename-id":"api-v2-organizations-id-galaxy_credentials-post" } }, "/api/v2/organizations/{id}/instance_groups/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each instance group data structure includes the following fields:

\n
    \n
  • id: Database ID for this instance group. (integer)
    • \n
  • type: Data type for this instance group. (choice)
    • \n
  • url: URL for this instance group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • name: Name of this instance group. (string)
    • \n
  • created: Timestamp when this instance group was created. (datetime)
    • \n
  • modified: Timestamp when this instance group was last modified. (datetime)
    • \n
  • capacity: (field)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: (field)
    • \n
  • max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance group (integer)
    • \n
  • instances: (field)
    • \n
  • is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)
    • \n
  • credential: (id)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json)
    • \n
  • pod_spec_override: (string)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
\n

Sorting

\n

To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_instance_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InstanceGroup" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Instance Groups for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-instance_groups--get", "x-filename-id":"api-v2-organizations-id-instance_groups-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following instance group\nfields to create a new instance group associated with this\norganization.

\n
    \n
  • \n

    name: Name of this instance group. (string, required)

    \n
    • \n
  • \n

    max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)

    \n
    • \n
  • credential: (id, default=``)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)
    • \n
  • pod_spec_override: (string, default=\"\")
    • \n
\n

Add Instance Groups for an Organization:

\n

Make a POST request to this resource with only an id field to associate an\nexisting instance group with this organization.

\n

Remove Instance Groups from this Organization:

\n

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.

", "operationId":"api_organizations_instance_groups_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InstanceGroup" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InstanceGroup" } } }, "summary":"Create an Instance Group for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-instance_groups--post", "x-filename-id":"api-v2-organizations-id-instance_groups-post" } }, "/api/v2/organizations/{id}/inventories/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninventories associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory. (integer)
    • \n
  • type: Data type for this inventory. (choice)
    • \n
  • url: URL for this inventory. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory was created. (datetime)
    • \n
  • modified: Timestamp when this inventory was last modified. (datetime)
    • \n
  • name: Name of this inventory. (string)
    • \n
  • description: Optional description of this inventory. (string)
    • \n
  • organization: Organization containing this inventory. (id)
    • \n
  • kind: Kind of inventory being represented. (choice)
      \n
    • \"\": Hosts have a direct link to this inventory.
      • \n
    • smart: Hosts for inventory generated using the host_filter property.
      • \n
    • constructed: Parse list of source inventories with the constructed inventory plugin.
      • \n
    \n
    • \n
  • host_filter: Filter that will be applied to the hosts of this inventory. (string)
    • \n
  • variables: Inventory variables in JSON or YAML format. (json)
    • \n
  • 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)
    • \n
  • total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)
    • \n
  • 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)
    • \n
  • total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)
    • \n
  • inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)
    • \n
  • pending_deletion: Flag indicating the inventory is being deleted. (boolean)
    • \n
  • prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)
    • \n
\n

Sorting

\n

To specify that inventories are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_inventories_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Inventory" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventories for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-inventories--get", "x-filename-id":"api-v2-organizations-id-inventories-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/organizations/{id}/job_templates/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\njob templates associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each job template data structure includes the following fields:

\n
    \n
  • id: Database ID for this job template. (integer)
    • \n
  • type: Data type for this job template. (choice)
    • \n
  • url: URL for this job template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this job template was created. (datetime)
    • \n
  • modified: Timestamp when this job template was last modified. (datetime)
    • \n
  • name: Name of this job template. (string)
    • \n
  • description: Optional description of this job template. (string)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id)
    • \n
  • project: (id)
    • \n
  • playbook: (string)
    • \n
  • 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)
    • \n
  • forks: (integer)
    • \n
  • limit: (string)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (json)
    • \n
  • job_tags: (string)
    • \n
  • force_handlers: (boolean)
    • \n
  • skip_tags: (string)
    • \n
  • start_at_task: (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • use_fact_cache: If enabled, the service 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)
    • \n
  • organization: The organization used to determine access to this template. (id)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • host_config_key: (string)
    • \n
  • ask_scm_branch_on_launch: (boolean)
    • \n
  • ask_diff_mode_on_launch: (boolean)
    • \n
  • ask_variables_on_launch: (boolean)
    • \n
  • ask_limit_on_launch: (boolean)
    • \n
  • ask_tags_on_launch: (boolean)
    • \n
  • ask_skip_tags_on_launch: (boolean)
    • \n
  • ask_job_type_on_launch: (boolean)
    • \n
  • ask_verbosity_on_launch: (boolean)
    • \n
  • ask_inventory_on_launch: (boolean)
    • \n
  • ask_credential_on_launch: (boolean)
    • \n
  • ask_execution_environment_on_launch: (boolean)
    • \n
  • ask_labels_on_launch: (boolean)
    • \n
  • ask_forks_on_launch: (boolean)
    • \n
  • ask_job_slice_count_on_launch: (boolean)
    • \n
  • ask_timeout_on_launch: (boolean)
    • \n
  • ask_instance_groups_on_launch: (boolean)
    • \n
  • survey_enabled: (boolean)
    • \n
  • become_enabled: (boolean)
    • \n
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • 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)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • prevent_instance_group_fallback: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)
    • \n
\n

Sorting

\n

To specify that job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_job_templates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/JobTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Job Templates for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-job_templates--get", "x-filename-id":"api-v2-organizations-id-job_templates-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following job template\nfields to create a new job template associated with this\norganization.

\n
    \n
  • name: Name of this job template. (string, required)
    • \n
  • description: Optional description of this job template. (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • run: Run (default)
      • \n
    • check: Check
      • \n
    \n
    • \n
  • inventory: (id, default=``)
    • \n
  • project: (id, default=``)
    • \n
  • playbook: (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • forks: (integer, default=0)
    • \n
  • limit: (string, default=\"\")
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (Normal) (default)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • extra_vars: (json, default=``)
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • force_handlers: (boolean, default=False)
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • start_at_task: (string, default=\"\")
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)
    • \n
  • \n

    use_fact_cache: If enabled, the service 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)

    \n
    • \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • host_config_key: (string, default=\"\")
    • \n
  • ask_scm_branch_on_launch: (boolean, default=False)
    • \n
  • ask_diff_mode_on_launch: (boolean, default=False)
    • \n
  • ask_variables_on_launch: (boolean, default=False)
    • \n
  • ask_limit_on_launch: (boolean, default=False)
    • \n
  • ask_tags_on_launch: (boolean, default=False)
    • \n
  • ask_skip_tags_on_launch: (boolean, default=False)
    • \n
  • ask_job_type_on_launch: (boolean, default=False)
    • \n
  • ask_verbosity_on_launch: (boolean, default=False)
    • \n
  • ask_inventory_on_launch: (boolean, default=False)
    • \n
  • ask_credential_on_launch: (boolean, default=False)
    • \n
  • ask_execution_environment_on_launch: (boolean, default=False)
    • \n
  • ask_labels_on_launch: (boolean, default=False)
    • \n
  • ask_forks_on_launch: (boolean, default=False)
    • \n
  • ask_job_slice_count_on_launch: (boolean, default=False)
    • \n
  • ask_timeout_on_launch: (boolean, default=False)
    • \n
  • ask_instance_groups_on_launch: (boolean, default=False)
    • \n
  • survey_enabled: (boolean, default=False)
    • \n
  • become_enabled: (boolean, default=False)
    • \n
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=False)
    • \n
  • \n

    allow_simultaneous: (boolean, default=False)

    \n
    • \n
  • \n

    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)

    \n
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)
    • \n
  • prevent_instance_group_fallback: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)
    • \n
", "operationId":"api_organizations_job_templates_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/JobTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/JobTemplate" } } }, "summary":"Create a Job Template for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-job_templates--post", "x-filename-id":"api-v2-organizations-id-job_templates-post" } }, "/api/v2/organizations/{id}/notification_templates/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_notification_templates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-notification_templates--get", "x-filename-id":"api-v2-organizations-id-notification_templates-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\norganization.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • \n

    description: Optional description of this notification template. (string, default=\"\")

    \n
    • \n
  • \n

    notification_type: (choice, required)

    \n
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Remove Organization Notification Templates:

\n

Make a POST request to this resource with id and disassociate fields to\ndelete the associated notification template.

\n
{\n    \"id\": 123,\n    \"disassociate\": true\n}\n
", "operationId":"api_organizations_notification_templates_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-notification_templates--post", "x-filename-id":"api-v2-organizations-id-notification_templates-post" } }, "/api/v2/organizations/{id}/notification_templates_approvals/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_notification_templates_approvals_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-notification_templates_approvals--get", "x-filename-id":"api-v2-organizations-id-notification_templates_approvals-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\norganization.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for an Organization:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this organization.

\n

Remove Notification Templates from this Organization:

\n

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.

", "operationId":"api_organizations_notification_templates_approvals_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-notification_templates_approvals--post", "x-filename-id":"api-v2-organizations-id-notification_templates_approvals-post" } }, "/api/v2/organizations/{id}/notification_templates_error/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_notification_templates_error_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-notification_templates_error--get", "x-filename-id":"api-v2-organizations-id-notification_templates_error-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\norganization.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for an Organization:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this organization.

\n

Remove Notification Templates from this Organization:

\n

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.

", "operationId":"api_organizations_notification_templates_error_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-notification_templates_error--post", "x-filename-id":"api-v2-organizations-id-notification_templates_error-post" } }, "/api/v2/organizations/{id}/notification_templates_started/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_notification_templates_started_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-notification_templates_started--get", "x-filename-id":"api-v2-organizations-id-notification_templates_started-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\norganization.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for an Organization:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this organization.

\n

Remove Notification Templates from this Organization:

\n

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.

", "operationId":"api_organizations_notification_templates_started_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-notification_templates_started--post", "x-filename-id":"api-v2-organizations-id-notification_templates_started-post" } }, "/api/v2/organizations/{id}/notification_templates_success/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_notification_templates_success_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-notification_templates_success--get", "x-filename-id":"api-v2-organizations-id-notification_templates_success-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\norganization.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for an Organization:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this organization.

\n

Remove Notification Templates from this Organization:

\n

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.

", "operationId":"api_organizations_notification_templates_success_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-notification_templates_success--post", "x-filename-id":"api-v2-organizations-id-notification_templates_success-post" } }, "/api/v2/organizations/{id}/object_roles/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nroles associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_object_roles_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Role" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-object_roles--get", "x-filename-id":"api-v2-organizations-id-object_roles-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/organizations/{id}/projects/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nprojects associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each project data structure includes the following fields:

\n
    \n
  • id: Database ID for this project. (integer)
    • \n
  • type: Data type for this project. (choice)
    • \n
  • url: URL for this project. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this project was created. (datetime)
    • \n
  • modified: Timestamp when this project was last modified. (datetime)
    • \n
  • name: Name of this project. (string)
    • \n
  • description: Optional description of this project. (string)
    • \n
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)
    • \n
  • scm_type: Specifies the source control system used to store the project. (choice)
      \n
    • \"\": Manual
      • \n
    • git: Git
      • \n
    • svn: Subversion
      • \n
    • insights: Red Hat Insights
      • \n
    • archive: Remote Archive
      • \n
    \n
    • \n
  • scm_url: The location where the project is stored. (string)
    • \n
  • scm_branch: Specific branch, tag or commit to checkout. (string)
    • \n
  • scm_refspec: For git projects, an additional refspec to fetch. (string)
    • \n
  • scm_clean: Discard any local changes before syncing the project. (boolean)
    • \n
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean)
    • \n
  • scm_delete_on_update: Delete the project before syncing. (boolean)
    • \n
  • credential: (id)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • scm_revision: The last revision fetched by a project update (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    \n
    • \n
  • organization: The organization used to determine access to this template. (id)
    • \n
  • scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean)
    • \n
  • 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)
    • \n
  • allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • default_environment: The default execution environment for jobs run using this project. (id)
    • \n
  • signature_validation_credential: An optional credential used for validating files in the project against unexpected changes. (id)
    • \n
  • last_update_failed: (boolean)
    • \n
  • last_updated: (datetime)
    • \n
\n

Sorting

\n

To specify that projects are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_projects_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Project" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Projects for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-projects--get", "x-filename-id":"api-v2-organizations-id-projects-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following project\nfields to create a new project associated with this\norganization.

\n
    \n
  • name: Name of this project. (string, required)
    • \n
  • description: Optional description of this project. (string, default=\"\")
    • \n
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=\"\")
    • \n
  • scm_type: Specifies the source control system used to store the project. (choice)
      \n
    • \"\": Manual (default)
      • \n
    • git: Git
      • \n
    • svn: Subversion
      • \n
    • insights: Red Hat Insights
      • \n
    • archive: Remote Archive
      • \n
    \n
    • \n
  • scm_url: The location where the project is stored. (string, default=\"\")
    • \n
  • scm_branch: Specific branch, tag or commit to checkout. (string, default=\"\")
    • \n
  • scm_refspec: For git projects, an additional refspec to fetch. (string, default=\"\")
    • \n
  • scm_clean: Discard any local changes before syncing the project. (boolean, default=False)
    • \n
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean, default=False)
    • \n
  • scm_delete_on_update: Delete the project before syncing. (boolean, default=False)
    • \n
  • credential: (id, default=``)
    • \n
  • \n

    timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)

    \n
    • \n
  • \n

    scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean, default=False)

    \n
    • \n
  • 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)
    • \n
  • \n

    allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=False)

    \n
    • \n
  • \n

    default_environment: The default execution environment for jobs run using this project. (id, default=``)

    \n
    • \n
  • signature_validation_credential: An optional credential used for validating files in the project against unexpected changes. (id, default=``)
    • \n
", "operationId":"api_organizations_projects_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Project" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Project" } } }, "summary":"Create a Project for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-projects--post", "x-filename-id":"api-v2-organizations-id-projects-post" } }, "/api/v2/organizations/{id}/teams/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nteams associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each team data structure includes the following fields:

\n
    \n
  • id: Database ID for this team. (integer)
    • \n
  • type: Data type for this team. (choice)
    • \n
  • url: URL for this team. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this team was created. (datetime)
    • \n
  • modified: Timestamp when this team was last modified. (datetime)
    • \n
  • name: Name of this team. (string)
    • \n
  • description: Optional description of this team. (string)
    • \n
  • organization: (id)
    • \n
\n

Sorting

\n

To specify that teams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_teams_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Team" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Teams for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-teams--get", "x-filename-id":"api-v2-organizations-id-teams-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following team\nfields to create a new team associated with this\norganization.

\n
    \n
  • name: Name of this team. (string, required)
    • \n
  • description: Optional description of this team. (string, default=\"\")
    • \n
\n

Remove Organization Teams:

\n

Make a POST request to this resource with id and disassociate fields to\ndelete the associated team.

\n
{\n    \"id\": 123,\n    \"disassociate\": true\n}\n
", "operationId":"api_organizations_teams_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Team" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Team" } } }, "summary":"Create a Team for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-teams--post", "x-filename-id":"api-v2-organizations-id-teams-post" } }, "/api/v2/organizations/{id}/users/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nusers associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_users_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/User" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-users--get", "x-filename-id":"api-v2-organizations-id-users-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following user\nfields to create a new user associated with this\norganization.

\n
    \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)
    • \n
  • first_name: (string, default=\"\")
    • \n
  • last_name: (string, default=\"\")
    • \n
  • email: (string, default=\"\")
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)
    • \n
  • is_system_auditor: (boolean, default=False)
    • \n
  • password: Field used to change the password. (string, default=\"\")
    • \n
\n

Add Users for an Organization:

\n

Make a POST request to this resource with only an id field to associate an\nexisting user with this organization.

\n

Remove Users from this Organization:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the user from this organization\n without deleting the user.

", "operationId":"api_organizations_users_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/User" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/User" } } }, "summary":"Create a User for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-users--post", "x-filename-id":"api-v2-organizations-id-users-post" } }, "/api/v2/organizations/{id}/workflow_job_templates/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nworkflow job templates associated with the selected\norganization.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job template data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job template. (integer)
    • \n
  • type: Data type for this workflow job template. (choice)
    • \n
  • url: URL for this workflow job template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job template was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job template was last modified. (datetime)
    • \n
  • name: Name of this workflow job template. (string)
    • \n
  • description: Optional description of this workflow job template. (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    • none: No External Source
      • \n
    • updating: Updating
      • \n
    \n
    • \n
  • extra_vars: (json)
    • \n
  • organization: The organization used to determine access to this template. (id)
    • \n
  • survey_enabled: (boolean)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • ask_variables_on_launch: (boolean)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • limit: (string)
    • \n
  • scm_branch: (string)
    • \n
  • ask_inventory_on_launch: (boolean)
    • \n
  • ask_scm_branch_on_launch: (boolean)
    • \n
  • ask_limit_on_launch: (boolean)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • ask_labels_on_launch: (boolean)
    • \n
  • ask_skip_tags_on_launch: (boolean)
    • \n
  • ask_tags_on_launch: (boolean)
    • \n
  • skip_tags: (string)
    • \n
  • job_tags: (string)
    • \n
\n

Sorting

\n

To specify that workflow job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_organizations_workflow_job_templates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Job Templates for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-workflow_job_templates--get", "x-filename-id":"api-v2-organizations-id-workflow_job_templates-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following workflow job template\nfields to create a new workflow job template associated with this\norganization.

\n
    \n
  • name: Name of this workflow job template. (string, required)
    • \n
  • \n

    description: Optional description of this workflow job template. (string, default=\"\")

    \n
    • \n
  • \n

    extra_vars: (json, default=``)

    \n
    • \n
  • \n

    survey_enabled: (boolean, default=False)

    \n
    • \n
  • allow_simultaneous: (boolean, default=False)
    • \n
  • ask_variables_on_launch: (boolean, default=False)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • limit: (string, default=\"\")
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • ask_inventory_on_launch: (boolean, default=False)
    • \n
  • ask_scm_branch_on_launch: (boolean, default=False)
    • \n
  • ask_limit_on_launch: (boolean, default=False)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)
    • \n
  • ask_labels_on_launch: (boolean, default=False)
    • \n
  • ask_skip_tags_on_launch: (boolean, default=False)
    • \n
  • ask_tags_on_launch: (boolean, default=False)
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • job_tags: (string, default=\"\")
    • \n
", "operationId":"api_organizations_workflow_job_templates_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplate" } } }, "summary":"Create a Workflow Job Template for an Organization", "tags":[ "Organizations" ], "x-internal-id":"api-v2-organizations-{id}-workflow_job_templates--post", "x-filename-id":"api-v2-organizations-id-workflow_job_templates-post" } }, "/api/v2/ping/":{ "get":{ "description":"

Everything returned here should be considered public / insecure, as\nthis requires no auth and is intended for use by the installer process.

", "operationId":"api_ping_list", "parameters":[ ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"", "examples":{ "application/json":{ "active_node":"awx_1", "ha":false, "install_uuid":"00000000-0000-0000-0000-000000000000", "instance_groups":[ ], "instances":[ ], "version":"23.7.0" } } } }, "summary":"Return Some Basic Information About This Instance", "tags":[ "Ping" ], "x-internal-id":"api-v2-ping--get", "x-filename-id":"api-v2-ping-get" }, "parameters":[ ] }, "/api/v2/project_updates/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nproject updates.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each project update data structure includes the following fields:

\n
    \n
  • id: Database ID for this project update. (integer)
    • \n
  • type: Data type for this project update. (choice)
    • \n
  • url: URL for this project update. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this project update was created. (datetime)
    • \n
  • modified: Timestamp when this project update was last modified. (datetime)
    • \n
  • name: Name of this project update. (string)
    • \n
  • description: Optional description of this project update. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)
    • \n
  • scm_type: Specifies the source control system used to store the project. (choice)
      \n
    • \"\": Manual
      • \n
    • git: Git
      • \n
    • svn: Subversion
      • \n
    • insights: Red Hat Insights
      • \n
    • archive: Remote Archive
      • \n
    \n
    • \n
  • scm_url: The location where the project is stored. (string)
    • \n
  • scm_branch: Specific branch, tag or commit to checkout. (string)
    • \n
  • scm_refspec: For git projects, an additional refspec to fetch. (string)
    • \n
  • scm_clean: Discard any local changes before syncing the project. (boolean)
    • \n
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean)
    • \n
  • scm_delete_on_update: Delete the project before syncing. (boolean)
    • \n
  • credential: (id)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • scm_revision: The SCM Revision discovered by this update for the given project and branch. (string)
    • \n
  • project: (id)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: Parts of the project update playbook that will be run. (string)
    • \n
\n

Sorting

\n

To specify that project updates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_project_updates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ProjectUpdateList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Project Updates", "tags":[ "Project Updates" ], "x-internal-id":"api-v2-project_updates--get", "x-filename-id":"api-v2-project_updates-get" }, "parameters":[ ] }, "/api/v2/project_updates/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this project update.

", "operationId":"api_project_updates_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this project update. (integer)
    • \n
  • type: Data type for this project update. (choice)
    • \n
  • url: URL for this project update. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this project update was created. (datetime)
    • \n
  • modified: Timestamp when this project update was last modified. (datetime)
    • \n
  • name: Name of this project update. (string)
    • \n
  • description: Optional description of this project update. (string)
    • \n
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)
    • \n
  • scm_type: Specifies the source control system used to store the project. (choice)
      \n
    • \"\": Manual
      • \n
    • git: Git
      • \n
    • svn: Subversion
      • \n
    • insights: Red Hat Insights
      • \n
    • archive: Remote Archive
      • \n
    \n
    • \n
  • scm_url: The location where the project is stored. (string)
    • \n
  • scm_branch: Specific branch, tag or commit to checkout. (string)
    • \n
  • scm_refspec: For git projects, an additional refspec to fetch. (string)
    • \n
  • scm_clean: Discard any local changes before syncing the project. (boolean)
    • \n
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean)
    • \n
  • scm_delete_on_update: Delete the project before syncing. (boolean)
    • \n
  • credential: (id)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • scm_revision: The SCM Revision discovered by this update for the given project and branch. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_args: (string)
    • \n
  • job_cwd: (string)
    • \n
  • job_env: (json)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • result_traceback: (string)
    • \n
  • event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • project: (id)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: Parts of the project update playbook that will be run. (string)
    • \n
  • host_status_counts: Playbook stats from the Ansible playbook_on_stats event. (json)
    • \n
  • playbook_counts: A count of all plays and tasks for the job run. (field)
    • \n
", "operationId":"api_project_updates_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/ProjectUpdateDetail" } } }, "summary":"Retrieve a Project Update", "tags":[ "Project Updates" ], "x-internal-id":"api-v2-project_updates-{id}--get", "x-filename-id":"api-v2-project_updates-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/project_updates/{id}/cancel/":{ "get":{ "description":"

Make a GET request to this resource to determine if the project update can be\ncanceled. The response will include the following field:

\n
    \n
  • can_cancel: Indicates whether this update can be canceled (boolean,\n read-only)
    • \n
\n

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":"api_project_updates_cancel_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/ProjectUpdateCancel" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "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:

\n
    \n
  • can_cancel: Indicates whether this update can be canceled (boolean,\n read-only)
    • \n
\n

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":"api_project_updates_cancel_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/ProjectUpdateCancel" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/ProjectUpdateCancel" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each project update event data structure includes the following fields:

\n
    \n
  • id: Database ID for this project update event. (integer)
    • \n
  • type: Data type for this project update event. (choice)
    • \n
  • url: URL for this project update event. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this project update event was created. (datetime)
    • \n
  • modified: Timestamp when this project update event was last modified. (datetime)
    • \n
  • event: (choice)
      \n
    • runner_on_failed: Host Failed
      • \n
    • runner_on_start: Host Started
      • \n
    • runner_on_ok: Host OK
      • \n
    • runner_on_error: Host Failure
      • \n
    • runner_on_skipped: Host Skipped
      • \n
    • runner_on_unreachable: Host Unreachable
      • \n
    • runner_on_no_hosts: No Hosts Remaining
      • \n
    • runner_on_async_poll: Host Polling
      • \n
    • runner_on_async_ok: Host Async OK
      • \n
    • runner_on_async_failed: Host Async Failure
      • \n
    • runner_item_on_ok: Item OK
      • \n
    • runner_item_on_failed: Item Failed
      • \n
    • runner_item_on_skipped: Item Skipped
      • \n
    • runner_retry: Host Retry
      • \n
    • runner_on_file_diff: File Difference
      • \n
    • playbook_on_start: Playbook Started
      • \n
    • playbook_on_notify: Running Handlers
      • \n
    • playbook_on_include: Including File
      • \n
    • playbook_on_no_hosts_matched: No Hosts Matched
      • \n
    • playbook_on_no_hosts_remaining: No Hosts Remaining
      • \n
    • playbook_on_task_start: Task Started
      • \n
    • playbook_on_vars_prompt: Variables Prompted
      • \n
    • playbook_on_setup: Gathering Facts
      • \n
    • playbook_on_import_for_host: internal: on Import for Host
      • \n
    • playbook_on_not_import_for_host: internal: on Not Import for Host
      • \n
    • playbook_on_play_start: Play Started
      • \n
    • playbook_on_stats: Playbook Complete
      • \n
    • debug: Debug
      • \n
    • verbose: Verbose
      • \n
    • deprecated: Deprecated
      • \n
    • warning: Warning
      • \n
    • system_warning: System Warning
      • \n
    • error: Error
      • \n
    \n
    • \n
  • counter: (integer)
    • \n
  • event_display: (string)
    • \n
  • event_data: (json)
    • \n
  • event_level: (integer)
    • \n
  • failed: (boolean)
    • \n
  • changed: (boolean)
    • \n
  • uuid: (string)
    • \n
  • host_name: (field)
    • \n
  • playbook: (string)
    • \n
  • play: (string)
    • \n
  • task: (string)
    • \n
  • role: (string)
    • \n
  • stdout: (field)
    • \n
  • start_line: (integer)
    • \n
  • end_line: (integer)
    • \n
  • verbosity: (integer)
    • \n
  • project_update: (id)
    • \n
\n

Sorting

\n

To specify that project update events are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_project_updates_events_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ProjectUpdateEvent" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Project Update Events for a Project Update", "tags":[ "Project Updates" ], "x-internal-id":"api-v2-project_updates-{id}-events--get", "x-filename-id":"api-v2-project_updates-id-events-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/project_updates/{id}/notifications/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nproject update.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification. (integer)
    • \n
  • type: Data type for this notification. (choice)
    • \n
  • url: URL for this notification. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification was created. (datetime)
    • \n
  • modified: Timestamp when this notification was last modified. (datetime)
    • \n
  • notification_template: (id)
    • \n
  • error: (string)
    • \n
  • status: (choice)
      \n
    • pending: Pending
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    \n
    • \n
  • notifications_sent: (integer)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • recipients: (string)
    • \n
  • subject: (string)
    • \n
  • body: Notification body (json)
    • \n
\n

Sorting

\n

To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_project_updates_notifications_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Notification" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notifications for a Project Update", "tags":[ "Project Updates" ], "x-internal-id":"api-v2-project_updates-{id}-notifications--get", "x-filename-id":"api-v2-project_updates-id-notifications-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/project_updates/{id}/scm_inventory_updates/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninventory updates associated with the selected\nproject update.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory update data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory update. (integer)
    • \n
  • type: Data type for this inventory update. (choice)
    • \n
  • url: URL for this inventory update. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory update was created. (datetime)
    • \n
  • modified: Timestamp when this inventory update was last modified. (datetime)
    • \n
  • name: Name of this inventory update. (string)
    • \n
  • description: Optional description of this inventory update. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string)
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string)
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)
    • \n
  • credential: Cloud credential to use for inventory updates. (integer)
    • \n
  • 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)
    • \n
  • 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. If the key is not found then the host will be enabled (string)
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)
    • \n
  • overwrite_vars: Overwrite local variables from remote inventory source. (boolean)
    • \n
  • custom_virtualenv: (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • limit: Enter host, group or pattern match (string)
    • \n
  • inventory: (id)
    • \n
  • inventory_source: (id)
    • \n
  • license_error: (boolean)
    • \n
  • org_host_limit_error: (boolean)
    • \n
  • source_project_update: Inventory files from this Project Update were used for the inventory update. (id)
    • \n
  • instance_group: The Instance group the job was run under (id)
    • \n
  • scm_revision: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)
    • \n
\n

Sorting

\n

To specify that inventory updates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_project_updates_scm_inventory_updates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InventoryUpdateList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventory Updates for a Project Update", "tags":[ "Project Updates" ], "x-internal-id":"api-v2-project_updates-{id}-scm_inventory_updates--get", "x-filename-id":"api-v2-project_updates-id-scm_inventory_updates-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/project_updates/{id}/stdout/":{ "get":{ "description":"

Make GET request to this resource to retrieve the stdout from running this\nproject update.

\n

Format

\n

Use the format query string parameter to specify the output format.

\n
    \n
  • Browsable API: ?format=api
    • \n
  • HTML: ?format=html
    • \n
  • Plain Text: ?format=txt
    • \n
  • Plain Text with ANSI color codes: ?format=ansi
    • \n
  • JSON structure: ?format=json
    • \n
  • Downloaded Plain Text: ?format=txt_download
    • \n
  • Downloaded Plain Text with ANSI color codes: ?format=ansi_download
    • \n
\n

(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.

\n

Use dark=1 or dark=0 as a query string parameter to force or disable a\ndark background.

\n

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.

", "operationId":"api_project_updates_stdout_read", "parameters":[ ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/UnifiedJobStdout" } } }, "summary":"Retrieve Project Update Stdout", "tags":[ "Project Updates" ], "x-internal-id":"api-v2-project_updates-{id}-stdout--get", "x-filename-id":"api-v2-project_updates-id-stdout-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/projects/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nprojects.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each project data structure includes the following fields:

\n
    \n
  • id: Database ID for this project. (integer)
    • \n
  • type: Data type for this project. (choice)
    • \n
  • url: URL for this project. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this project was created. (datetime)
    • \n
  • modified: Timestamp when this project was last modified. (datetime)
    • \n
  • name: Name of this project. (string)
    • \n
  • description: Optional description of this project. (string)
    • \n
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)
    • \n
  • scm_type: Specifies the source control system used to store the project. (choice)
      \n
    • \"\": Manual
      • \n
    • git: Git
      • \n
    • svn: Subversion
      • \n
    • insights: Red Hat Insights
      • \n
    • archive: Remote Archive
      • \n
    \n
    • \n
  • scm_url: The location where the project is stored. (string)
    • \n
  • scm_branch: Specific branch, tag or commit to checkout. (string)
    • \n
  • scm_refspec: For git projects, an additional refspec to fetch. (string)
    • \n
  • scm_clean: Discard any local changes before syncing the project. (boolean)
    • \n
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean)
    • \n
  • scm_delete_on_update: Delete the project before syncing. (boolean)
    • \n
  • credential: (id)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • scm_revision: The last revision fetched by a project update (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    \n
    • \n
  • organization: The organization used to determine access to this template. (id)
    • \n
  • scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean)
    • \n
  • 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)
    • \n
  • allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • default_environment: The default execution environment for jobs run using this project. (id)
    • \n
  • signature_validation_credential: An optional credential used for validating files in the project against unexpected changes. (id)
    • \n
  • last_update_failed: (boolean)
    • \n
  • last_updated: (datetime)
    • \n
\n

Sorting

\n

To specify that projects are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_projects_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Project" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Projects", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects--get", "x-filename-id":"api-v2-projects-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following project\nfields to create a new project:

\n
    \n
  • name: Name of this project. (string, required)
    • \n
  • description: Optional description of this project. (string, default=\"\")
    • \n
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=\"\")
    • \n
  • scm_type: Specifies the source control system used to store the project. (choice)
      \n
    • \"\": Manual (default)
      • \n
    • git: Git
      • \n
    • svn: Subversion
      • \n
    • insights: Red Hat Insights
      • \n
    • archive: Remote Archive
      • \n
    \n
    • \n
  • scm_url: The location where the project is stored. (string, default=\"\")
    • \n
  • scm_branch: Specific branch, tag or commit to checkout. (string, default=\"\")
    • \n
  • scm_refspec: For git projects, an additional refspec to fetch. (string, default=\"\")
    • \n
  • scm_clean: Discard any local changes before syncing the project. (boolean, default=False)
    • \n
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean, default=False)
    • \n
  • scm_delete_on_update: Delete the project before syncing. (boolean, default=False)
    • \n
  • credential: (id, default=``)
    • \n
  • \n

    timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)

    \n
    • \n
  • \n

    organization: The organization used to determine access to this template. (id, default=``)

    \n
    • \n
  • scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean, default=False)
    • \n
  • 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)
    • \n
  • \n

    allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=False)

    \n
    • \n
  • \n

    default_environment: The default execution environment for jobs run using this project. (id, default=``)

    \n
    • \n
  • signature_validation_credential: An optional credential used for validating files in the project against unexpected changes. (id, default=``)
    • \n
", "operationId":"api_projects_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Project" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Project" } } }, "summary":"Create a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects--post", "x-filename-id":"api-v2-projects-post" } }, "/api/v2/projects/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this project.

", "operationId":"api_projects_delete", "parameters":[ ], "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:

\n
    \n
  • id: Database ID for this project. (integer)
    • \n
  • type: Data type for this project. (choice)
    • \n
  • url: URL for this project. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this project was created. (datetime)
    • \n
  • modified: Timestamp when this project was last modified. (datetime)
    • \n
  • name: Name of this project. (string)
    • \n
  • description: Optional description of this project. (string)
    • \n
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)
    • \n
  • scm_type: Specifies the source control system used to store the project. (choice)
      \n
    • \"\": Manual
      • \n
    • git: Git
      • \n
    • svn: Subversion
      • \n
    • insights: Red Hat Insights
      • \n
    • archive: Remote Archive
      • \n
    \n
    • \n
  • scm_url: The location where the project is stored. (string)
    • \n
  • scm_branch: Specific branch, tag or commit to checkout. (string)
    • \n
  • scm_refspec: For git projects, an additional refspec to fetch. (string)
    • \n
  • scm_clean: Discard any local changes before syncing the project. (boolean)
    • \n
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean)
    • \n
  • scm_delete_on_update: Delete the project before syncing. (boolean)
    • \n
  • credential: (id)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • scm_revision: The last revision fetched by a project update (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    \n
    • \n
  • organization: The organization used to determine access to this template. (id)
    • \n
  • scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean)
    • \n
  • 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)
    • \n
  • allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • default_environment: The default execution environment for jobs run using this project. (id)
    • \n
  • signature_validation_credential: An optional credential used for validating files in the project against unexpected changes. (id)
    • \n
  • last_update_failed: (boolean)
    • \n
  • last_updated: (datetime)
    • \n
", "operationId":"api_projects_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Project" } } }, "summary":"Retrieve a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}--get", "x-filename-id":"api-v2-projects-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\nproject. The following fields may be modified:

\n
    \n
  • name: Name of this project. (string, required)
    • \n
  • description: Optional description of this project. (string, default=\"\")
    • \n
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=\"\")
    • \n
  • scm_type: Specifies the source control system used to store the project. (choice)
      \n
    • \"\": Manual (default)
      • \n
    • git: Git
      • \n
    • svn: Subversion
      • \n
    • insights: Red Hat Insights
      • \n
    • archive: Remote Archive
      • \n
    \n
    • \n
  • scm_url: The location where the project is stored. (string, default=\"\")
    • \n
  • scm_branch: Specific branch, tag or commit to checkout. (string, default=\"\")
    • \n
  • scm_refspec: For git projects, an additional refspec to fetch. (string, default=\"\")
    • \n
  • scm_clean: Discard any local changes before syncing the project. (boolean, default=False)
    • \n
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean, default=False)
    • \n
  • scm_delete_on_update: Delete the project before syncing. (boolean, default=False)
    • \n
  • credential: (id, default=``)
    • \n
  • \n

    timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)

    \n
    • \n
  • \n

    organization: The organization used to determine access to this template. (id, default=``)

    \n
    • \n
  • scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean, default=False)
    • \n
  • 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)
    • \n
  • \n

    allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=False)

    \n
    • \n
  • \n

    default_environment: The default execution environment for jobs run using this project. (id, default=``)

    \n
    • \n
  • signature_validation_credential: An optional credential used for validating files in the project against unexpected changes. (id, default=``)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_projects_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Project" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Project" } } }, "summary":"Update a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}--patch", "x-filename-id":"api-v2-projects-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\nproject. The following fields may be modified:

\n
    \n
  • name: Name of this project. (string, required)
    • \n
  • description: Optional description of this project. (string, default=\"\")
    • \n
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=\"\")
    • \n
  • scm_type: Specifies the source control system used to store the project. (choice)
      \n
    • \"\": Manual (default)
      • \n
    • git: Git
      • \n
    • svn: Subversion
      • \n
    • insights: Red Hat Insights
      • \n
    • archive: Remote Archive
      • \n
    \n
    • \n
  • scm_url: The location where the project is stored. (string, default=\"\")
    • \n
  • scm_branch: Specific branch, tag or commit to checkout. (string, default=\"\")
    • \n
  • scm_refspec: For git projects, an additional refspec to fetch. (string, default=\"\")
    • \n
  • scm_clean: Discard any local changes before syncing the project. (boolean, default=False)
    • \n
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean, default=False)
    • \n
  • scm_delete_on_update: Delete the project before syncing. (boolean, default=False)
    • \n
  • credential: (id, default=``)
    • \n
  • \n

    timeout: The amount of time (in seconds) to run before the task is canceled. (integer, default=0)

    \n
    • \n
  • \n

    organization: The organization used to determine access to this template. (id, default=``)

    \n
    • \n
  • scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean, default=False)
    • \n
  • 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)
    • \n
  • \n

    allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=False)

    \n
    • \n
  • \n

    default_environment: The default execution environment for jobs run using this project. (id, default=``)

    \n
    • \n
  • signature_validation_credential: An optional credential used for validating files in the project against unexpected changes. (id, default=``)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_projects_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Project" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Project" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_projects_access_list_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ResourceAccessListElement" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-access_list--get", "x-filename-id":"api-v2-projects-id-access_list-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/projects/{id}/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nproject.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_projects_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-activity_stream--get", "x-filename-id":"api-v2-projects-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/projects/{id}/copy/":{ "get":{ "description":"", "operationId":"api_projects_copy_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Copy" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "tags":[ "Projects" ], "summary":"Projects Copy List", "x-internal-id":"api-v2-projects-{id}-copy--get", "x-filename-id":"api-v2-projects-id-copy-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_projects_copy_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Copy" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Copy" } } }, "tags":[ "Projects" ], "summary":"Projects Copy Create", "x-internal-id":"api-v2-projects-{id}-copy--post", "x-filename-id":"api-v2-projects-id-copy-post" } }, "/api/v2/projects/{id}/inventories/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single project\nrecord containing the following fields:

\n
    \n
  • inventory_files: Array of inventory files and directories available within this project, not comprehensive. (json)
    • \n
", "operationId":"api_projects_inventories_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/ProjectInventories" } } }, "summary":"Retrieve a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-inventories--get", "x-filename-id":"api-v2-projects-id-inventories-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/projects/{id}/notification_templates_error/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_projects_notification_templates_error_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-notification_templates_error--get", "x-filename-id":"api-v2-projects-id-notification_templates_error-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nproject.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a Project:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this project.

\n

Remove Notification Templates from this Project:

\n

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.

", "operationId":"api_projects_notification_templates_error_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-notification_templates_error--post", "x-filename-id":"api-v2-projects-id-notification_templates_error-post" } }, "/api/v2/projects/{id}/notification_templates_started/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_projects_notification_templates_started_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-notification_templates_started--get", "x-filename-id":"api-v2-projects-id-notification_templates_started-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nproject.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a Project:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this project.

\n

Remove Notification Templates from this Project:

\n

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.

", "operationId":"api_projects_notification_templates_started_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-notification_templates_started--post", "x-filename-id":"api-v2-projects-id-notification_templates_started-post" } }, "/api/v2/projects/{id}/notification_templates_success/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_projects_notification_templates_success_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-notification_templates_success--get", "x-filename-id":"api-v2-projects-id-notification_templates_success-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nproject.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a Project:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this project.

\n

Remove Notification Templates from this Project:

\n

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.

", "operationId":"api_projects_notification_templates_success_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-notification_templates_success--post", "x-filename-id":"api-v2-projects-id-notification_templates_success-post" } }, "/api/v2/projects/{id}/object_roles/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nroles associated with the selected\nproject.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_projects_object_roles_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Role" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles for a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-object_roles--get", "x-filename-id":"api-v2-projects-id-object_roles-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/projects/{id}/playbooks/":{ "get":{ "description":"

Make GET request to this resource to retrieve a list of playbooks available\nfor a project.

", "operationId":"api_projects_playbooks_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/ProjectPlaybooks" } } }, "summary":"Retrieve Project Playbooks", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-playbooks--get", "x-filename-id":"api-v2-projects-id-playbooks-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each project update data structure includes the following fields:

\n
    \n
  • id: Database ID for this project update. (integer)
    • \n
  • type: Data type for this project update. (choice)
    • \n
  • url: URL for this project update. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this project update was created. (datetime)
    • \n
  • modified: Timestamp when this project update was last modified. (datetime)
    • \n
  • name: Name of this project update. (string)
    • \n
  • description: Optional description of this project update. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)
    • \n
  • scm_type: Specifies the source control system used to store the project. (choice)
      \n
    • \"\": Manual
      • \n
    • git: Git
      • \n
    • svn: Subversion
      • \n
    • insights: Red Hat Insights
      • \n
    • archive: Remote Archive
      • \n
    \n
    • \n
  • scm_url: The location where the project is stored. (string)
    • \n
  • scm_branch: Specific branch, tag or commit to checkout. (string)
    • \n
  • scm_refspec: For git projects, an additional refspec to fetch. (string)
    • \n
  • scm_clean: Discard any local changes before syncing the project. (boolean)
    • \n
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean)
    • \n
  • scm_delete_on_update: Delete the project before syncing. (boolean)
    • \n
  • credential: (id)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • scm_revision: The SCM Revision discovered by this update for the given project and branch. (string)
    • \n
  • project: (id)
    • \n
  • job_type: (choice)
      \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: Parts of the project update playbook that will be run. (string)
    • \n
\n

Sorting

\n

To specify that project updates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_projects_project_updates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ProjectUpdateList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Project Updates for a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-project_updates--get", "x-filename-id":"api-v2-projects-id-project_updates-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/projects/{id}/schedules/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nproject.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each schedule data structure includes the following fields:

\n
    \n
  • rrule: A value representing the schedules iCal recurrence rule. (string)
    • \n
  • id: Database ID for this schedule. (integer)
    • \n
  • type: Data type for this schedule. (choice)
    • \n
  • url: URL for this schedule. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this schedule was created. (datetime)
    • \n
  • modified: Timestamp when this schedule was last modified. (datetime)
    • \n
  • name: Name of this schedule. (string)
    • \n
  • description: Optional description of this schedule. (string)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • unified_job_template: (id)
    • \n
  • enabled: Enables processing of this schedule. (boolean)
    • \n
  • dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)
    • \n
  • dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)
    • \n
  • next_run: The next time that the scheduled action will run. (datetime)
    • \n
  • timezone: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)
    • \n
  • until: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)
    • \n
\n

Sorting

\n

To specify that schedules are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_projects_schedules_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Schedule" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Schedules for a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-schedules--get", "x-filename-id":"api-v2-projects-id-schedules-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following schedule\nfields to create a new schedule associated with this\nproject.

\n
    \n
  • \n

    rrule: A value representing the schedules iCal recurrence rule. (string, required)

    \n
    • \n
  • \n

    name: Name of this schedule. (string, required)

    \n
    • \n
  • description: Optional description of this schedule. (string, default=\"\")
    • \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • \n

    timeout: (integer, default=None)

    \n
    • \n
  • \n

    enabled: Enables processing of this schedule. (boolean, default=True)

    \n
    • \n
\n

POST requests to this resource must include a proper rrule value following\na particular format and conforming to subset of allowed rules.

\n

The following lists the expected format and details of our rrules:

\n
    \n
  • DTSTART is required and must follow the following format: DTSTART:YYYYMMDDTHHMMSSZ
    • \n
  • DTSTART is expected to be in UTC
    • \n
  • INTERVAL is required
    • \n
  • SECONDLY is not supported
    • \n
  • RRULE must precede the rule statements
    • \n
  • BYDAY is supported but not BYDAY with a numerical prefix
    • \n
  • BYYEARDAY and BYWEEKNO are not supported
    • \n
  • Only one rrule statement per schedule is supported
    • \n
  • COUNT must be < 1000
    • \n
\n

Here 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\"\n
", "operationId":"api_projects_schedules_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Schedule" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Schedule" } } }, "summary":"Create a Schedule for a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-schedules--post", "x-filename-id":"api-v2-projects-id-schedules-post" } }, "/api/v2/projects/{id}/scm_inventory_sources/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\nproject.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each inventory source data structure includes the following fields:

\n
    \n
  • id: Database ID for this inventory source. (integer)
    • \n
  • type: Data type for this inventory source. (choice)
    • \n
  • url: URL for this inventory source. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this inventory source was created. (datetime)
    • \n
  • modified: Timestamp when this inventory source was last modified. (datetime)
    • \n
  • name: Name of this inventory source. (string)
    • \n
  • description: Optional description of this inventory source. (string)
    • \n
  • source: (choice)
      \n
    • file: File, Directory or Script
      • \n
    • constructed: Template additional groups and hostvars at runtime
      • \n
    • scm: Sourced from a Project
      • \n
    • ec2: Amazon EC2
      • \n
    • gce: Google Compute Engine
      • \n
    • azure_rm: Microsoft Azure Resource Manager
      • \n
    • vmware: VMware vCenter
      • \n
    • satellite6: Red Hat Satellite 6
      • \n
    • openstack: OpenStack
      • \n
    • rhv: Red Hat Virtualization
      • \n
    • controller: Red Hat Ansible Automation Platform
      • \n
    • insights: Red Hat Insights
      • \n
    \n
    • \n
  • source_path: (string)
    • \n
  • source_vars: Inventory source variables in YAML or JSON format. (string)
    • \n
  • scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)
    • \n
  • credential: Cloud credential to use for inventory updates. (integer)
    • \n
  • 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)
    • \n
  • 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. If the key is not found then the host will be enabled (string)
    • \n
  • host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)
    • \n
  • overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)
    • \n
  • overwrite_vars: Overwrite local variables from remote inventory source. (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • verbosity: (choice)
      \n
    • 0: 0 (WARNING)
      • \n
    • 1: 1 (INFO)
      • \n
    • 2: 2 (DEBUG)
      • \n
    \n
    • \n
  • limit: Enter host, group or pattern match (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • none: No External Source
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • inventory: (id)
    • \n
  • update_on_launch: (boolean)
    • \n
  • update_cache_timeout: (integer)
    • \n
  • source_project: Project containing inventory file used as source. (id)
    • \n
  • last_update_failed: (boolean)
    • \n
  • last_updated: (datetime)
    • \n
\n

Sorting

\n

To specify that inventory sources are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_projects_scm_inventory_sources_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InventorySource" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Inventory Sources for a Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-scm_inventory_sources--get", "x-filename-id":"api-v2-projects-id-scm_inventory_sources-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/projects/{id}/teams/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nteams.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each team data structure includes the following fields:

\n
    \n
  • id: Database ID for this team. (integer)
    • \n
  • type: Data type for this team. (choice)
    • \n
  • url: URL for this team. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this team was created. (datetime)
    • \n
  • modified: Timestamp when this team was last modified. (datetime)
    • \n
  • name: Name of this team. (string)
    • \n
  • description: Optional description of this team. (string)
    • \n
  • organization: (id)
    • \n
\n

Sorting

\n

To specify that teams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_projects_teams_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Team" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Teams", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-teams--get", "x-filename-id":"api-v2-projects-id-teams-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/projects/{id}/update/":{ "get":{ "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:

\n
    \n
  • can_update: Flag indicating if this project can be updated (boolean,\n read-only)
    • \n
\n

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":"api_projects_update_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/ProjectUpdateView" } } }, "summary":"Update Project", "tags":[ "Projects" ], "x-internal-id":"api-v2-projects-{id}-update--get", "x-filename-id":"api-v2-projects-id-update-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "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:

\n
    \n
  • can_update: Flag indicating if this project can be updated (boolean,\n read-only)
    • \n
\n

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":"api_projects_update_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/ProjectUpdateView" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/ProjectUpdateView" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_roles_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Role" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles", "tags":[ "Roles" ], "x-internal-id":"api-v2-roles--get", "x-filename-id":"api-v2-roles-get" }, "parameters":[ ] }, "/api/v2/roles/{id}/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single role\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
", "operationId":"api_roles_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Role" } } }, "summary":"Retrieve a Role", "tags":[ "Roles" ], "x-internal-id":"api-v2-roles-{id}--get", "x-filename-id":"api-v2-roles-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/roles/{id}/children/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nroles associated with the selected\nrole.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_roles_children_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Role" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles for a Role", "tags":[ "Roles" ], "x-internal-id":"api-v2-roles-{id}-children--get", "x-filename-id":"api-v2-roles-id-children-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/roles/{id}/parents/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nroles associated with the selected\nrole.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_roles_parents_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Role" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles for a Role", "tags":[ "Roles" ], "x-internal-id":"api-v2-roles-{id}-parents--get", "x-filename-id":"api-v2-roles-id-parents-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/roles/{id}/teams/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nteams associated with the selected\nrole.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each team data structure includes the following fields:

\n
    \n
  • id: Database ID for this team. (integer)
    • \n
  • type: Data type for this team. (choice)
    • \n
  • url: URL for this team. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this team was created. (datetime)
    • \n
  • modified: Timestamp when this team was last modified. (datetime)
    • \n
  • name: Name of this team. (string)
    • \n
  • description: Optional description of this team. (string)
    • \n
  • organization: (id)
    • \n
\n

Sorting

\n

To specify that teams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_roles_teams_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Team" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Teams for a Role", "tags":[ "Roles" ], "x-internal-id":"api-v2-roles-{id}-teams--get", "x-filename-id":"api-v2-roles-id-teams-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following team\nfields to create a new team associated with this\nrole.

\n
    \n
  • name: Name of this team. (string, required)
    • \n
  • description: Optional description of this team. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
\n

Add Teams for a Role:

\n

Make a POST request to this resource with only an id field to associate an\nexisting team with this role.

\n

Remove Teams from this Role:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the team from this role\n without deleting the team.

", "operationId":"api_roles_teams_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Team" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Team" } } }, "summary":"Create a Team for a Role", "tags":[ "Roles" ], "x-internal-id":"api-v2-roles-{id}-teams--post", "x-filename-id":"api-v2-roles-id-teams-post" } }, "/api/v2/roles/{id}/users/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nusers associated with the selected\nrole.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_roles_users_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/User" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users for a Role", "tags":[ "Roles" ], "x-internal-id":"api-v2-roles-{id}-users--get", "x-filename-id":"api-v2-roles-id-users-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following user\nfields to create a new user associated with this\nrole.

\n
    \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)
    • \n
  • first_name: (string, default=\"\")
    • \n
  • last_name: (string, default=\"\")
    • \n
  • email: (string, default=\"\")
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)
    • \n
  • is_system_auditor: (boolean, default=False)
    • \n
  • password: Field used to change the password. (string, default=\"\")
    • \n
\n

Add Users for a Role:

\n

Make a POST request to this resource with only an id field to associate an\nexisting user with this role.

\n

Remove Users from this Role:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the user from this role\n without deleting the user.

", "operationId":"api_roles_users_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/User" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/User" } } }, "summary":"Create a User for a Role", "tags":[ "Roles" ], "x-internal-id":"api-v2-roles-{id}-users--post", "x-filename-id":"api-v2-roles-id-users-post" } }, "/api/v2/schedules/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nschedules.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each schedule data structure includes the following fields:

\n
    \n
  • rrule: A value representing the schedules iCal recurrence rule. (string)
    • \n
  • id: Database ID for this schedule. (integer)
    • \n
  • type: Data type for this schedule. (choice)
    • \n
  • url: URL for this schedule. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this schedule was created. (datetime)
    • \n
  • modified: Timestamp when this schedule was last modified. (datetime)
    • \n
  • name: Name of this schedule. (string)
    • \n
  • description: Optional description of this schedule. (string)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • unified_job_template: (id)
    • \n
  • enabled: Enables processing of this schedule. (boolean)
    • \n
  • dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)
    • \n
  • dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)
    • \n
  • next_run: The next time that the scheduled action will run. (datetime)
    • \n
  • timezone: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)
    • \n
  • until: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)
    • \n
\n

Sorting

\n

To specify that schedules are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_schedules_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Schedule" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Schedules", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules--get", "x-filename-id":"api-v2-schedules-get" }, "parameters":[ ], "post":{ "description":"
    \n
  • DTSTART is required and must follow the following format: DTSTART:YYYYMMDDTHHMMSSZ
    • \n
  • DTSTART is expected to be in UTC
    • \n
  • INTERVAL is required
    • \n
  • SECONDLY is not supported
    • \n
  • RRULE must precede the rule statements
    • \n
  • BYDAY is supported but not BYDAY with a numerical prefix
    • \n
  • BYYEARDAY and BYWEEKNO are not supported
    • \n
  • Only one rrule statement per schedule is supported
    • \n
  • COUNT must be < 1000
    • \n
\n

Here 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\"\n
", "operationId":"api_schedules_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Schedule" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Schedule" } } }, "summary":"Schedule Details\n================\nThe Following Lists the Expected Format and Details of Our Rrules", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules--post", "x-filename-id":"api-v2-schedules-post" } }, "/api/v2/schedules/preview/":{ "parameters":[ ], "post":{ "description":"", "operationId":"api_schedules_preview_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/SchedulePreview" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/SchedulePreview" } } }, "tags":[ "Schedules" ], "summary":"Schedules Preview Create", "x-internal-id":"api-v2-schedules-preview--post", "x-filename-id":"api-v2-schedules-preview-post" } }, "/api/v2/schedules/zoneinfo/":{ "get":{ "description":"", "operationId":"api_schedules_zoneinfo_list", "parameters":[ ], "responses":{ "200":{ "description":"" } }, "tags":[ "Schedules" ], "summary":"Schedules Zoneinfo List", "x-internal-id":"api-v2-schedules-zoneinfo--get", "x-filename-id":"api-v2-schedules-zoneinfo-get" }, "parameters":[ ] }, "/api/v2/schedules/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this schedule.

", "operationId":"api_schedules_delete", "parameters":[ ], "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:

\n
    \n
  • rrule: A value representing the schedules iCal recurrence rule. (string)
    • \n
  • id: Database ID for this schedule. (integer)
    • \n
  • type: Data type for this schedule. (choice)
    • \n
  • url: URL for this schedule. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this schedule was created. (datetime)
    • \n
  • modified: Timestamp when this schedule was last modified. (datetime)
    • \n
  • name: Name of this schedule. (string)
    • \n
  • description: Optional description of this schedule. (string)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • unified_job_template: (id)
    • \n
  • enabled: Enables processing of this schedule. (boolean)
    • \n
  • dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)
    • \n
  • dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)
    • \n
  • next_run: The next time that the scheduled action will run. (datetime)
    • \n
  • timezone: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)
    • \n
  • until: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)
    • \n
", "operationId":"api_schedules_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Schedule" } } }, "summary":"Retrieve a Schedule", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules-{id}--get", "x-filename-id":"api-v2-schedules-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\nschedule. The following fields may be modified:

\n
    \n
  • \n

    rrule: A value representing the schedules iCal recurrence rule. (string, required)

    \n
    • \n
  • \n

    name: Name of this schedule. (string, required)

    \n
    • \n
  • description: Optional description of this schedule. (string, default=\"\")
    • \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • timeout: (integer, default=None)
    • \n
  • unified_job_template: (id, required)
    • \n
  • enabled: Enables processing of this schedule. (boolean, default=True)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_schedules_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Schedule" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Schedule" } } }, "summary":"Update a Schedule", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules-{id}--patch", "x-filename-id":"api-v2-schedules-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\nschedule. The following fields may be modified:

\n
    \n
  • \n

    rrule: A value representing the schedules iCal recurrence rule. (string, required)

    \n
    • \n
  • \n

    name: Name of this schedule. (string, required)

    \n
    • \n
  • description: Optional description of this schedule. (string, default=\"\")
    • \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • timeout: (integer, default=None)
    • \n
  • unified_job_template: (id, required)
    • \n
  • enabled: Enables processing of this schedule. (boolean, default=True)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_schedules_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Schedule" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Schedule" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • organization: (id)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_schedules_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Credential" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials for a Schedule", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules-{id}-credentials--get", "x-filename-id":"api-v2-schedules-id-credentials-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following credential\nfields to create a new credential associated with this\nschedule.

\n
    \n
  • name: Name of this credential. (string, required)
    • \n
  • description: Optional description of this credential. (string, default=\"\")
    • \n
  • organization: (id, default=None)
    • \n
  • \n

    credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
\n

Add Credentials for a Schedule:

\n

Make a POST request to this resource with only an id field to associate an\nexisting credential with this schedule.

\n

Remove Credentials from this Schedule:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the credential from this schedule\n without deleting the credential.

", "operationId":"api_schedules_credentials_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Credential" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Credential" } } }, "summary":"Create a Credential for a Schedule", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules-{id}-credentials--post", "x-filename-id":"api-v2-schedules-id-credentials-post" } }, "/api/v2/schedules/{id}/instance_groups/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nschedule.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each instance group data structure includes the following fields:

\n
    \n
  • id: Database ID for this instance group. (integer)
    • \n
  • type: Data type for this instance group. (choice)
    • \n
  • url: URL for this instance group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • name: Name of this instance group. (string)
    • \n
  • created: Timestamp when this instance group was created. (datetime)
    • \n
  • modified: Timestamp when this instance group was last modified. (datetime)
    • \n
  • capacity: (field)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: (field)
    • \n
  • max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance group (integer)
    • \n
  • instances: (field)
    • \n
  • is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)
    • \n
  • credential: (id)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json)
    • \n
  • pod_spec_override: (string)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
\n

Sorting

\n

To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_schedules_instance_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InstanceGroup" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Instance Groups for a Schedule", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules-{id}-instance_groups--get", "x-filename-id":"api-v2-schedules-id-instance_groups-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following instance group\nfields to create a new instance group associated with this\nschedule.

\n
    \n
  • \n

    name: Name of this instance group. (string, required)

    \n
    • \n
  • \n

    max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)

    \n
    • \n
  • credential: (id, default=``)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)
    • \n
  • pod_spec_override: (string, default=\"\")
    • \n
\n

Add Instance Groups for a Schedule:

\n

Make a POST request to this resource with only an id field to associate an\nexisting instance group with this schedule.

\n

Remove Instance Groups from this Schedule:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the instance group from this schedule\n without deleting the instance group.

", "operationId":"api_schedules_instance_groups_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InstanceGroup" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InstanceGroup" } } }, "summary":"Create an Instance Group for a Schedule", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules-{id}-instance_groups--post", "x-filename-id":"api-v2-schedules-id-instance_groups-post" } }, "/api/v2/schedules/{id}/jobs/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nunified jobs associated with the selected\nschedule.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each unified job data structure includes the following fields:

\n
    \n
  • id: Database ID for this unified job. (integer)
    • \n
  • type: Data type for this unified job. (choice)
    • \n
  • url: URL for this unified job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this unified job was created. (datetime)
    • \n
  • modified: Timestamp when this unified job was last modified. (datetime)
    • \n
  • name: Name of this unified job. (string)
    • \n
  • description: Optional description of this unified job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
\n

Sorting

\n

To specify that unified jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_schedules_jobs_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/UnifiedJobList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Unified Jobs for a Schedule", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules-{id}-jobs--get", "x-filename-id":"api-v2-schedules-id-jobs-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/schedules/{id}/labels/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nschedule.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each label data structure includes the following fields:

\n
    \n
  • id: Database ID for this label. (integer)
    • \n
  • type: Data type for this label. (choice)
    • \n
  • url: URL for this label. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this label was created. (datetime)
    • \n
  • modified: Timestamp when this label was last modified. (datetime)
    • \n
  • name: Name of this label. (string)
    • \n
  • organization: Organization this label belongs to. (id)
    • \n
\n

Sorting

\n

To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_schedules_labels_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Label" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Labels for a Schedule", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules-{id}-labels--get", "x-filename-id":"api-v2-schedules-id-labels-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following label\nfields to create a new label associated with this\nschedule.

\n
    \n
  • name: Name of this label. (string, required)
    • \n
  • organization: Organization this label belongs to. (id, required)
    • \n
\n

Add Labels for a Schedule:

\n

Make a POST request to this resource with only an id field to associate an\nexisting label with this schedule.

\n

Remove Labels from this Schedule:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the label from this schedule\n.

", "operationId":"api_schedules_labels_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Label" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Label" } } }, "summary":"Create a Label for a Schedule", "tags":[ "Schedules" ], "x-internal-id":"api-v2-schedules-{id}-labels--post", "x-filename-id":"api-v2-schedules-id-labels-post" } }, "/api/v2/settings/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nsettings.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each setting data structure includes the following fields:

\n
    \n
  • url: (string)
    • \n
  • slug: (string)
    • \n
  • name: (string)
    • \n
\n

Sorting

\n

To specify that settings are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_settings_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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/SettingCategory" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Settings", "tags":[ "Settings" ], "x-internal-id":"api-v2-settings--get", "x-filename-id":"api-v2-settings-get" }, "parameters":[ ] }, "/api/v2/settings/logging/test/":{ "parameters":[ ], "post":{ "description":"

Test Logging Configuration

", "operationId":"api_settings_logging_test_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/SettingSingleton" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/SettingSingleton" } } }, "tags":[ "Settings" ], "summary":"Settings Logging Test Create", "x-internal-id":"api-v2-settings-logging-test--post", "x-filename-id":"api-v2-settings-logging-test-post" } }, "/api/v2/settings/{category_slug}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this setting.

", "operationId":"api_settings_delete", "parameters":[ ], "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:

\n
    \n
  • ACTIVITY_STREAM_ENABLED: Enable capturing activity for the activity stream. (boolean)
    • \n
  • ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC: Enable capturing activity for the activity stream when running inventory sync. (boolean)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • TOWER_URL_BASE: This setting is used by services like notifications to render a valid url to the service. (string)
    • \n
  • 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 AAP Installation guide for more details. (list)
    • \n
  • PROXY_IP_ALLOWED_LIST: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service 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)
    • \n
  • CSRF_TRUSTED_ORIGINS: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list)
    • \n
  • LICENSE: The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license. (nested object)
    • \n
  • REDHAT_USERNAME: This username is used to send data to Automation Analytics (string)
    • \n
  • REDHAT_PASSWORD: This password is used to send data to Automation Analytics (string)
    • \n
  • SUBSCRIPTIONS_USERNAME: This username is used to retrieve subscription and content information (string)
    • \n
  • SUBSCRIPTIONS_PASSWORD: This password is used to retrieve subscription and content information (string)
    • \n
  • AUTOMATION_ANALYTICS_URL: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string)
    • \n
  • INSTALL_UUID: (string)
    • \n
  • DEFAULT_CONTROL_PLANE_QUEUE_NAME: (string)
    • \n
  • DEFAULT_EXECUTION_QUEUE_NAME: (string)
    • \n
  • DEFAULT_EXECUTION_ENVIRONMENT: The Execution Environment to be used when one has not been configured for a job template. (field)
    • \n
  • 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)
    • \n
  • AD_HOC_COMMANDS: List of modules allowed to be used by ad-hoc jobs. (list)
    • \n
  • ALLOW_JINJA_IN_EXTRA_VARS: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where 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)
      \n
    • always: Always
      • \n
    • never: Never
      • \n
    • template: Only On Job Template Definitions
      • \n
    \n
    • \n
  • AWX_ISOLATION_BASE_PATH: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string)
    • \n
  • AWX_ISOLATION_SHOW_PATHS: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list)
    • \n
  • AWX_TASK_ENV: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object)
    • \n
  • AWX_RUNNER_KEEPALIVE_SECONDS: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer)
    • \n
  • GALAXY_TASK_ENV: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object)
    • \n
  • INSIGHTS_TRACKING_STATE: Enables the service to gather data on automation and send it to Automation Analytics. (boolean)
    • \n
  • PROJECT_UPDATE_VVV: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean)
    • \n
  • AWX_ROLES_ENABLED: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)
    • \n
  • AWX_COLLECTIONS_ENABLED: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)
    • \n
  • 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)
    • \n
  • AWX_MOUNT_ISOLATED_PATHS_ON_K8S: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean)
    • \n
  • GALAXY_IGNORE_CERTS: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean)
    • \n
  • STDOUT_MAX_BYTES_DISPLAY: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer)
    • \n
  • 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)
    • \n
  • MAX_WEBSOCKET_EVENT_RATE: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • DEFAULT_JOB_IDLE_TIMEOUT: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • LOG_AGGREGATOR_HOST: Hostname/IP where external logs will be sent to. (string)
    • \n
  • LOG_AGGREGATOR_PORT: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer)
    • \n
  • LOG_AGGREGATOR_TYPE: Format messages for the chosen log aggregator. (choice)
      \n
    • None: ---------
      • \n
    • logstash
      • \n
    • splunk
      • \n
    • loggly
      • \n
    • sumologic
      • \n
    • other
      • \n
    \n
    • \n
  • LOG_AGGREGATOR_USERNAME: Username for external log aggregator (if required; HTTP/s only). (string)
    • \n
  • LOG_AGGREGATOR_PASSWORD: Password or authentication token for external log aggregator (if required; HTTP/s only). (string)
    • \n
  • 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\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list)
    • \n
  • 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)
    • \n
  • LOG_AGGREGATOR_ENABLED: Enable sending logs to external log aggregator. (boolean)
    • \n
  • LOG_AGGREGATOR_TOWER_UUID: Useful to uniquely identify instances. (string)
    • \n
  • 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)
      \n
    • https: HTTPS/HTTP
      • \n
    • tcp: TCP
      • \n
    • udp: UDP
      • \n
    \n
    • \n
  • LOG_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)
    • \n
  • LOG_AGGREGATOR_VERIFY_CERT: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean)
    • \n
  • 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)
      \n
    • DEBUG
      • \n
    • INFO
      • \n
    • WARNING
      • \n
    • ERROR
      • \n
    • CRITICAL
      • \n
    \n
    • \n
  • LOG_AGGREGATOR_ACTION_QUEUE_SIZE: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer)
    • \n
  • LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer)
    • \n
  • 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)
    • \n
  • LOG_AGGREGATOR_RSYSLOGD_DEBUG: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean)
    • \n
  • API_400_ERROR_LOG_FORMAT: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string)
    • \n
  • AUTOMATION_ANALYTICS_LAST_GATHER: (datetime)
    • \n
  • AUTOMATION_ANALYTICS_LAST_ENTRIES: (string)
    • \n
  • AUTOMATION_ANALYTICS_GATHER_INTERVAL: Interval (in seconds) between data gathering. (integer)
    • \n
  • IS_K8S: Indicates whether the instance is part of a kubernetes-based deployment. (boolean)
    • \n
  • BULK_JOB_MAX_LAUNCH: Max jobs to allow bulk jobs to launch (integer)
    • \n
  • BULK_HOST_MAX_CREATE: Max number of hosts to allow to be created in a single bulk action (integer)
    • \n
  • BULK_HOST_MAX_DELETE: Max number of hosts to allow to be deleted in a single bulk action (integer)
    • \n
  • UI_NEXT: Enable preview of new user interface. (boolean)
    • \n
  • SUBSCRIPTION_USAGE_MODEL: (choice)
      \n
    • \"\": Default model for AWX - no subscription. Deletion of host_metrics will not be considered for purposes of managed host counting
      • \n
    • unique_managed_hosts: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes
      • \n
    \n
    • \n
  • CLEANUP_HOST_METRICS_LAST_TS: (datetime)
    • \n
  • HOST_METRIC_SUMMARY_TASK_LAST_TS: (datetime)
    • \n
  • AWX_CLEANUP_PATHS: Enable or Disable TMP Dir cleanup (boolean)
    • \n
  • AWX_REQUEST_PROFILE: Debug web request python timing (boolean)
    • \n
  • DEFAULT_CONTAINER_RUN_OPTIONS: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list)
    • \n
  • RECEPTOR_RELEASE_WORK: Release receptor work (boolean)
    • \n
  • RECEPTOR_NO_SIG: Indicates whether signatures for receptor work requests should be enforced. (boolean)
    • \n
  • SESSION_COOKIE_AGE: Number of seconds that a user is inactive before they will need to login again. (integer)
    • \n
  • SESSIONS_PER_USER: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer)
    • \n
  • DISABLE_LOCAL_AUTH: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean)
    • \n
  • AUTH_BASIC_ENABLED: Enable HTTP Basic Auth for the API Browser. (boolean)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • LOGIN_REDIRECT_OVERRIDE: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string)
    • \n
  • ALLOW_METRICS_FOR_ANONYMOUS_USERS: If true, anonymous users are allowed to poll metrics. (boolean)
    • \n
  • PENDO_TRACKING_STATE: Enable or Disable User Analytics Tracking. (choice)
      \n
    • off: Off
      • \n
    • anonymous: Anonymous
      • \n
    • detailed: Detailed
      • \n
    \n
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • MAX_UI_JOB_EVENTS: Maximum number of job events for the UI to retrieve within a single request. (integer)
    • \n
  • 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)
    • \n
  • AUTHENTICATION_BACKENDS: List of authentication backends that are enabled based on license features and other authentication settings. (list)
    • \n
  • SOCIAL_AUTH_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)
    • \n
  • SOCIAL_AUTH_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)
    • \n
  • 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)
    • \n
  • SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean)
    • \n
  • 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)
    • \n
  • 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 documentation for example syntax. (string)
    • \n
  • AUTH_LDAP_BIND_PASSWORD: Password used to bind LDAP user account. (string)
    • \n
  • AUTH_LDAP_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)
    • \n
  • 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)
    • \n
  • AUTH_LDAP_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)
    • \n
  • 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)
    • \n
  • AUTH_LDAP_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object)
    • \n
  • 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)
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object)
    • \n
  • 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 to the service. Only one require group is supported. (string)
    • \n
  • 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)
    • \n
  • 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 documentation for more detail. (nested object)
    • \n
  • AUTH_LDAP_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)
    • \n
  • AUTH_LDAP_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)
    • \n
  • 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)
    • \n
  • 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 documentation for example syntax. (string)
    • \n
  • AUTH_LDAP_1_BIND_PASSWORD: Password used to bind LDAP user account. (string)
    • \n
  • AUTH_LDAP_1_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)
    • \n
  • 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)
    • \n
  • AUTH_LDAP_1_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)
    • \n
  • 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)
    • \n
  • AUTH_LDAP_1_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object)
    • \n
  • 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)
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_1_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object)
    • \n
  • 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 to the service. Only one require group is supported. (string)
    • \n
  • 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)
    • \n
  • 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 documentation for more detail. (nested object)
    • \n
  • AUTH_LDAP_1_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)
    • \n
  • AUTH_LDAP_1_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)
    • \n
  • 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)
    • \n
  • 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 documentation for example syntax. (string)
    • \n
  • AUTH_LDAP_2_BIND_PASSWORD: Password used to bind LDAP user account. (string)
    • \n
  • AUTH_LDAP_2_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)
    • \n
  • 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)
    • \n
  • AUTH_LDAP_2_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)
    • \n
  • 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)
    • \n
  • AUTH_LDAP_2_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object)
    • \n
  • 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)
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_2_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object)
    • \n
  • 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 to the service. Only one require group is supported. (string)
    • \n
  • 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)
    • \n
  • 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 documentation for more detail. (nested object)
    • \n
  • AUTH_LDAP_2_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)
    • \n
  • AUTH_LDAP_2_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)
    • \n
  • 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)
    • \n
  • 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 documentation for example syntax. (string)
    • \n
  • AUTH_LDAP_3_BIND_PASSWORD: Password used to bind LDAP user account. (string)
    • \n
  • AUTH_LDAP_3_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)
    • \n
  • 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)
    • \n
  • AUTH_LDAP_3_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)
    • \n
  • 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)
    • \n
  • AUTH_LDAP_3_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object)
    • \n
  • 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)
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_3_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object)
    • \n
  • 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 to the service. Only one require group is supported. (string)
    • \n
  • 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)
    • \n
  • 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 documentation for more detail. (nested object)
    • \n
  • AUTH_LDAP_3_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)
    • \n
  • AUTH_LDAP_3_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)
    • \n
  • 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)
    • \n
  • 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 documentation for example syntax. (string)
    • \n
  • AUTH_LDAP_4_BIND_PASSWORD: Password used to bind LDAP user account. (string)
    • \n
  • AUTH_LDAP_4_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)
    • \n
  • 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)
    • \n
  • AUTH_LDAP_4_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)
    • \n
  • 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)
    • \n
  • AUTH_LDAP_4_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object)
    • \n
  • 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)
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_4_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object)
    • \n
  • 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 to the service. Only one require group is supported. (string)
    • \n
  • 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)
    • \n
  • 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 documentation for more detail. (nested object)
    • \n
  • AUTH_LDAP_4_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)
    • \n
  • AUTH_LDAP_4_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)
    • \n
  • 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)
    • \n
  • 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 documentation for example syntax. (string)
    • \n
  • AUTH_LDAP_5_BIND_PASSWORD: Password used to bind LDAP user account. (string)
    • \n
  • AUTH_LDAP_5_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)
    • \n
  • 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)
    • \n
  • AUTH_LDAP_5_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)
    • \n
  • 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)
    • \n
  • AUTH_LDAP_5_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object)
    • \n
  • 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)
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_5_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object)
    • \n
  • 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 to the service. Only one require group is supported. (string)
    • \n
  • 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)
    • \n
  • 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 documentation for more detail. (nested object)
    • \n
  • AUTH_LDAP_5_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)
    • \n
  • AUTH_LDAP_5_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)
    • \n
  • RADIUS_SERVER: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string)
    • \n
  • RADIUS_PORT: Port of RADIUS server. (integer)
    • \n
  • RADIUS_SECRET: Shared secret for authenticating to RADIUS server. (string)
    • \n
  • TACACSPLUS_HOST: Hostname of TACACS+ server. (string)
    • \n
  • TACACSPLUS_PORT: Port number of TACACS+ server. (integer)
    • \n
  • TACACSPLUS_SECRET: Shared secret for authenticating to TACACS+ server. (string)
    • \n
  • TACACSPLUS_SESSION_TIMEOUT: TACACS+ session timeout value in seconds, 0 disables timeout. (integer)
    • \n
  • TACACSPLUS_AUTH_PROTOCOL: Choose the authentication protocol used by TACACS+ client. (choice)
      \n
    • ascii
      • \n
    • pap
      • \n
    \n
    • \n
  • TACACSPLUS_REM_ADDR: Enable the client address sending by TACACS+ client. (boolean)
    • \n
  • SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)
    • \n
  • SOCIAL_AUTH_GOOGLE_OAUTH2_KEY: The OAuth2 key from your web application. (string)
    • \n
  • SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET: The OAuth2 secret from your web application. (string)
    • \n
  • SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list)
    • \n
  • 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 documentation for more detail. (nested object)
    • \n
  • SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)
    • \n
  • SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)
    • \n
  • SOCIAL_AUTH_GITHUB_CALLBACK_URL: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_KEY: The OAuth2 key (Client ID) from your GitHub developer application. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_SECRET: The OAuth2 secret (Client Secret) from your GitHub developer application. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)
    • \n
  • SOCIAL_AUTH_GITHUB_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)
    • \n
  • 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 documentation for more detail. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ORG_KEY: The OAuth2 key (Client ID) from your GitHub organization application. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ORG_SECRET: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ORG_NAME: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)
    • \n
  • SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)
    • \n
  • 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)
    • \n
  • SOCIAL_AUTH_GITHUB_TEAM_KEY: The OAuth2 key (Client ID) from your GitHub organization application. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_TEAM_SECRET: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)
    • \n
  • 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)
    • \n
  • SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)
    • \n
  • SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_URL: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_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)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)
    • \n
  • 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 documentation for more detail. (string)
    • \n
  • SOCIAL_AUTH_AZUREAD_OAUTH2_KEY: The OAuth2 key (Client ID) from your Azure AD application. (string)
    • \n
  • SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET: The OAuth2 secret (Client Secret) from your Azure AD application. (string)
    • \n
  • SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)
    • \n
  • SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)
    • \n
  • SOCIAL_AUTH_OIDC_KEY: The OIDC key (Client ID) from your IDP. (string)
    • \n
  • SOCIAL_AUTH_OIDC_SECRET: The OIDC secret (Client Secret) from your IDP. (string)
    • \n
  • SOCIAL_AUTH_OIDC_OIDC_ENDPOINT: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string)
    • \n
  • SOCIAL_AUTH_OIDC_VERIFY_SSL: Verify the OIDC provider ssl certificate. (boolean)
    • \n
  • SAML_AUTO_CREATE_OBJECTS: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean)
    • \n
  • SOCIAL_AUTH_SAML_CALLBACK_URL: Register the service 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)
    • \n
  • SOCIAL_AUTH_SAML_METADATA_URL: If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL. (string)
    • \n
  • 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 the service. (string)
    • \n
  • SOCIAL_AUTH_SAML_SP_PUBLIC_CERT: Create a keypair to use as a service provider (SP) and include the certificate content here. (string)
    • \n
  • SOCIAL_AUTH_SAML_SP_PRIVATE_KEY: Create a keypair to use as a service provider (SP) and include the private key content here. (string)
    • \n
  • SOCIAL_AUTH_SAML_ORG_INFO: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object)
    • \n
  • SOCIAL_AUTH_SAML_TECHNICAL_CONTACT: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object)
    • \n
  • SOCIAL_AUTH_SAML_SUPPORT_CONTACT: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • SOCIAL_AUTH_SAML_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)
    • \n
  • SOCIAL_AUTH_SAML_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)
    • \n
  • SOCIAL_AUTH_SAML_ORGANIZATION_ATTR: Used to translate user organization membership. (nested object)
    • \n
  • SOCIAL_AUTH_SAML_TEAM_ATTR: Used to translate user team membership. (nested object)
    • \n
  • SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR: Used to map super users and system auditors from SAML. (nested object)
    • \n
  • LOCAL_PASSWORD_MIN_LENGTH: Minimum number of characters required in a local password. 0 means no minimum (integer)
    • \n
  • LOCAL_PASSWORD_MIN_DIGITS: Minimum number of digit characters required in a local password. 0 means no minimum (integer)
    • \n
  • LOCAL_PASSWORD_MIN_UPPER: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer)
    • \n
  • LOCAL_PASSWORD_MIN_SPECIAL: Minimum number of special characters required in a local password. 0 means no minimum (integer)
    • \n
", "operationId":"api_settings_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/SettingSingleton" } } }, "summary":"Retrieve a Setting", "tags":[ "Settings" ], "x-internal-id":"api-v2-settings-{category_slug}--get", "x-filename-id":"api-v2-settings-category_slug-get" }, "parameters":[ { "in":"path", "name":"category_slug", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\nsetting. The following fields may be modified:

\n
    \n
  • ACTIVITY_STREAM_ENABLED: Enable capturing activity for the activity stream. (boolean, required)
    • \n
  • ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC: Enable capturing activity for the activity stream when running inventory sync. (boolean, required)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • TOWER_URL_BASE: This setting is used by services like notifications to render a valid url to the service. (string, required)
    • \n
  • 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 AAP Installation guide for more details. (list, required)
    • \n
  • PROXY_IP_ALLOWED_LIST: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service 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)
    • \n
  • \n

    CSRF_TRUSTED_ORIGINS: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list, default=[])

    \n
    • \n
  • \n

    REDHAT_USERNAME: This username is used to send data to Automation Analytics (string, default=\"\")

    \n
    • \n
  • REDHAT_PASSWORD: This password is used to send data to Automation Analytics (string, default=\"\")
    • \n
  • SUBSCRIPTIONS_USERNAME: This username is used to retrieve subscription and content information (string, default=\"\")
    • \n
  • SUBSCRIPTIONS_PASSWORD: This password is used to retrieve subscription and content information (string, default=\"\")
    • \n
  • \n

    AUTOMATION_ANALYTICS_URL: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string, default=\"https://example.com\")

    \n
    • \n
  • \n

    DEFAULT_EXECUTION_ENVIRONMENT: The Execution Environment to be used when one has not been configured for a job template. (field, default=None)

    \n
    • \n
  • 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=[])
    • \n
  • AD_HOC_COMMANDS: List of modules allowed to be used by ad-hoc jobs. (list, default=[&#x27;command&#x27;, &#x27;shell&#x27;, &#x27;yum&#x27;, &#x27;apt&#x27;, &#x27;apt_key&#x27;, &#x27;apt_repository&#x27;, &#x27;apt_rpm&#x27;, &#x27;service&#x27;, &#x27;group&#x27;, &#x27;user&#x27;, &#x27;mount&#x27;, &#x27;ping&#x27;, &#x27;selinux&#x27;, &#x27;setup&#x27;, &#x27;win_ping&#x27;, &#x27;win_service&#x27;, &#x27;win_updates&#x27;, &#x27;win_group&#x27;, &#x27;win_user&#x27;])
    • \n
  • ALLOW_JINJA_IN_EXTRA_VARS: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where 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)
      \n
    • always: Always
      • \n
    • never: Never
      • \n
    • template: Only On Job Template Definitions (default)
      • \n
    \n
    • \n
  • AWX_ISOLATION_BASE_PATH: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string, required)
    • \n
  • AWX_ISOLATION_SHOW_PATHS: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list, default=[])
    • \n
  • AWX_TASK_ENV: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object, default={})
    • \n
  • AWX_RUNNER_KEEPALIVE_SECONDS: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer, required)
    • \n
  • GALAXY_TASK_ENV: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object, required)
    • \n
  • INSIGHTS_TRACKING_STATE: Enables the service to gather data on automation and send it to Automation Analytics. (boolean, default=False)
    • \n
  • PROJECT_UPDATE_VVV: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean, required)
    • \n
  • AWX_ROLES_ENABLED: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=True)
    • \n
  • AWX_COLLECTIONS_ENABLED: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=True)
    • \n
  • 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)
    • \n
  • AWX_MOUNT_ISOLATED_PATHS_ON_K8S: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean, default=False)
    • \n
  • GALAXY_IGNORE_CERTS: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean, default=False)
    • \n
  • STDOUT_MAX_BYTES_DISPLAY: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer, required)
    • \n
  • 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)
    • \n
  • MAX_WEBSOCKET_EVENT_RATE: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer, default=30)
    • \n
  • 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)
    • \n
  • 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=[])
    • \n
  • 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)
    • \n
  • DEFAULT_JOB_IDLE_TIMEOUT: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer, default=0)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • LOG_AGGREGATOR_HOST: Hostname/IP where external logs will be sent to. (string, default=\"\")
    • \n
  • LOG_AGGREGATOR_PORT: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer, default=None)
    • \n
  • LOG_AGGREGATOR_TYPE: Format messages for the chosen log aggregator. (choice)
      \n
    • None: --------- (default)
      • \n
    • logstash
      • \n
    • splunk
      • \n
    • loggly
      • \n
    • sumologic
      • \n
    • other
      • \n
    \n
    • \n
  • LOG_AGGREGATOR_USERNAME: Username for external log aggregator (if required; HTTP/s only). (string, default=\"\")
    • \n
  • LOG_AGGREGATOR_PASSWORD: Password or authentication token for external log aggregator (if required; HTTP/s only). (string, default=\"\")
    • \n
  • 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\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list, default=[&#x27;awx&#x27;, &#x27;activity_stream&#x27;, &#x27;job_events&#x27;, &#x27;system_tracking&#x27;, &#x27;broadcast_websocket&#x27;])
    • \n
  • 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)
    • \n
  • LOG_AGGREGATOR_ENABLED: Enable sending logs to external log aggregator. (boolean, default=False)
    • \n
  • LOG_AGGREGATOR_TOWER_UUID: Useful to uniquely identify instances. (string, default=\"\")
    • \n
  • 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)
      \n
    • https: HTTPS/HTTP (default)
      • \n
    • tcp: TCP
      • \n
    • udp: UDP
      • \n
    \n
    • \n
  • LOG_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)
    • \n
  • LOG_AGGREGATOR_VERIFY_CERT: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean, default=True)
    • \n
  • 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)
      \n
    • DEBUG
      • \n
    • INFO (default)
      • \n
    • WARNING
      • \n
    • ERROR
      • \n
    • CRITICAL
      • \n
    \n
    • \n
  • LOG_AGGREGATOR_ACTION_QUEUE_SIZE: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer, default=131072)
    • \n
  • LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer, default=1)
    • \n
  • 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\")
    • \n
  • LOG_AGGREGATOR_RSYSLOGD_DEBUG: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean, default=False)
    • \n
  • API_400_ERROR_LOG_FORMAT: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string, default=\"status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}\")
    • \n
  • AUTOMATION_ANALYTICS_LAST_GATHER: (datetime, required)
    • \n
  • AUTOMATION_ANALYTICS_LAST_ENTRIES: (string, default=\"\")
    • \n
  • \n

    AUTOMATION_ANALYTICS_GATHER_INTERVAL: Interval (in seconds) between data gathering. (integer, default=14400)

    \n
    • \n
  • \n

    BULK_JOB_MAX_LAUNCH: Max jobs to allow bulk jobs to launch (integer, default=100)

    \n
    • \n
  • BULK_HOST_MAX_CREATE: Max number of hosts to allow to be created in a single bulk action (integer, default=100)
    • \n
  • BULK_HOST_MAX_DELETE: Max number of hosts to allow to be deleted in a single bulk action (integer, default=250)
    • \n
  • UI_NEXT: Enable preview of new user interface. (boolean, default=False)
    • \n
  • SUBSCRIPTION_USAGE_MODEL: (choice)
      \n
    • \"\": Default model for AWX - no subscription. Deletion of host_metrics will not be considered for purposes of managed host counting (default)
      • \n
    • unique_managed_hosts: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes
      • \n
    \n
    • \n
  • CLEANUP_HOST_METRICS_LAST_TS: (datetime, required)
    • \n
  • HOST_METRIC_SUMMARY_TASK_LAST_TS: (datetime, required)
    • \n
  • AWX_CLEANUP_PATHS: Enable or Disable TMP Dir cleanup (boolean, default=True)
    • \n
  • AWX_REQUEST_PROFILE: Debug web request python timing (boolean, default=False)
    • \n
  • DEFAULT_CONTAINER_RUN_OPTIONS: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list, default=[&#x27;--network&#x27;, &#x27;slirp4netns:enable_ipv6=true&#x27;])
    • \n
  • \n

    RECEPTOR_RELEASE_WORK: Release receptor work (boolean, default=True)

    \n
    • \n
  • \n

    SESSION_COOKIE_AGE: Number of seconds that a user is inactive before they will need to login again. (integer, required)

    \n
    • \n
  • SESSIONS_PER_USER: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer, required)
    • \n
  • DISABLE_LOCAL_AUTH: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean, required)
    • \n
  • AUTH_BASIC_ENABLED: Enable HTTP Basic Auth for the API Browser. (boolean, required)
    • \n
  • 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={&#x27;ACCESS_TOKEN_EXPIRE_SECONDS&#x27;: 31536000000, &#x27;AUTHORIZATION_CODE_EXPIRE_SECONDS&#x27;: 600, &#x27;REFRESH_TOKEN_EXPIRE_SECONDS&#x27;: 2628000})
    • \n
  • 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)
    • \n
  • LOGIN_REDIRECT_OVERRIDE: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string, default=\"\")
    • \n
  • \n

    ALLOW_METRICS_FOR_ANONYMOUS_USERS: If true, anonymous users are allowed to poll metrics. (boolean, default=False)

    \n
    • \n
  • \n

    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=\"\")

    \n
    • \n
  • 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=\"\")
    • \n
  • MAX_UI_JOB_EVENTS: Maximum number of job events for the UI to retrieve within a single request. (integer, required)
    • \n
  • \n

    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)

    \n
    • \n
  • \n

    SOCIAL_AUTH_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)

    \n
    • \n
  • SOCIAL_AUTH_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)
    • \n
  • 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)
    • \n
  • SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean, default=False)
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for example syntax. (string, default=\"\")
    • \n
  • AUTH_LDAP_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")
    • \n
  • AUTH_LDAP_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)
    • \n
  • 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={&#x27;OPT_REFERRALS&#x27;: 0, &#x27;OPT_NETWORK_TIMEOUT&#x27;: 30})
    • \n
  • AUTH_LDAP_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=[])
    • \n
  • 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=\"\")
    • \n
  • AUTH_LDAP_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object, default={})
    • \n
  • 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=[])
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType (default)
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([(&#x27;member_attr&#x27;, &#x27;member&#x27;), (&#x27;name_attr&#x27;, &#x27;cn&#x27;)]))
    • \n
  • 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 to the service. Only one require group is supported. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • AUTH_LDAP_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • AUTH_LDAP_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for example syntax. (string, default=\"\")
    • \n
  • AUTH_LDAP_1_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")
    • \n
  • AUTH_LDAP_1_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)
    • \n
  • 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={&#x27;OPT_REFERRALS&#x27;: 0, &#x27;OPT_NETWORK_TIMEOUT&#x27;: 30})
    • \n
  • AUTH_LDAP_1_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=[])
    • \n
  • 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=\"\")
    • \n
  • AUTH_LDAP_1_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object, default={})
    • \n
  • 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=[])
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType (default)
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_1_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([(&#x27;member_attr&#x27;, &#x27;member&#x27;), (&#x27;name_attr&#x27;, &#x27;cn&#x27;)]))
    • \n
  • 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 to the service. Only one require group is supported. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • AUTH_LDAP_1_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • AUTH_LDAP_1_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for example syntax. (string, default=\"\")
    • \n
  • AUTH_LDAP_2_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")
    • \n
  • AUTH_LDAP_2_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)
    • \n
  • 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={&#x27;OPT_REFERRALS&#x27;: 0, &#x27;OPT_NETWORK_TIMEOUT&#x27;: 30})
    • \n
  • AUTH_LDAP_2_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=[])
    • \n
  • 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=\"\")
    • \n
  • AUTH_LDAP_2_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object, default={})
    • \n
  • 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=[])
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType (default)
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_2_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([(&#x27;member_attr&#x27;, &#x27;member&#x27;), (&#x27;name_attr&#x27;, &#x27;cn&#x27;)]))
    • \n
  • 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 to the service. Only one require group is supported. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • AUTH_LDAP_2_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • AUTH_LDAP_2_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for example syntax. (string, default=\"\")
    • \n
  • AUTH_LDAP_3_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")
    • \n
  • AUTH_LDAP_3_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)
    • \n
  • 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={&#x27;OPT_REFERRALS&#x27;: 0, &#x27;OPT_NETWORK_TIMEOUT&#x27;: 30})
    • \n
  • AUTH_LDAP_3_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=[])
    • \n
  • 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=\"\")
    • \n
  • AUTH_LDAP_3_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object, default={})
    • \n
  • 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=[])
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType (default)
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_3_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([(&#x27;member_attr&#x27;, &#x27;member&#x27;), (&#x27;name_attr&#x27;, &#x27;cn&#x27;)]))
    • \n
  • 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 to the service. Only one require group is supported. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • AUTH_LDAP_3_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • AUTH_LDAP_3_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for example syntax. (string, default=\"\")
    • \n
  • AUTH_LDAP_4_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")
    • \n
  • AUTH_LDAP_4_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)
    • \n
  • 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={&#x27;OPT_REFERRALS&#x27;: 0, &#x27;OPT_NETWORK_TIMEOUT&#x27;: 30})
    • \n
  • AUTH_LDAP_4_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=[])
    • \n
  • 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=\"\")
    • \n
  • AUTH_LDAP_4_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object, default={})
    • \n
  • 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=[])
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType (default)
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_4_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([(&#x27;member_attr&#x27;, &#x27;member&#x27;), (&#x27;name_attr&#x27;, &#x27;cn&#x27;)]))
    • \n
  • 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 to the service. Only one require group is supported. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • AUTH_LDAP_4_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • AUTH_LDAP_4_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for example syntax. (string, default=\"\")
    • \n
  • AUTH_LDAP_5_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")
    • \n
  • AUTH_LDAP_5_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)
    • \n
  • 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={&#x27;OPT_REFERRALS&#x27;: 0, &#x27;OPT_NETWORK_TIMEOUT&#x27;: 30})
    • \n
  • AUTH_LDAP_5_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=[])
    • \n
  • 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=\"\")
    • \n
  • AUTH_LDAP_5_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object, default={})
    • \n
  • 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=[])
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType (default)
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_5_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([(&#x27;member_attr&#x27;, &#x27;member&#x27;), (&#x27;name_attr&#x27;, &#x27;cn&#x27;)]))
    • \n
  • 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 to the service. Only one require group is supported. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • AUTH_LDAP_5_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • AUTH_LDAP_5_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • RADIUS_SERVER: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string, default=\"\")
    • \n
  • RADIUS_PORT: Port of RADIUS server. (integer, default=1812)
    • \n
  • RADIUS_SECRET: Shared secret for authenticating to RADIUS server. (string, default=\"\")
    • \n
  • TACACSPLUS_HOST: Hostname of TACACS+ server. (string, default=\"\")
    • \n
  • TACACSPLUS_PORT: Port number of TACACS+ server. (integer, default=49)
    • \n
  • TACACSPLUS_SECRET: Shared secret for authenticating to TACACS+ server. (string, default=\"\")
    • \n
  • TACACSPLUS_SESSION_TIMEOUT: TACACS+ session timeout value in seconds, 0 disables timeout. (integer, default=5)
    • \n
  • TACACSPLUS_AUTH_PROTOCOL: Choose the authentication protocol used by TACACS+ client. (choice)
      \n
    • ascii (default)
      • \n
    • pap
      • \n
    \n
    • \n
  • \n

    TACACSPLUS_REM_ADDR: Enable the client address sending by TACACS+ client. (boolean, default=False)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GOOGLE_OAUTH2_KEY: The OAuth2 key from your web application. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET: The OAuth2 secret from your web application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list, default=[])
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_KEY: The OAuth2 key (Client ID) from your GitHub developer application. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GITHUB_SECRET: The OAuth2 secret (Client Secret) from your GitHub developer application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ORG_KEY: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GITHUB_ORG_SECRET: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ORG_NAME: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_TEAM_KEY: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GITHUB_TEAM_SECRET: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ENTERPRISE_URL: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_AZUREAD_OAUTH2_KEY: The OAuth2 key (Client ID) from your Azure AD application. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET: The OAuth2 secret (Client Secret) from your Azure AD application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)
    • \n
  • SOCIAL_AUTH_OIDC_KEY: The OIDC key (Client ID) from your IDP. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_OIDC_SECRET: The OIDC secret (Client Secret) from your IDP. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_OIDC_OIDC_ENDPOINT: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string, default=\"\")
    • \n
  • SOCIAL_AUTH_OIDC_VERIFY_SSL: Verify the OIDC provider ssl certificate. (boolean, default=True)
    • \n
  • \n

    SAML_AUTO_CREATE_OBJECTS: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean, default=True)

    \n
    • \n
  • \n

    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 the service. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_SAML_SP_PUBLIC_CERT: Create a keypair to use as a service provider (SP) and include the certificate content here. (string, required)
    • \n
  • SOCIAL_AUTH_SAML_SP_PRIVATE_KEY: Create a keypair to use as a service provider (SP) and include the private key content here. (string, required)
    • \n
  • SOCIAL_AUTH_SAML_ORG_INFO: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object, required)
    • \n
  • SOCIAL_AUTH_SAML_TECHNICAL_CONTACT: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object, required)
    • \n
  • SOCIAL_AUTH_SAML_SUPPORT_CONTACT: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object, required)
    • \n
  • 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={})
    • \n
  • 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={&#x27;requestedAuthnContext&#x27;: False})
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • SOCIAL_AUTH_SAML_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • SOCIAL_AUTH_SAML_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)
    • \n
  • SOCIAL_AUTH_SAML_ORGANIZATION_ATTR: Used to translate user organization membership. (nested object, default={})
    • \n
  • SOCIAL_AUTH_SAML_TEAM_ATTR: Used to translate user team membership. (nested object, default={})
    • \n
  • SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR: Used to map super users and system auditors from SAML. (nested object, default={})
    • \n
  • LOCAL_PASSWORD_MIN_LENGTH: Minimum number of characters required in a local password. 0 means no minimum (integer, default=0)
    • \n
  • LOCAL_PASSWORD_MIN_DIGITS: Minimum number of digit characters required in a local password. 0 means no minimum (integer, default=0)
    • \n
  • LOCAL_PASSWORD_MIN_UPPER: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer, default=0)
    • \n
  • LOCAL_PASSWORD_MIN_SPECIAL: Minimum number of special characters required in a local password. 0 means no minimum (integer, default=0)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_settings_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/SettingSingleton" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/SettingSingleton" } } }, "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":{ "description":"

Make a PUT or PATCH request to this resource to update this\nsetting. The following fields may be modified:

\n
    \n
  • ACTIVITY_STREAM_ENABLED: Enable capturing activity for the activity stream. (boolean, required)
    • \n
  • ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC: Enable capturing activity for the activity stream when running inventory sync. (boolean, required)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • TOWER_URL_BASE: This setting is used by services like notifications to render a valid url to the service. (string, required)
    • \n
  • 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 AAP Installation guide for more details. (list, required)
    • \n
  • PROXY_IP_ALLOWED_LIST: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service 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)
    • \n
  • \n

    CSRF_TRUSTED_ORIGINS: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list, default=[])

    \n
    • \n
  • \n

    REDHAT_USERNAME: This username is used to send data to Automation Analytics (string, default=\"\")

    \n
    • \n
  • REDHAT_PASSWORD: This password is used to send data to Automation Analytics (string, default=\"\")
    • \n
  • SUBSCRIPTIONS_USERNAME: This username is used to retrieve subscription and content information (string, default=\"\")
    • \n
  • SUBSCRIPTIONS_PASSWORD: This password is used to retrieve subscription and content information (string, default=\"\")
    • \n
  • \n

    AUTOMATION_ANALYTICS_URL: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string, default=\"https://example.com\")

    \n
    • \n
  • \n

    DEFAULT_EXECUTION_ENVIRONMENT: The Execution Environment to be used when one has not been configured for a job template. (field, default=None)

    \n
    • \n
  • 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=[])
    • \n
  • AD_HOC_COMMANDS: List of modules allowed to be used by ad-hoc jobs. (list, default=[&#x27;command&#x27;, &#x27;shell&#x27;, &#x27;yum&#x27;, &#x27;apt&#x27;, &#x27;apt_key&#x27;, &#x27;apt_repository&#x27;, &#x27;apt_rpm&#x27;, &#x27;service&#x27;, &#x27;group&#x27;, &#x27;user&#x27;, &#x27;mount&#x27;, &#x27;ping&#x27;, &#x27;selinux&#x27;, &#x27;setup&#x27;, &#x27;win_ping&#x27;, &#x27;win_service&#x27;, &#x27;win_updates&#x27;, &#x27;win_group&#x27;, &#x27;win_user&#x27;])
    • \n
  • ALLOW_JINJA_IN_EXTRA_VARS: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where 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)
      \n
    • always: Always
      • \n
    • never: Never
      • \n
    • template: Only On Job Template Definitions (default)
      • \n
    \n
    • \n
  • AWX_ISOLATION_BASE_PATH: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string, required)
    • \n
  • AWX_ISOLATION_SHOW_PATHS: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list, default=[])
    • \n
  • AWX_TASK_ENV: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object, default={})
    • \n
  • AWX_RUNNER_KEEPALIVE_SECONDS: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer, required)
    • \n
  • GALAXY_TASK_ENV: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object, required)
    • \n
  • INSIGHTS_TRACKING_STATE: Enables the service to gather data on automation and send it to Automation Analytics. (boolean, default=False)
    • \n
  • PROJECT_UPDATE_VVV: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean, required)
    • \n
  • AWX_ROLES_ENABLED: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=True)
    • \n
  • AWX_COLLECTIONS_ENABLED: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=True)
    • \n
  • 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)
    • \n
  • AWX_MOUNT_ISOLATED_PATHS_ON_K8S: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean, default=False)
    • \n
  • GALAXY_IGNORE_CERTS: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean, default=False)
    • \n
  • STDOUT_MAX_BYTES_DISPLAY: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer, required)
    • \n
  • 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)
    • \n
  • MAX_WEBSOCKET_EVENT_RATE: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer, default=30)
    • \n
  • 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)
    • \n
  • 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=[])
    • \n
  • 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)
    • \n
  • DEFAULT_JOB_IDLE_TIMEOUT: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer, default=0)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • LOG_AGGREGATOR_HOST: Hostname/IP where external logs will be sent to. (string, default=\"\")
    • \n
  • LOG_AGGREGATOR_PORT: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer, default=None)
    • \n
  • LOG_AGGREGATOR_TYPE: Format messages for the chosen log aggregator. (choice)
      \n
    • None: --------- (default)
      • \n
    • logstash
      • \n
    • splunk
      • \n
    • loggly
      • \n
    • sumologic
      • \n
    • other
      • \n
    \n
    • \n
  • LOG_AGGREGATOR_USERNAME: Username for external log aggregator (if required; HTTP/s only). (string, default=\"\")
    • \n
  • LOG_AGGREGATOR_PASSWORD: Password or authentication token for external log aggregator (if required; HTTP/s only). (string, default=\"\")
    • \n
  • 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\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list, default=[&#x27;awx&#x27;, &#x27;activity_stream&#x27;, &#x27;job_events&#x27;, &#x27;system_tracking&#x27;, &#x27;broadcast_websocket&#x27;])
    • \n
  • 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)
    • \n
  • LOG_AGGREGATOR_ENABLED: Enable sending logs to external log aggregator. (boolean, default=False)
    • \n
  • LOG_AGGREGATOR_TOWER_UUID: Useful to uniquely identify instances. (string, default=\"\")
    • \n
  • 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)
      \n
    • https: HTTPS/HTTP (default)
      • \n
    • tcp: TCP
      • \n
    • udp: UDP
      • \n
    \n
    • \n
  • LOG_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)
    • \n
  • LOG_AGGREGATOR_VERIFY_CERT: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean, default=True)
    • \n
  • 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)
      \n
    • DEBUG
      • \n
    • INFO (default)
      • \n
    • WARNING
      • \n
    • ERROR
      • \n
    • CRITICAL
      • \n
    \n
    • \n
  • LOG_AGGREGATOR_ACTION_QUEUE_SIZE: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer, default=131072)
    • \n
  • LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer, default=1)
    • \n
  • 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\")
    • \n
  • LOG_AGGREGATOR_RSYSLOGD_DEBUG: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean, default=False)
    • \n
  • API_400_ERROR_LOG_FORMAT: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string, default=\"status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}\")
    • \n
  • AUTOMATION_ANALYTICS_LAST_GATHER: (datetime, required)
    • \n
  • AUTOMATION_ANALYTICS_LAST_ENTRIES: (string, default=\"\")
    • \n
  • \n

    AUTOMATION_ANALYTICS_GATHER_INTERVAL: Interval (in seconds) between data gathering. (integer, default=14400)

    \n
    • \n
  • \n

    BULK_JOB_MAX_LAUNCH: Max jobs to allow bulk jobs to launch (integer, default=100)

    \n
    • \n
  • BULK_HOST_MAX_CREATE: Max number of hosts to allow to be created in a single bulk action (integer, default=100)
    • \n
  • BULK_HOST_MAX_DELETE: Max number of hosts to allow to be deleted in a single bulk action (integer, default=250)
    • \n
  • UI_NEXT: Enable preview of new user interface. (boolean, default=False)
    • \n
  • SUBSCRIPTION_USAGE_MODEL: (choice)
      \n
    • \"\": Default model for AWX - no subscription. Deletion of host_metrics will not be considered for purposes of managed host counting (default)
      • \n
    • unique_managed_hosts: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes
      • \n
    \n
    • \n
  • CLEANUP_HOST_METRICS_LAST_TS: (datetime, required)
    • \n
  • HOST_METRIC_SUMMARY_TASK_LAST_TS: (datetime, required)
    • \n
  • AWX_CLEANUP_PATHS: Enable or Disable TMP Dir cleanup (boolean, default=True)
    • \n
  • AWX_REQUEST_PROFILE: Debug web request python timing (boolean, default=False)
    • \n
  • DEFAULT_CONTAINER_RUN_OPTIONS: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list, default=[&#x27;--network&#x27;, &#x27;slirp4netns:enable_ipv6=true&#x27;])
    • \n
  • \n

    RECEPTOR_RELEASE_WORK: Release receptor work (boolean, default=True)

    \n
    • \n
  • \n

    SESSION_COOKIE_AGE: Number of seconds that a user is inactive before they will need to login again. (integer, required)

    \n
    • \n
  • SESSIONS_PER_USER: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer, required)
    • \n
  • DISABLE_LOCAL_AUTH: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean, required)
    • \n
  • AUTH_BASIC_ENABLED: Enable HTTP Basic Auth for the API Browser. (boolean, required)
    • \n
  • 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={&#x27;ACCESS_TOKEN_EXPIRE_SECONDS&#x27;: 31536000000, &#x27;AUTHORIZATION_CODE_EXPIRE_SECONDS&#x27;: 600, &#x27;REFRESH_TOKEN_EXPIRE_SECONDS&#x27;: 2628000})
    • \n
  • 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)
    • \n
  • LOGIN_REDIRECT_OVERRIDE: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string, default=\"\")
    • \n
  • \n

    ALLOW_METRICS_FOR_ANONYMOUS_USERS: If true, anonymous users are allowed to poll metrics. (boolean, default=False)

    \n
    • \n
  • \n

    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=\"\")

    \n
    • \n
  • 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=\"\")
    • \n
  • MAX_UI_JOB_EVENTS: Maximum number of job events for the UI to retrieve within a single request. (integer, required)
    • \n
  • \n

    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)

    \n
    • \n
  • \n

    SOCIAL_AUTH_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)

    \n
    • \n
  • SOCIAL_AUTH_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)
    • \n
  • 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)
    • \n
  • SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean, default=False)
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for example syntax. (string, default=\"\")
    • \n
  • AUTH_LDAP_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")
    • \n
  • AUTH_LDAP_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)
    • \n
  • 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={&#x27;OPT_REFERRALS&#x27;: 0, &#x27;OPT_NETWORK_TIMEOUT&#x27;: 30})
    • \n
  • AUTH_LDAP_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=[])
    • \n
  • 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=\"\")
    • \n
  • AUTH_LDAP_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object, default={})
    • \n
  • 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=[])
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType (default)
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([(&#x27;member_attr&#x27;, &#x27;member&#x27;), (&#x27;name_attr&#x27;, &#x27;cn&#x27;)]))
    • \n
  • 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 to the service. Only one require group is supported. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • AUTH_LDAP_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • AUTH_LDAP_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for example syntax. (string, default=\"\")
    • \n
  • AUTH_LDAP_1_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")
    • \n
  • AUTH_LDAP_1_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)
    • \n
  • 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={&#x27;OPT_REFERRALS&#x27;: 0, &#x27;OPT_NETWORK_TIMEOUT&#x27;: 30})
    • \n
  • AUTH_LDAP_1_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=[])
    • \n
  • 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=\"\")
    • \n
  • AUTH_LDAP_1_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object, default={})
    • \n
  • 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=[])
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType (default)
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_1_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([(&#x27;member_attr&#x27;, &#x27;member&#x27;), (&#x27;name_attr&#x27;, &#x27;cn&#x27;)]))
    • \n
  • 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 to the service. Only one require group is supported. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • AUTH_LDAP_1_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • AUTH_LDAP_1_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for example syntax. (string, default=\"\")
    • \n
  • AUTH_LDAP_2_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")
    • \n
  • AUTH_LDAP_2_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)
    • \n
  • 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={&#x27;OPT_REFERRALS&#x27;: 0, &#x27;OPT_NETWORK_TIMEOUT&#x27;: 30})
    • \n
  • AUTH_LDAP_2_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=[])
    • \n
  • 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=\"\")
    • \n
  • AUTH_LDAP_2_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object, default={})
    • \n
  • 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=[])
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType (default)
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_2_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([(&#x27;member_attr&#x27;, &#x27;member&#x27;), (&#x27;name_attr&#x27;, &#x27;cn&#x27;)]))
    • \n
  • 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 to the service. Only one require group is supported. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • AUTH_LDAP_2_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • AUTH_LDAP_2_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for example syntax. (string, default=\"\")
    • \n
  • AUTH_LDAP_3_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")
    • \n
  • AUTH_LDAP_3_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)
    • \n
  • 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={&#x27;OPT_REFERRALS&#x27;: 0, &#x27;OPT_NETWORK_TIMEOUT&#x27;: 30})
    • \n
  • AUTH_LDAP_3_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=[])
    • \n
  • 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=\"\")
    • \n
  • AUTH_LDAP_3_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object, default={})
    • \n
  • 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=[])
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType (default)
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_3_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([(&#x27;member_attr&#x27;, &#x27;member&#x27;), (&#x27;name_attr&#x27;, &#x27;cn&#x27;)]))
    • \n
  • 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 to the service. Only one require group is supported. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • AUTH_LDAP_3_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • AUTH_LDAP_3_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for example syntax. (string, default=\"\")
    • \n
  • AUTH_LDAP_4_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")
    • \n
  • AUTH_LDAP_4_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)
    • \n
  • 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={&#x27;OPT_REFERRALS&#x27;: 0, &#x27;OPT_NETWORK_TIMEOUT&#x27;: 30})
    • \n
  • AUTH_LDAP_4_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=[])
    • \n
  • 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=\"\")
    • \n
  • AUTH_LDAP_4_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object, default={})
    • \n
  • 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=[])
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType (default)
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_4_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([(&#x27;member_attr&#x27;, &#x27;member&#x27;), (&#x27;name_attr&#x27;, &#x27;cn&#x27;)]))
    • \n
  • 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 to the service. Only one require group is supported. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • AUTH_LDAP_4_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • AUTH_LDAP_4_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for example syntax. (string, default=\"\")
    • \n
  • AUTH_LDAP_5_BIND_PASSWORD: Password used to bind LDAP user account. (string, default=\"\")
    • \n
  • AUTH_LDAP_5_START_TLS: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=False)
    • \n
  • 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={&#x27;OPT_REFERRALS&#x27;: 0, &#x27;OPT_NETWORK_TIMEOUT&#x27;: 30})
    • \n
  • AUTH_LDAP_5_USER_SEARCH: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=[])
    • \n
  • 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=\"\")
    • \n
  • AUTH_LDAP_5_USER_ATTR_MAP: Mapping of LDAP user schema to 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 documentation for additional details. (nested object, default={})
    • \n
  • 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=[])
    • \n
  • 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)
      \n
    • PosixGroupType
      • \n
    • GroupOfNamesType
      • \n
    • GroupOfUniqueNamesType
      • \n
    • ActiveDirectoryGroupType
      • \n
    • OrganizationalRoleGroupType
      • \n
    • MemberDNGroupType (default)
      • \n
    • NestedGroupOfNamesType
      • \n
    • NestedGroupOfUniqueNamesType
      • \n
    • NestedActiveDirectoryGroupType
      • \n
    • NestedOrganizationalRoleGroupType
      • \n
    • NestedMemberDNGroupType
      • \n
    • PosixUIDGroupType
      • \n
    \n
    • \n
  • AUTH_LDAP_5_GROUP_TYPE_PARAMS: Key value parameters to send the chosen group type init method. (nested object, default=OrderedDict([(&#x27;member_attr&#x27;, &#x27;member&#x27;), (&#x27;name_attr&#x27;, &#x27;cn&#x27;)]))
    • \n
  • 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 to the service. Only one require group is supported. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • AUTH_LDAP_5_ORGANIZATION_MAP: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • AUTH_LDAP_5_TEAM_MAP: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default={})
    • \n
  • RADIUS_SERVER: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string, default=\"\")
    • \n
  • RADIUS_PORT: Port of RADIUS server. (integer, default=1812)
    • \n
  • RADIUS_SECRET: Shared secret for authenticating to RADIUS server. (string, default=\"\")
    • \n
  • TACACSPLUS_HOST: Hostname of TACACS+ server. (string, default=\"\")
    • \n
  • TACACSPLUS_PORT: Port number of TACACS+ server. (integer, default=49)
    • \n
  • TACACSPLUS_SECRET: Shared secret for authenticating to TACACS+ server. (string, default=\"\")
    • \n
  • TACACSPLUS_SESSION_TIMEOUT: TACACS+ session timeout value in seconds, 0 disables timeout. (integer, default=5)
    • \n
  • TACACSPLUS_AUTH_PROTOCOL: Choose the authentication protocol used by TACACS+ client. (choice)
      \n
    • ascii (default)
      • \n
    • pap
      • \n
    \n
    • \n
  • \n

    TACACSPLUS_REM_ADDR: Enable the client address sending by TACACS+ client. (boolean, default=False)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GOOGLE_OAUTH2_KEY: The OAuth2 key from your web application. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET: The OAuth2 secret from your web application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list, default=[])
    • \n
  • 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 documentation for more detail. (nested object, default={})
    • \n
  • SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_KEY: The OAuth2 key (Client ID) from your GitHub developer application. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GITHUB_SECRET: The OAuth2 secret (Client Secret) from your GitHub developer application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ORG_KEY: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GITHUB_ORG_SECRET: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ORG_NAME: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_TEAM_KEY: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GITHUB_TEAM_SECRET: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=\"\")
    • \n
  • 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=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ENTERPRISE_URL: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • \n

    SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)

    \n
    • \n
  • \n

    SOCIAL_AUTH_AZUREAD_OAUTH2_KEY: The OAuth2 key (Client ID) from your Azure AD application. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET: The OAuth2 secret (Client Secret) from your Azure AD application. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)
    • \n
  • SOCIAL_AUTH_OIDC_KEY: The OIDC key (Client ID) from your IDP. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_OIDC_SECRET: The OIDC secret (Client Secret) from your IDP. (string, default=\"\")
    • \n
  • SOCIAL_AUTH_OIDC_OIDC_ENDPOINT: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string, default=\"\")
    • \n
  • SOCIAL_AUTH_OIDC_VERIFY_SSL: Verify the OIDC provider ssl certificate. (boolean, default=True)
    • \n
  • \n

    SAML_AUTO_CREATE_OBJECTS: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean, default=True)

    \n
    • \n
  • \n

    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 the service. (string, default=\"\")

    \n
    • \n
  • SOCIAL_AUTH_SAML_SP_PUBLIC_CERT: Create a keypair to use as a service provider (SP) and include the certificate content here. (string, required)
    • \n
  • SOCIAL_AUTH_SAML_SP_PRIVATE_KEY: Create a keypair to use as a service provider (SP) and include the private key content here. (string, required)
    • \n
  • SOCIAL_AUTH_SAML_ORG_INFO: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object, required)
    • \n
  • SOCIAL_AUTH_SAML_TECHNICAL_CONTACT: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object, required)
    • \n
  • SOCIAL_AUTH_SAML_SUPPORT_CONTACT: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object, required)
    • \n
  • 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={})
    • \n
  • 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={&#x27;requestedAuthnContext&#x27;: False})
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • SOCIAL_AUTH_SAML_ORGANIZATION_MAP: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=None)
    • \n
  • SOCIAL_AUTH_SAML_TEAM_MAP: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=None)
    • \n
  • SOCIAL_AUTH_SAML_ORGANIZATION_ATTR: Used to translate user organization membership. (nested object, default={})
    • \n
  • SOCIAL_AUTH_SAML_TEAM_ATTR: Used to translate user team membership. (nested object, default={})
    • \n
  • SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR: Used to map super users and system auditors from SAML. (nested object, default={})
    • \n
  • LOCAL_PASSWORD_MIN_LENGTH: Minimum number of characters required in a local password. 0 means no minimum (integer, default=0)
    • \n
  • LOCAL_PASSWORD_MIN_DIGITS: Minimum number of digit characters required in a local password. 0 means no minimum (integer, default=0)
    • \n
  • LOCAL_PASSWORD_MIN_UPPER: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer, default=0)
    • \n
  • LOCAL_PASSWORD_MIN_SPECIAL: Minimum number of special characters required in a local password. 0 means no minimum (integer, default=0)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_settings_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/SettingSingleton" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/SettingSingleton" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each system job template data structure includes the following fields:

\n
    \n
  • id: Database ID for this system job template. (integer)
    • \n
  • type: Data type for this system job template. (choice)
    • \n
  • url: URL for this system job template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this system job template was created. (datetime)
    • \n
  • modified: Timestamp when this system job template was last modified. (datetime)
    • \n
  • name: Name of this system job template. (string)
    • \n
  • description: Optional description of this system job template. (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    • none: No External Source
      • \n
    • updating: Updating
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • job_type: (choice)
      \n
    • \"\": ---------
      • \n
    • cleanup_jobs: Remove jobs older than a certain number of days
      • \n
    • cleanup_activitystream: Remove activity stream entries older than a certain number of days
      • \n
    • cleanup_sessions: Removes expired browser sessions from the database
      • \n
    • cleanup_tokens: Removes expired OAuth 2 access tokens and refresh tokens
      • \n
    \n
    • \n
\n

Sorting

\n

To specify that system job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_system_job_templates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/SystemJobTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List System Job Templates", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates--get", "x-filename-id":"api-v2-system_job_templates-get" }, "parameters":[ ] }, "/api/v2/system_job_templates/{id}/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single system job template\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this system job template. (integer)
    • \n
  • type: Data type for this system job template. (choice)
    • \n
  • url: URL for this system job template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this system job template was created. (datetime)
    • \n
  • modified: Timestamp when this system job template was last modified. (datetime)
    • \n
  • name: Name of this system job template. (string)
    • \n
  • description: Optional description of this system job template. (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    • none: No External Source
      • \n
    • updating: Updating
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • job_type: (choice)
      \n
    • \"\": ---------
      • \n
    • cleanup_jobs: Remove jobs older than a certain number of days
      • \n
    • cleanup_activitystream: Remove activity stream entries older than a certain number of days
      • \n
    • cleanup_sessions: Removes expired browser sessions from the database
      • \n
    • cleanup_tokens: Removes expired OAuth 2 access tokens and refresh tokens
      • \n
    \n
    • \n
", "operationId":"api_system_job_templates_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/SystemJobTemplate" } } }, "summary":"Retrieve a System Job Template", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates-{id}--get", "x-filename-id":"api-v2-system_job_templates-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/system_job_templates/{id}/jobs/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nsystem jobs associated with the selected\nsystem job template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each system job data structure includes the following fields:

\n
    \n
  • id: Database ID for this system job. (integer)
    • \n
  • type: Data type for this system job. (choice)
    • \n
  • url: URL for this system job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this system job was created. (datetime)
    • \n
  • modified: Timestamp when this system job was last modified. (datetime)
    • \n
  • name: Name of this system job. (string)
    • \n
  • description: Optional description of this system job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • system_job_template: (id)
    • \n
  • job_type: (choice)
      \n
    • \"\": ---------
      • \n
    • cleanup_jobs: Remove jobs older than a certain number of days
      • \n
    • cleanup_activitystream: Remove activity stream entries older than a certain number of days
      • \n
    • cleanup_sessions: Removes expired browser sessions from the database
      • \n
    • cleanup_tokens: Removes expired OAuth 2 access tokens and refresh tokens
      • \n
    \n
    • \n
  • extra_vars: (string)
    • \n
  • result_stdout: (field)
    • \n
\n

Sorting

\n

To specify that system jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_system_job_templates_jobs_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/SystemJobList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List System Jobs for a System Job Template", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates-{id}-jobs--get", "x-filename-id":"api-v2-system_job_templates-id-jobs-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/system_job_templates/{id}/launch/":{ "get":{ "description":"

Make a POST request to this resource to launch the system job template.

\n

Variables 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.

\n

For example on cleanup_jobs and cleanup_activitystream:

\n

{\"extra_vars\": {\"days\": 30}}

\n

Which will act on data older than 30 days.

\n

For 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.

\n

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.

\n
    \n
  • Defaults for cleanup_activitystream: days=90
    • \n
  • Defaults for cleanup_jobs: days=90
    • \n
\n

If successful, the response status code will be 202. If the job cannot be\nlaunched, a 405 status code will be returned.

", "operationId":"api_system_job_templates_launch_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Empty" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource to launch the system job template.

\n

Variables 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.

\n

For example on cleanup_jobs and cleanup_activitystream:

\n

{\"extra_vars\": {\"days\": 30}}

\n

Which will act on data older than 30 days.

\n

For 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.

\n

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.

\n
    \n
  • Defaults for cleanup_activitystream: days=90
    • \n
  • Defaults for cleanup_jobs: days=90
    • \n
\n

If successful, the response status code will be 202. If the job cannot be\nlaunched, a 405 status code will be returned.

", "operationId":"api_system_job_templates_launch_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Empty" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Empty" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_system_job_templates_notification_templates_error_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a System Job Template", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates-{id}-notification_templates_error--get", "x-filename-id":"api-v2-system_job_templates-id-notification_templates_error-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nsystem job template.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a System Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this system job template.

\n

Remove Notification Templates from this System Job Template:

\n

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.

", "operationId":"api_system_job_templates_notification_templates_error_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a System Job Template", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates-{id}-notification_templates_error--post", "x-filename-id":"api-v2-system_job_templates-id-notification_templates_error-post" } }, "/api/v2/system_job_templates/{id}/notification_templates_started/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_system_job_templates_notification_templates_started_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a System Job Template", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates-{id}-notification_templates_started--get", "x-filename-id":"api-v2-system_job_templates-id-notification_templates_started-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nsystem job template.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a System Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this system job template.

\n

Remove Notification Templates from this System Job Template:

\n

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.

", "operationId":"api_system_job_templates_notification_templates_started_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a System Job Template", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates-{id}-notification_templates_started--post", "x-filename-id":"api-v2-system_job_templates-id-notification_templates_started-post" } }, "/api/v2/system_job_templates/{id}/notification_templates_success/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_system_job_templates_notification_templates_success_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a System Job Template", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates-{id}-notification_templates_success--get", "x-filename-id":"api-v2-system_job_templates-id-notification_templates_success-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nsystem job template.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a System Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this system job template.

\n

Remove Notification Templates from this System Job Template:

\n

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.

", "operationId":"api_system_job_templates_notification_templates_success_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a System Job Template", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates-{id}-notification_templates_success--post", "x-filename-id":"api-v2-system_job_templates-id-notification_templates_success-post" } }, "/api/v2/system_job_templates/{id}/schedules/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nsystem job template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each schedule data structure includes the following fields:

\n
    \n
  • rrule: A value representing the schedules iCal recurrence rule. (string)
    • \n
  • id: Database ID for this schedule. (integer)
    • \n
  • type: Data type for this schedule. (choice)
    • \n
  • url: URL for this schedule. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this schedule was created. (datetime)
    • \n
  • modified: Timestamp when this schedule was last modified. (datetime)
    • \n
  • name: Name of this schedule. (string)
    • \n
  • description: Optional description of this schedule. (string)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • unified_job_template: (id)
    • \n
  • enabled: Enables processing of this schedule. (boolean)
    • \n
  • dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)
    • \n
  • dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)
    • \n
  • next_run: The next time that the scheduled action will run. (datetime)
    • \n
  • timezone: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)
    • \n
  • until: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)
    • \n
\n

Sorting

\n

To specify that schedules are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_system_job_templates_schedules_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Schedule" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Schedules for a System Job Template", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates-{id}-schedules--get", "x-filename-id":"api-v2-system_job_templates-id-schedules-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following schedule\nfields to create a new schedule associated with this\nsystem job template.

\n
    \n
  • \n

    rrule: A value representing the schedules iCal recurrence rule. (string, required)

    \n
    • \n
  • \n

    name: Name of this schedule. (string, required)

    \n
    • \n
  • description: Optional description of this schedule. (string, default=\"\")
    • \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • \n

    timeout: (integer, default=None)

    \n
    • \n
  • \n

    enabled: Enables processing of this schedule. (boolean, default=True)

    \n
    • \n
", "operationId":"api_system_job_templates_schedules_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Schedule" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Schedule" } } }, "summary":"Create a Schedule for a System Job Template", "tags":[ "System Job Templates" ], "x-internal-id":"api-v2-system_job_templates-{id}-schedules--post", "x-filename-id":"api-v2-system_job_templates-id-schedules-post" } }, "/api/v2/system_jobs/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nsystem jobs.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each system job data structure includes the following fields:

\n
    \n
  • id: Database ID for this system job. (integer)
    • \n
  • type: Data type for this system job. (choice)
    • \n
  • url: URL for this system job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this system job was created. (datetime)
    • \n
  • modified: Timestamp when this system job was last modified. (datetime)
    • \n
  • name: Name of this system job. (string)
    • \n
  • description: Optional description of this system job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • system_job_template: (id)
    • \n
  • job_type: (choice)
      \n
    • \"\": ---------
      • \n
    • cleanup_jobs: Remove jobs older than a certain number of days
      • \n
    • cleanup_activitystream: Remove activity stream entries older than a certain number of days
      • \n
    • cleanup_sessions: Removes expired browser sessions from the database
      • \n
    • cleanup_tokens: Removes expired OAuth 2 access tokens and refresh tokens
      • \n
    \n
    • \n
  • extra_vars: (string)
    • \n
  • result_stdout: (field)
    • \n
\n

Sorting

\n

To specify that system jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_system_jobs_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/SystemJobList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List System Jobs", "tags":[ "System Jobs" ], "x-internal-id":"api-v2-system_jobs--get", "x-filename-id":"api-v2-system_jobs-get" }, "parameters":[ ] }, "/api/v2/system_jobs/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this system job.

", "operationId":"api_system_jobs_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this system job. (integer)
    • \n
  • type: Data type for this system job. (choice)
    • \n
  • url: URL for this system job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this system job was created. (datetime)
    • \n
  • modified: Timestamp when this system job was last modified. (datetime)
    • \n
  • name: Name of this system job. (string)
    • \n
  • description: Optional description of this system job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_args: (string)
    • \n
  • job_cwd: (string)
    • \n
  • job_env: (json)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • result_traceback: (string)
    • \n
  • event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • system_job_template: (id)
    • \n
  • job_type: (choice)
      \n
    • \"\": ---------
      • \n
    • cleanup_jobs: Remove jobs older than a certain number of days
      • \n
    • cleanup_activitystream: Remove activity stream entries older than a certain number of days
      • \n
    • cleanup_sessions: Removes expired browser sessions from the database
      • \n
    • cleanup_tokens: Removes expired OAuth 2 access tokens and refresh tokens
      • \n
    \n
    • \n
  • extra_vars: (string)
    • \n
  • result_stdout: (field)
    • \n
", "operationId":"api_system_jobs_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/SystemJob" } } }, "summary":"Retrieve a System Job", "tags":[ "System Jobs" ], "x-internal-id":"api-v2-system_jobs-{id}--get", "x-filename-id":"api-v2-system_jobs-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/system_jobs/{id}/cancel/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:

\n
    \n
  • can_cancel: (boolean)
    • \n
", "operationId":"api_system_jobs_cancel_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/SystemJobCancel" } } }, "summary":"Retrieve a System Job", "tags":[ "System Jobs" ], "x-internal-id":"api-v2-system_jobs-{id}-cancel--get", "x-filename-id":"api-v2-system_jobs-id-cancel-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:

\n
    \n
  • can_cancel: (boolean)
    • \n
", "operationId":"api_system_jobs_cancel_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/SystemJobCancel" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/SystemJobCancel" } } }, "summary":"Retrieve a System Job", "tags":[ "System Jobs" ], "x-internal-id":"api-v2-system_jobs-{id}-cancel--post", "x-filename-id":"api-v2-system_jobs-id-cancel-post" } }, "/api/v2/system_jobs/{id}/events/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nsystem job events associated with the selected\nsystem job.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each system job event data structure includes the following fields:

\n
    \n
  • id: Database ID for this system job event. (integer)
    • \n
  • type: Data type for this system job event. (choice)
    • \n
  • url: URL for this system job event. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this system job event was created. (datetime)
    • \n
  • modified: Timestamp when this system job event was last modified. (datetime)
    • \n
  • event: (field)
    • \n
  • counter: (integer)
    • \n
  • event_display: (string)
    • \n
  • event_data: (json)
    • \n
  • failed: (field)
    • \n
  • changed: (field)
    • \n
  • uuid: (string)
    • \n
  • stdout: (string)
    • \n
  • start_line: (integer)
    • \n
  • end_line: (integer)
    • \n
  • verbosity: (integer)
    • \n
  • system_job: (id)
    • \n
\n

Sorting

\n

To specify that system job events are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_system_jobs_events_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/SystemJobEvent" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List System Job Events for a System Job", "tags":[ "System Jobs" ], "x-internal-id":"api-v2-system_jobs-{id}-events--get", "x-filename-id":"api-v2-system_jobs-id-events-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/system_jobs/{id}/notifications/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nsystem job.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification. (integer)
    • \n
  • type: Data type for this notification. (choice)
    • \n
  • url: URL for this notification. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification was created. (datetime)
    • \n
  • modified: Timestamp when this notification was last modified. (datetime)
    • \n
  • notification_template: (id)
    • \n
  • error: (string)
    • \n
  • status: (choice)
      \n
    • pending: Pending
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    \n
    • \n
  • notifications_sent: (integer)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • recipients: (string)
    • \n
  • subject: (string)
    • \n
  • body: Notification body (json)
    • \n
\n

Sorting

\n

To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_system_jobs_notifications_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Notification" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notifications for a System Job", "tags":[ "System Jobs" ], "x-internal-id":"api-v2-system_jobs-{id}-notifications--get", "x-filename-id":"api-v2-system_jobs-id-notifications-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/teams/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nteams.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each team data structure includes the following fields:

\n
    \n
  • id: Database ID for this team. (integer)
    • \n
  • type: Data type for this team. (choice)
    • \n
  • url: URL for this team. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this team was created. (datetime)
    • \n
  • modified: Timestamp when this team was last modified. (datetime)
    • \n
  • name: Name of this team. (string)
    • \n
  • description: Optional description of this team. (string)
    • \n
  • organization: (id)
    • \n
\n

Sorting

\n

To specify that teams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_teams_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Team" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Teams", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams--get", "x-filename-id":"api-v2-teams-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following team\nfields to create a new team:

\n
    \n
  • name: Name of this team. (string, required)
    • \n
  • description: Optional description of this team. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
", "operationId":"api_teams_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Team" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Team" } } }, "summary":"Create a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams--post", "x-filename-id":"api-v2-teams-post" } }, "/api/v2/teams/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this team.

", "operationId":"api_teams_delete", "parameters":[ ], "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:

\n
    \n
  • id: Database ID for this team. (integer)
    • \n
  • type: Data type for this team. (choice)
    • \n
  • url: URL for this team. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this team was created. (datetime)
    • \n
  • modified: Timestamp when this team was last modified. (datetime)
    • \n
  • name: Name of this team. (string)
    • \n
  • description: Optional description of this team. (string)
    • \n
  • organization: (id)
    • \n
", "operationId":"api_teams_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Team" } } }, "summary":"Retrieve a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}--get", "x-filename-id":"api-v2-teams-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\nteam. The following fields may be modified:

\n
    \n
  • name: Name of this team. (string, required)
    • \n
  • description: Optional description of this team. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_teams_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Team" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Team" } } }, "summary":"Update a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}--patch", "x-filename-id":"api-v2-teams-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\nteam. The following fields may be modified:

\n
    \n
  • name: Name of this team. (string, required)
    • \n
  • description: Optional description of this team. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_teams_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Team" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/Team" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_teams_access_list_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ResourceAccessListElement" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}-access_list--get", "x-filename-id":"api-v2-teams-id-access_list-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/teams/{id}/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nteam.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_teams_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}-activity_stream--get", "x-filename-id":"api-v2-teams-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/teams/{id}/credentials/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nteam.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_teams_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/TeamCredentialSerializerCreate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials for a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}-credentials--get", "x-filename-id":"api-v2-teams-id-credentials-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following credential\nfields to create a new credential associated with this\nteam.

\n
    \n
  • name: Name of this credential. (string, required)
    • \n
  • description: Optional description of this credential. (string, default=\"\")
    • \n
  • \n

    credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
", "operationId":"api_teams_credentials_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/TeamCredentialSerializerCreate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/TeamCredentialSerializerCreate" } } }, "summary":"Create a Credential for a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}-credentials--post", "x-filename-id":"api-v2-teams-id-credentials-post" } }, "/api/v2/teams/{id}/object_roles/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nroles associated with the selected\nteam.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_teams_object_roles_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Role" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles for a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}-object_roles--get", "x-filename-id":"api-v2-teams-id-object_roles-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/teams/{id}/projects/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nprojects associated with the selected\nteam.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each project data structure includes the following fields:

\n
    \n
  • id: Database ID for this project. (integer)
    • \n
  • type: Data type for this project. (choice)
    • \n
  • url: URL for this project. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this project was created. (datetime)
    • \n
  • modified: Timestamp when this project was last modified. (datetime)
    • \n
  • name: Name of this project. (string)
    • \n
  • description: Optional description of this project. (string)
    • \n
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)
    • \n
  • scm_type: Specifies the source control system used to store the project. (choice)
      \n
    • \"\": Manual
      • \n
    • git: Git
      • \n
    • svn: Subversion
      • \n
    • insights: Red Hat Insights
      • \n
    • archive: Remote Archive
      • \n
    \n
    • \n
  • scm_url: The location where the project is stored. (string)
    • \n
  • scm_branch: Specific branch, tag or commit to checkout. (string)
    • \n
  • scm_refspec: For git projects, an additional refspec to fetch. (string)
    • \n
  • scm_clean: Discard any local changes before syncing the project. (boolean)
    • \n
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean)
    • \n
  • scm_delete_on_update: Delete the project before syncing. (boolean)
    • \n
  • credential: (id)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • scm_revision: The last revision fetched by a project update (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    \n
    • \n
  • organization: The organization used to determine access to this template. (id)
    • \n
  • scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean)
    • \n
  • 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)
    • \n
  • allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • default_environment: The default execution environment for jobs run using this project. (id)
    • \n
  • signature_validation_credential: An optional credential used for validating files in the project against unexpected changes. (id)
    • \n
  • last_update_failed: (boolean)
    • \n
  • last_updated: (datetime)
    • \n
\n

Sorting

\n

To specify that projects are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_teams_projects_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Project" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Projects for a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}-projects--get", "x-filename-id":"api-v2-teams-id-projects-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/teams/{id}/roles/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of roles associated with the selected team.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_teams_roles_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/RoleSerializerWithParentAccess" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles for a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}-roles--get", "x-filename-id":"api-v2-teams-id-roles-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource to add or remove a role from this team. The following fields may be modified:

\n
    \n
  • id: The Role ID to add to the team. (int, required)
    • \n
  • disassociate: Provide if you want to remove the role. (any value, optional)
    • \n
", "operationId":"api_teams_roles_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/RoleSerializerWithParentAccess" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/RoleSerializerWithParentAccess" } } }, "summary":"Associate Roles With This Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}-roles--post", "x-filename-id":"api-v2-teams-id-roles-post" } }, "/api/v2/teams/{id}/users/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nusers associated with the selected\nteam.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_teams_users_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/User" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users for a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}-users--get", "x-filename-id":"api-v2-teams-id-users-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following user\nfields to create a new user associated with this\nteam.

\n
    \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)
    • \n
  • first_name: (string, default=\"\")
    • \n
  • last_name: (string, default=\"\")
    • \n
  • email: (string, default=\"\")
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)
    • \n
  • is_system_auditor: (boolean, default=False)
    • \n
  • password: Field used to change the password. (string, default=\"\")
    • \n
\n

Add Users for a Team:

\n

Make a POST request to this resource with only an id field to associate an\nexisting user with this team.

\n

Remove Users from this Team:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the user from this team\n without deleting the user.

", "operationId":"api_teams_users_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/User" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/User" } } }, "summary":"Create a User for a Team", "tags":[ "Teams" ], "x-internal-id":"api-v2-teams-{id}-users--post", "x-filename-id":"api-v2-teams-id-users-post" } }, "/api/v2/tokens/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\naccess tokens.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each access token data structure includes the following fields:

\n
    \n
  • id: Database ID for this access token. (integer)
    • \n
  • type: Data type for this access token. (choice)
    • \n
  • url: URL for this access token. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this access token was created. (datetime)
    • \n
  • modified: Timestamp when this access token was last modified. (datetime)
    • \n
  • description: Optional description of this access token. (string)
    • \n
  • user: The user representing the token owner (id)
    • \n
  • token: (string)
    • \n
  • refresh_token: (field)
    • \n
  • application: (id)
    • \n
  • expires: (datetime)
    • \n
  • scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)
    • \n
\n

Sorting

\n

To specify that access tokens are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_tokens_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/OAuth2Token" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Access Tokens", "tags":[ "Tokens" ], "x-internal-id":"api-v2-tokens--get", "x-filename-id":"api-v2-tokens-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following access token\nfields to create a new access token:

\n
    \n
  • \n

    description: Optional description of this access token. (string, default=\"\")

    \n
    • \n
  • \n

    application: (id, default=``)

    \n
    • \n
  • \n

    scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")

    \n
    • \n
", "operationId":"api_tokens_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/OAuth2Token" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/OAuth2Token" } } }, "summary":"Create an Access Token", "tags":[ "Tokens" ], "x-internal-id":"api-v2-tokens--post", "x-filename-id":"api-v2-tokens-post" } }, "/api/v2/tokens/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this access token.

", "operationId":"api_tokens_delete", "parameters":[ ], "responses":{ "204":{ "description":"" } }, "summary":"Delete an Access Token", "tags":[ "Tokens" ], "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:

\n
    \n
  • id: Database ID for this access token. (integer)
    • \n
  • type: Data type for this access token. (choice)
    • \n
  • url: URL for this access token. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this access token was created. (datetime)
    • \n
  • modified: Timestamp when this access token was last modified. (datetime)
    • \n
  • description: Optional description of this access token. (string)
    • \n
  • user: The user representing the token owner (id)
    • \n
  • token: (string)
    • \n
  • refresh_token: (field)
    • \n
  • application: (id)
    • \n
  • expires: (datetime)
    • \n
  • scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)
    • \n
", "operationId":"api_tokens_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/OAuth2TokenDetail" } } }, "summary":"Retrieve an Access Token", "tags":[ "Tokens" ], "x-internal-id":"api-v2-tokens-{id}--get", "x-filename-id":"api-v2-tokens-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\naccess token. The following fields may be modified:

\n
    \n
  • \n

    description: Optional description of this access token. (string, default=\"\")

    \n
    • \n
  • \n

    scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")

    \n
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_tokens_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/OAuth2TokenDetail" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/OAuth2TokenDetail" } } }, "summary":"Update an Access Token", "tags":[ "Tokens" ], "x-internal-id":"api-v2-tokens-{id}--patch", "x-filename-id":"api-v2-tokens-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\naccess token. The following fields may be modified:

\n
    \n
  • \n

    description: Optional description of this access token. (string, default=\"\")

    \n
    • \n
  • \n

    scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")

    \n
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_tokens_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/OAuth2TokenDetail" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/OAuth2TokenDetail" } } }, "summary":"Update an Access Token", "tags":[ "Tokens" ], "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_tokens_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for an Access Token", "tags":[ "Tokens" ], "x-internal-id":"api-v2-tokens-{id}-activity_stream--get", "x-filename-id":"api-v2-tokens-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/unified_job_templates/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nunified job templates.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each unified job template data structure includes the following fields:

\n
    \n
  • id: Database ID for this unified job template. (integer)
    • \n
  • type: Data type for this unified job template. (choice)
    • \n
  • url: URL for this unified job template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this unified job template was created. (datetime)
    • \n
  • modified: Timestamp when this unified job template was last modified. (datetime)
    • \n
  • name: Name of this unified job template. (string)
    • \n
  • description: Optional description of this unified job template. (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    • none: No External Source
      • \n
    • updating: Updating
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
\n

Sorting

\n

To specify that unified job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_unified_job_templates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/UnifiedJobTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Unified Job Templates", "tags":[ "Unified Job Templates" ], "x-internal-id":"api-v2-unified_job_templates--get", "x-filename-id":"api-v2-unified_job_templates-get" }, "parameters":[ ] }, "/api/v2/unified_jobs/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nunified jobs.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each unified job data structure includes the following fields:

\n
    \n
  • id: Database ID for this unified job. (integer)
    • \n
  • type: Data type for this unified job. (choice)
    • \n
  • url: URL for this unified job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this unified job was created. (datetime)
    • \n
  • modified: Timestamp when this unified job was last modified. (datetime)
    • \n
  • name: Name of this unified job. (string)
    • \n
  • description: Optional description of this unified job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • execution_node: The node the job executed on. (string)
    • \n
  • controller_node: The instance that managed the execution environment. (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
\n

Sorting

\n

To specify that unified jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_unified_jobs_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/UnifiedJobList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Unified Jobs", "tags":[ "Unified Jobs" ], "x-internal-id":"api-v2-unified_jobs--get", "x-filename-id":"api-v2-unified_jobs-get" }, "parameters":[ ] }, "/api/v2/users/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nusers.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/User" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users", "tags":[ "Users" ], "x-internal-id":"api-v2-users--get", "x-filename-id":"api-v2-users-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following user\nfields to create a new user:

\n
    \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)
    • \n
  • first_name: (string, default=\"\")
    • \n
  • last_name: (string, default=\"\")
    • \n
  • email: (string, default=\"\")
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)
    • \n
  • is_system_auditor: (boolean, default=False)
    • \n
  • password: Field used to change the password. (string, default=\"\")
    • \n
", "operationId":"api_users_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/User" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/User" } } }, "summary":"Create a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users--post", "x-filename-id":"api-v2-users-post" } }, "/api/v2/users/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this user.

", "operationId":"api_users_delete", "parameters":[ ], "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:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
", "operationId":"api_users_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/User" } } }, "summary":"Retrieve a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}--get", "x-filename-id":"api-v2-users-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\nuser. The following fields may be modified:

\n
    \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)
    • \n
  • first_name: (string, default=\"\")
    • \n
  • last_name: (string, default=\"\")
    • \n
  • email: (string, default=\"\")
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)
    • \n
  • is_system_auditor: (boolean, default=False)
    • \n
  • password: Field used to change the password. (string, default=\"\")
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_users_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/User" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/User" } } }, "summary":"Update a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}--patch", "x-filename-id":"api-v2-users-id-patch" }, "put":{ "description":"

Make a PUT or PATCH request to this resource to update this\nuser. The following fields may be modified:

\n
    \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)
    • \n
  • first_name: (string, default=\"\")
    • \n
  • last_name: (string, default=\"\")
    • \n
  • email: (string, default=\"\")
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)
    • \n
  • is_system_auditor: (boolean, default=False)
    • \n
  • password: Field used to change the password. (string, default=\"\")
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_users_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/User" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/User" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_access_list_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ResourceAccessListElement" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-access_list--get", "x-filename-id":"api-v2-users-id-access_list-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/users/{id}/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nuser.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-activity_stream--get", "x-filename-id":"api-v2-users-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/users/{id}/admin_of_organizations/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\norganizations of which the selected\nuser is an admin.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each organization data structure includes the following fields:

\n
    \n
  • id: Database ID for this organization. (integer)
    • \n
  • type: Data type for this organization. (choice)
    • \n
  • url: URL for this organization. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this organization was created. (datetime)
    • \n
  • modified: Timestamp when this organization was last modified. (datetime)
    • \n
  • name: Name of this organization. (string)
    • \n
  • description: Optional description of this organization. (string)
    • \n
  • max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • default_environment: The default execution environment for jobs run by this organization. (id)
    • \n
\n

Sorting

\n

To specify that organizations are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_admin_of_organizations_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Organization" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Organizations Administered by This User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-admin_of_organizations--get", "x-filename-id":"api-v2-users-id-admin_of_organizations-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/users/{id}/applications/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\napplications.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each application data structure includes the following fields:

\n
    \n
  • id: Database ID for this application. (integer)
    • \n
  • type: Data type for this application. (choice)
    • \n
  • url: URL for this application. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this application was created. (datetime)
    • \n
  • modified: Timestamp when this application was last modified. (datetime)
    • \n
  • name: Name of this application. (string)
    • \n
  • description: Optional description of this application. (string)
    • \n
  • client_id: (string)
    • \n
  • client_secret: Used for more stringent verification of access to an application when creating a token. (string)
    • \n
  • client_type: Set to Public or Confidential depending on how secure the client device is. (choice)
      \n
    • confidential: Confidential
      • \n
    • public: Public
      • \n
    \n
    • \n
  • redirect_uris: Allowed URIs list, space separated (string)
    • \n
  • authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice)
      \n
    • authorization-code: Authorization code
      • \n
    • password: Resource owner password-based
      • \n
    \n
    • \n
  • skip_authorization: Set True to skip authorization step for completely trusted applications. (boolean)
    • \n
  • organization: Organization containing this application. (id)
    • \n
\n

Sorting

\n

To specify that applications are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_applications_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/OAuth2Application" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Applications", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-applications--get", "x-filename-id":"api-v2-users-id-applications-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following application\nfields to create a new application:

\n
    \n
  • name: Name of this application. (string, required)
    • \n
  • \n

    description: Optional description of this application. (string, default=\"\")

    \n
    • \n
  • \n

    client_type: Set to Public or Confidential depending on how secure the client device is. (choice, required)

    \n
      \n
    • confidential: Confidential
      • \n
    • public: Public
      • \n
    \n
    • \n
  • redirect_uris: Allowed URIs list, space separated (string, default=\"\")
    • \n
  • authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice, required)
      \n
    • authorization-code: Authorization code
      • \n
    • password: Resource owner password-based
      • \n
    \n
    • \n
  • skip_authorization: Set True to skip authorization step for completely trusted applications. (boolean, default=False)
    • \n
  • organization: Organization containing this application. (id, required)
    • \n
", "operationId":"api_users_applications_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/OAuth2Application" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/OAuth2Application" } } }, "summary":"Create an Application", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-applications--post", "x-filename-id":"api-v2-users-id-applications-post" } }, "/api/v2/users/{id}/authorized_tokens/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each access token data structure includes the following fields:

\n
    \n
  • id: Database ID for this access token. (integer)
    • \n
  • type: Data type for this access token. (choice)
    • \n
  • url: URL for this access token. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this access token was created. (datetime)
    • \n
  • modified: Timestamp when this access token was last modified. (datetime)
    • \n
  • description: Optional description of this access token. (string)
    • \n
  • user: The user representing the token owner (id)
    • \n
  • token: (string)
    • \n
  • refresh_token: (field)
    • \n
  • application: (id)
    • \n
  • expires: (datetime)
    • \n
  • scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)
    • \n
\n

Sorting

\n

To specify that access tokens are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_authorized_tokens_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/UserAuthorizedToken" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Access Tokens for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-authorized_tokens--get", "x-filename-id":"api-v2-users-id-authorized_tokens-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following access token\nfields to create a new access token associated with this\nuser.

\n
    \n
  • \n

    description: Optional description of this access token. (string, default=\"\")

    \n
    • \n
  • \n

    application: (id, required)

    \n
    • \n
  • \n

    scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")

    \n
    • \n
", "operationId":"api_users_authorized_tokens_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/UserAuthorizedToken" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/UserAuthorizedToken" } } }, "summary":"Create an Access Token for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-authorized_tokens--post", "x-filename-id":"api-v2-users-id-authorized_tokens-post" } }, "/api/v2/users/{id}/credentials/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nuser.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/UserCredentialSerializerCreate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-credentials--get", "x-filename-id":"api-v2-users-id-credentials-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following credential\nfields to create a new credential associated with this\nuser.

\n
    \n
  • name: Name of this credential. (string, required)
    • \n
  • description: Optional description of this credential. (string, default=\"\")
    • \n
  • \n

    credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
", "operationId":"api_users_credentials_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/UserCredentialSerializerCreate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/UserCredentialSerializerCreate" } } }, "summary":"Create a Credential for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-credentials--post", "x-filename-id":"api-v2-users-id-credentials-post" } }, "/api/v2/users/{id}/organizations/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\norganizations associated with the selected\nuser.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each organization data structure includes the following fields:

\n
    \n
  • id: Database ID for this organization. (integer)
    • \n
  • type: Data type for this organization. (choice)
    • \n
  • url: URL for this organization. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this organization was created. (datetime)
    • \n
  • modified: Timestamp when this organization was last modified. (datetime)
    • \n
  • name: Name of this organization. (string)
    • \n
  • description: Optional description of this organization. (string)
    • \n
  • max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • default_environment: The default execution environment for jobs run by this organization. (id)
    • \n
\n

Sorting

\n

To specify that organizations are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_organizations_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Organization" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Organizations for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-organizations--get", "x-filename-id":"api-v2-users-id-organizations-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/users/{id}/personal_tokens/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each access token data structure includes the following fields:

\n
    \n
  • id: Database ID for this access token. (integer)
    • \n
  • type: Data type for this access token. (choice)
    • \n
  • url: URL for this access token. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this access token was created. (datetime)
    • \n
  • modified: Timestamp when this access token was last modified. (datetime)
    • \n
  • description: Optional description of this access token. (string)
    • \n
  • user: The user representing the token owner (id)
    • \n
  • token: (string)
    • \n
  • refresh_token: (field)
    • \n
  • application: (id)
    • \n
  • expires: (datetime)
    • \n
  • scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)
    • \n
\n

Sorting

\n

To specify that access tokens are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_personal_tokens_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/UserPersonalToken" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Access Tokens for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-personal_tokens--get", "x-filename-id":"api-v2-users-id-personal_tokens-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following access token\nfields to create a new access token associated with this\nuser.

\n
    \n
  • \n

    description: Optional description of this access token. (string, default=\"\")

    \n
    • \n
  • \n

    scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")

    \n
    • \n
", "operationId":"api_users_personal_tokens_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/UserPersonalToken" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/UserPersonalToken" } } }, "summary":"Create an Access Token for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-personal_tokens--post", "x-filename-id":"api-v2-users-id-personal_tokens-post" } }, "/api/v2/users/{id}/projects/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nprojects associated with the selected\nuser.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each project data structure includes the following fields:

\n
    \n
  • id: Database ID for this project. (integer)
    • \n
  • type: Data type for this project. (choice)
    • \n
  • url: URL for this project. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this project was created. (datetime)
    • \n
  • modified: Timestamp when this project was last modified. (datetime)
    • \n
  • name: Name of this project. (string)
    • \n
  • description: Optional description of this project. (string)
    • \n
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)
    • \n
  • scm_type: Specifies the source control system used to store the project. (choice)
      \n
    • \"\": Manual
      • \n
    • git: Git
      • \n
    • svn: Subversion
      • \n
    • insights: Red Hat Insights
      • \n
    • archive: Remote Archive
      • \n
    \n
    • \n
  • scm_url: The location where the project is stored. (string)
    • \n
  • scm_branch: Specific branch, tag or commit to checkout. (string)
    • \n
  • scm_refspec: For git projects, an additional refspec to fetch. (string)
    • \n
  • scm_clean: Discard any local changes before syncing the project. (boolean)
    • \n
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean)
    • \n
  • scm_delete_on_update: Delete the project before syncing. (boolean)
    • \n
  • credential: (id)
    • \n
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
    • \n
  • scm_revision: The last revision fetched by a project update (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    \n
    • \n
  • organization: The organization used to determine access to this template. (id)
    • \n
  • scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean)
    • \n
  • 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)
    • \n
  • allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)
    • \n
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
    • \n
  • default_environment: The default execution environment for jobs run using this project. (id)
    • \n
  • signature_validation_credential: An optional credential used for validating files in the project against unexpected changes. (id)
    • \n
  • last_update_failed: (boolean)
    • \n
  • last_updated: (datetime)
    • \n
\n

Sorting

\n

To specify that projects are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_projects_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Project" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Projects for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-projects--get", "x-filename-id":"api-v2-users-id-projects-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/users/{id}/roles/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of roles associated with the selected user.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_roles_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/RoleSerializerWithParentAccess" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-roles--get", "x-filename-id":"api-v2-users-id-roles-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource to add or remove a role from this user. The following fields may be modified:

\n
    \n
  • id: The Role ID to add to the user. (int, required)
    • \n
  • disassociate: Provide if you want to remove the role. (any value, optional)
    • \n
", "operationId":"api_users_roles_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/RoleSerializerWithParentAccess" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/RoleSerializerWithParentAccess" } } }, "summary":"Associate Roles With This User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-roles--post", "x-filename-id":"api-v2-users-id-roles-post" } }, "/api/v2/users/{id}/teams/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nteams associated with the selected\nuser.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each team data structure includes the following fields:

\n
    \n
  • id: Database ID for this team. (integer)
    • \n
  • type: Data type for this team. (choice)
    • \n
  • url: URL for this team. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this team was created. (datetime)
    • \n
  • modified: Timestamp when this team was last modified. (datetime)
    • \n
  • name: Name of this team. (string)
    • \n
  • description: Optional description of this team. (string)
    • \n
  • organization: (id)
    • \n
\n

Sorting

\n

To specify that teams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_teams_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Team" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Teams for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-teams--get", "x-filename-id":"api-v2-users-id-teams-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/users/{id}/tokens/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each access token data structure includes the following fields:

\n
    \n
  • id: Database ID for this access token. (integer)
    • \n
  • type: Data type for this access token. (choice)
    • \n
  • url: URL for this access token. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this access token was created. (datetime)
    • \n
  • modified: Timestamp when this access token was last modified. (datetime)
    • \n
  • description: Optional description of this access token. (string)
    • \n
  • user: The user representing the token owner (id)
    • \n
  • token: (string)
    • \n
  • refresh_token: (field)
    • \n
  • application: (id)
    • \n
  • expires: (datetime)
    • \n
  • scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)
    • \n
\n

Sorting

\n

To specify that access tokens are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_users_tokens_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/OAuth2Token" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Access Tokens for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-tokens--get", "x-filename-id":"api-v2-users-id-tokens-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following access token\nfields to create a new access token associated with this\nuser.

\n
    \n
  • \n

    description: Optional description of this access token. (string, default=\"\")

    \n
    • \n
  • \n

    application: (id, default=``)

    \n
    • \n
  • \n

    scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=\"write\")

    \n
    • \n
", "operationId":"api_users_tokens_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/OAuth2Token" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/OAuth2Token" } } }, "summary":"Create an Access Token for a User", "tags":[ "Users" ], "x-internal-id":"api-v2-users-{id}-tokens--post", "x-filename-id":"api-v2-users-id-tokens-post" } }, "/api/v2/workflow_approval_templates/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this workflow approval template.

", "operationId":"api_workflow_approval_templates_delete", "parameters":[ ], "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:

\n
    \n
  • id: Database ID for this workflow approval template. (integer)
    • \n
  • type: Data type for this workflow approval template. (choice)
    • \n
  • url: URL for this workflow approval template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow approval template was created. (datetime)
    • \n
  • modified: Timestamp when this workflow approval template was last modified. (datetime)
    • \n
  • name: Name of this workflow approval template. (string)
    • \n
  • description: Optional description of this workflow approval template. (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    • none: No External Source
      • \n
    • updating: Updating
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • timeout: The amount of time (in seconds) before the approval node expires and fails. (integer)
    • \n
", "operationId":"api_workflow_approval_templates_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowApprovalTemplate" } } }, "summary":"Retrieve a Workflow Approval Template", "tags":[ "Workflow Approval Templates" ], "x-internal-id":"api-v2-workflow_approval_templates-{id}--get", "x-filename-id":"api-v2-workflow_approval_templates-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\nworkflow approval template. The following fields may be modified:

\n
    \n
  • name: Name of this workflow approval template. (string, required)
    • \n
  • \n

    description: Optional description of this workflow approval template. (string, default=\"\")

    \n
    • \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • timeout: The amount of time (in seconds) before the approval node expires and fails. (integer, default=0)
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_workflow_approval_templates_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowApprovalTemplate" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowApprovalTemplate" } } }, "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":{ "description":"

Make a PUT or PATCH request to this resource to update this\nworkflow approval template. The following fields may be modified:

\n
    \n
  • name: Name of this workflow approval template. (string, required)
    • \n
  • \n

    description: Optional description of this workflow approval template. (string, default=\"\")

    \n
    • \n
  • \n

    execution_environment: The container image to be used for execution. (id, default=``)

    \n
    • \n
  • timeout: The amount of time (in seconds) before the approval node expires and fails. (integer, default=0)
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_workflow_approval_templates_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowApprovalTemplate" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowApprovalTemplate" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow approval data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow approval. (integer)
    • \n
  • type: Data type for this workflow approval. (choice)
    • \n
  • url: URL for this workflow approval. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow approval was created. (datetime)
    • \n
  • modified: Timestamp when this workflow approval was last modified. (datetime)
    • \n
  • name: Name of this workflow approval. (string)
    • \n
  • description: Optional description of this workflow approval. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • can_approve_or_deny: (field)
    • \n
  • approval_expiration: (field)
    • \n
  • timed_out: (boolean)
    • \n
\n

Sorting

\n

To specify that workflow approvals are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_approval_templates_approvals_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowApprovalList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Approvals for a Workflow Approval Template", "tags":[ "Workflow Approval Templates" ], "x-internal-id":"api-v2-workflow_approval_templates-{id}-approvals--get", "x-filename-id":"api-v2-workflow_approval_templates-id-approvals-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_approvals/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nworkflow approvals.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow approval data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow approval. (integer)
    • \n
  • type: Data type for this workflow approval. (choice)
    • \n
  • url: URL for this workflow approval. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow approval was created. (datetime)
    • \n
  • modified: Timestamp when this workflow approval was last modified. (datetime)
    • \n
  • name: Name of this workflow approval. (string)
    • \n
  • description: Optional description of this workflow approval. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • can_approve_or_deny: (field)
    • \n
  • approval_expiration: (field)
    • \n
  • timed_out: (boolean)
    • \n
\n

Sorting

\n

To specify that workflow approvals are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_approvals_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowApprovalList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Approvals", "tags":[ "Workflow Approvals" ], "x-internal-id":"api-v2-workflow_approvals--get", "x-filename-id":"api-v2-workflow_approvals-get" }, "parameters":[ ] }, "/api/v2/workflow_approvals/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this workflow approval.

", "operationId":"api_workflow_approvals_delete", "parameters":[ ], "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:

\n
    \n
  • id: Database ID for this workflow approval. (integer)
    • \n
  • type: Data type for this workflow approval. (choice)
    • \n
  • url: URL for this workflow approval. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow approval was created. (datetime)
    • \n
  • modified: Timestamp when this workflow approval was last modified. (datetime)
    • \n
  • name: Name of this workflow approval. (string)
    • \n
  • description: Optional description of this workflow approval. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_args: (string)
    • \n
  • job_cwd: (string)
    • \n
  • job_env: (json)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • result_traceback: (string)
    • \n
  • event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • can_approve_or_deny: (field)
    • \n
  • approval_expiration: (field)
    • \n
  • timed_out: (boolean)
    • \n
", "operationId":"api_workflow_approvals_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowApproval" } } }, "summary":"Retrieve a Workflow Approval", "tags":[ "Workflow Approvals" ], "x-internal-id":"api-v2-workflow_approvals-{id}--get", "x-filename-id":"api-v2-workflow_approvals-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_approvals/{id}/approve/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:

", "operationId":"api_workflow_approvals_approve_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowApprovalView" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:

", "operationId":"api_workflow_approvals_approve_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowApprovalView" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowApprovalView" } } }, "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":"api_workflow_approvals_deny_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowApprovalView" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:

", "operationId":"api_workflow_approvals_deny_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowApprovalView" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowApprovalView" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job node data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job node. (integer)
    • \n
  • type: Data type for this workflow job node. (choice)
    • \n
  • url: URL for this workflow job node. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job node was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job node was last modified. (datetime)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • job: (id)
    • \n
  • workflow_job: (id)
    • \n
  • unified_job_template: (id)
    • \n
  • success_nodes: (field)
    • \n
  • failure_nodes: (field)
    • \n
  • always_nodes: (field)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)
    • \n
\n

Sorting

\n

To specify that workflow job nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_nodes_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobNodeList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Job Nodes", "tags":[ "Workflow Job Nodes" ], "x-internal-id":"api-v2-workflow_job_nodes--get", "x-filename-id":"api-v2-workflow_job_nodes-get" }, "parameters":[ ] }, "/api/v2/workflow_job_nodes/{id}/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single workflow job node\nrecord containing the following fields:

\n
    \n
  • id: Database ID for this workflow job node. (integer)
    • \n
  • type: Data type for this workflow job node. (choice)
    • \n
  • url: URL for this workflow job node. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job node was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job node was last modified. (datetime)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • job: (id)
    • \n
  • workflow_job: (id)
    • \n
  • unified_job_template: (id)
    • \n
  • success_nodes: (field)
    • \n
  • failure_nodes: (field)
    • \n
  • always_nodes: (field)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)
    • \n
", "operationId":"api_workflow_job_nodes_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobNodeDetail" } } }, "summary":"Retrieve a Workflow Job Node", "tags":[ "Workflow Job Nodes" ], "x-internal-id":"api-v2-workflow_job_nodes-{id}--get", "x-filename-id":"api-v2-workflow_job_nodes-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_job_nodes/{id}/always_nodes/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job node.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job node data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job node. (integer)
    • \n
  • type: Data type for this workflow job node. (choice)
    • \n
  • url: URL for this workflow job node. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job node was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job node was last modified. (datetime)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • job: (id)
    • \n
  • workflow_job: (id)
    • \n
  • unified_job_template: (id)
    • \n
  • success_nodes: (field)
    • \n
  • failure_nodes: (field)
    • \n
  • always_nodes: (field)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)
    • \n
\n

Sorting

\n

To specify that workflow job nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_nodes_always_nodes_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobNodeList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Job Nodes for a Workflow Job Node", "tags":[ "Workflow Job Nodes" ], "x-internal-id":"api-v2-workflow_job_nodes-{id}-always_nodes--get", "x-filename-id":"api-v2-workflow_job_nodes-id-always_nodes-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_job_nodes/{id}/credentials/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nworkflow job node.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • organization: (id)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_nodes_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Credential" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials for a Workflow Job Node", "tags":[ "Workflow Job Nodes" ], "x-internal-id":"api-v2-workflow_job_nodes-{id}-credentials--get", "x-filename-id":"api-v2-workflow_job_nodes-id-credentials-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_job_nodes/{id}/failure_nodes/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job node.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job node data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job node. (integer)
    • \n
  • type: Data type for this workflow job node. (choice)
    • \n
  • url: URL for this workflow job node. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job node was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job node was last modified. (datetime)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • job: (id)
    • \n
  • workflow_job: (id)
    • \n
  • unified_job_template: (id)
    • \n
  • success_nodes: (field)
    • \n
  • failure_nodes: (field)
    • \n
  • always_nodes: (field)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)
    • \n
\n

Sorting

\n

To specify that workflow job nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_nodes_failure_nodes_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobNodeList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Job Nodes for a Workflow Job Node", "tags":[ "Workflow Job Nodes" ], "x-internal-id":"api-v2-workflow_job_nodes-{id}-failure_nodes--get", "x-filename-id":"api-v2-workflow_job_nodes-id-failure_nodes-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_job_nodes/{id}/instance_groups/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nworkflow job node.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each instance group data structure includes the following fields:

\n
    \n
  • id: Database ID for this instance group. (integer)
    • \n
  • type: Data type for this instance group. (choice)
    • \n
  • url: URL for this instance group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • name: Name of this instance group. (string)
    • \n
  • created: Timestamp when this instance group was created. (datetime)
    • \n
  • modified: Timestamp when this instance group was last modified. (datetime)
    • \n
  • capacity: (field)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: (field)
    • \n
  • max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance group (integer)
    • \n
  • instances: (field)
    • \n
  • is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)
    • \n
  • credential: (id)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json)
    • \n
  • pod_spec_override: (string)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
\n

Sorting

\n

To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_nodes_instance_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InstanceGroup" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Instance Groups for a Workflow Job Node", "tags":[ "Workflow Job Nodes" ], "x-internal-id":"api-v2-workflow_job_nodes-{id}-instance_groups--get", "x-filename-id":"api-v2-workflow_job_nodes-id-instance_groups-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following instance group\nfields to create a new instance group associated with this\nworkflow job node.

\n
    \n
  • \n

    name: Name of this instance group. (string, required)

    \n
    • \n
  • \n

    max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)

    \n
    • \n
  • credential: (id, default=``)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)
    • \n
  • pod_spec_override: (string, default=\"\")
    • \n
\n

Add Instance Groups for a Workflow Job Node:

\n

Make a POST request to this resource with only an id field to associate an\nexisting instance group with this workflow job node.

\n

Remove Instance Groups from this Workflow Job Node:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the instance group from this workflow job node\n without deleting the instance group.

", "operationId":"api_workflow_job_nodes_instance_groups_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InstanceGroup" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InstanceGroup" } } }, "summary":"Create an Instance Group for a Workflow Job Node", "tags":[ "Workflow Job Nodes" ], "x-internal-id":"api-v2-workflow_job_nodes-{id}-instance_groups--post", "x-filename-id":"api-v2-workflow_job_nodes-id-instance_groups-post" } }, "/api/v2/workflow_job_nodes/{id}/labels/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job node.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each label data structure includes the following fields:

\n
    \n
  • id: Database ID for this label. (integer)
    • \n
  • type: Data type for this label. (choice)
    • \n
  • url: URL for this label. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this label was created. (datetime)
    • \n
  • modified: Timestamp when this label was last modified. (datetime)
    • \n
  • name: Name of this label. (string)
    • \n
  • organization: Organization this label belongs to. (id)
    • \n
\n

Sorting

\n

To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_nodes_labels_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Label" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Labels for a Workflow Job Node", "tags":[ "Workflow Job Nodes" ], "x-internal-id":"api-v2-workflow_job_nodes-{id}-labels--get", "x-filename-id":"api-v2-workflow_job_nodes-id-labels-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_job_nodes/{id}/success_nodes/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job node.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job node data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job node. (integer)
    • \n
  • type: Data type for this workflow job node. (choice)
    • \n
  • url: URL for this workflow job node. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job node was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job node was last modified. (datetime)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • job: (id)
    • \n
  • workflow_job: (id)
    • \n
  • unified_job_template: (id)
    • \n
  • success_nodes: (field)
    • \n
  • failure_nodes: (field)
    • \n
  • always_nodes: (field)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)
    • \n
\n

Sorting

\n

To specify that workflow job nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_nodes_success_nodes_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobNodeList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Job Nodes for a Workflow Job Node", "tags":[ "Workflow Job Nodes" ], "x-internal-id":"api-v2-workflow_job_nodes-{id}-success_nodes--get", "x-filename-id":"api-v2-workflow_job_nodes-id-success_nodes-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_job_template_nodes/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nworkflow job template nodes.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job template node data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job template node. (integer)
    • \n
  • type: Data type for this workflow job template node. (choice)
    • \n
  • url: URL for this workflow job template node. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job template node was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job template node was last modified. (datetime)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • workflow_job_template: (id)
    • \n
  • unified_job_template: (id)
    • \n
  • success_nodes: (field)
    • \n
  • failure_nodes: (field)
    • \n
  • always_nodes: (field)
    • \n
  • 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)
    • \n
  • identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)
    • \n
\n

Sorting

\n

To specify that workflow job template nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_template_nodes_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobTemplateNode" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Job Template Nodes", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes--get", "x-filename-id":"api-v2-workflow_job_template_nodes-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following workflow job template node\nfields to create a new workflow job template node:

\n
    \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • timeout: (integer, default=None)
    • \n
  • workflow_job_template: (id, required)
    • \n
  • \n

    unified_job_template: (id, default=``)

    \n
    • \n
  • \n

    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)

    \n
    • \n
  • 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\")
    • \n
", "operationId":"api_workflow_job_template_nodes_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNode" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNode" } } }, "summary":"Create a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes--post", "x-filename-id":"api-v2-workflow_job_template_nodes-post" } }, "/api/v2/workflow_job_template_nodes/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this workflow job template node.

", "operationId":"api_workflow_job_template_nodes_delete", "parameters":[ ], "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:

\n
    \n
  • id: Database ID for this workflow job template node. (integer)
    • \n
  • type: Data type for this workflow job template node. (choice)
    • \n
  • url: URL for this workflow job template node. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job template node was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job template node was last modified. (datetime)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • workflow_job_template: (id)
    • \n
  • unified_job_template: (id)
    • \n
  • success_nodes: (field)
    • \n
  • failure_nodes: (field)
    • \n
  • always_nodes: (field)
    • \n
  • 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)
    • \n
  • identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)
    • \n
", "operationId":"api_workflow_job_template_nodes_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNodeDetail" } } }, "summary":"Retrieve a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}--get", "x-filename-id":"api-v2-workflow_job_template_nodes-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\nworkflow job template node. The following fields may be modified:

\n
    \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • timeout: (integer, default=None)
    • \n
  • workflow_job_template: (id, required)
    • \n
  • \n

    unified_job_template: (id, default=``)

    \n
    • \n
  • \n

    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)

    \n
    • \n
  • 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\")
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_workflow_job_template_nodes_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNodeDetail" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNodeDetail" } } }, "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":{ "description":"

Make a PUT or PATCH request to this resource to update this\nworkflow job template node. The following fields may be modified:

\n
    \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • timeout: (integer, default=None)
    • \n
  • workflow_job_template: (id, required)
    • \n
  • \n

    unified_job_template: (id, default=``)

    \n
    • \n
  • \n

    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)

    \n
    • \n
  • 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\")
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_workflow_job_template_nodes_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNodeDetail" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNodeDetail" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job template node data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job template node. (integer)
    • \n
  • type: Data type for this workflow job template node. (choice)
    • \n
  • url: URL for this workflow job template node. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job template node was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job template node was last modified. (datetime)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • workflow_job_template: (id)
    • \n
  • unified_job_template: (id)
    • \n
  • success_nodes: (field)
    • \n
  • failure_nodes: (field)
    • \n
  • always_nodes: (field)
    • \n
  • 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)
    • \n
  • identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)
    • \n
\n

Sorting

\n

To specify that workflow job template nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_template_nodes_always_nodes_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobTemplateNode" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Job Template Nodes for a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-always_nodes--get", "x-filename-id":"api-v2-workflow_job_template_nodes-id-always_nodes-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

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 node.

\n
    \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • timeout: (integer, default=None)
    • \n
  • workflow_job_template: (id, required)
    • \n
  • \n

    unified_job_template: (id, default=``)

    \n
    • \n
  • \n

    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)

    \n
    • \n
  • 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\")
    • \n
\n

Add Workflow Job Template Nodes for a Workflow Job Template Node:

\n

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.

\n

Remove Workflow Job Template Nodes from this Workflow Job Template Node:

\n

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.

", "operationId":"api_workflow_job_template_nodes_always_nodes_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNode" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNode" } } }, "summary":"Create a Workflow Job Template Node for a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-always_nodes--post", "x-filename-id":"api-v2-workflow_job_template_nodes-id-always_nodes-post" } }, "/api/v2/workflow_job_template_nodes/{id}/create_approval_template/":{ "get":{ "description":"

Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:

\n
    \n
  • timeout: The amount of time (in seconds) before the approval node expires and fails. (integer)
    • \n
  • name: Name of this workflow approval template. (string)
    • \n
  • description: Optional description of this workflow approval template. (string)
    • \n
", "operationId":"api_workflow_job_template_nodes_create_approval_template_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNodeCreateApproval" } } }, "summary":"Retrieve a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-create_approval_template--get", "x-filename-id":"api-v2-workflow_job_template_nodes-id-create_approval_template-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:

\n
    \n
  • timeout: The amount of time (in seconds) before the approval node expires and fails. (integer)
    • \n
  • name: Name of this workflow approval template. (string)
    • \n
  • description: Optional description of this workflow approval template. (string)
    • \n
", "operationId":"api_workflow_job_template_nodes_create_approval_template_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNodeCreateApproval" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNodeCreateApproval" } } }, "summary":"Retrieve a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-create_approval_template--post", "x-filename-id":"api-v2-workflow_job_template_nodes-id-create_approval_template-post" } }, "/api/v2/workflow_job_template_nodes/{id}/credentials/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nworkflow job template node.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each credential data structure includes the following fields:

\n
    \n
  • id: Database ID for this credential. (integer)
    • \n
  • type: Data type for this credential. (choice)
    • \n
  • url: URL for this credential. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this credential was created. (datetime)
    • \n
  • modified: Timestamp when this credential was last modified. (datetime)
    • \n
  • name: Name of this credential. (string)
    • \n
  • description: Optional description of this credential. (string)
    • \n
  • organization: (id)
    • \n
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
    • \n
  • managed: (boolean)
    • \n
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
    • \n
  • kind: (field)
    • \n
  • cloud: (field)
    • \n
  • kubernetes: (field)
    • \n
\n

Sorting

\n

To specify that credentials are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_template_nodes_credentials_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Credential" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Credentials for a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-credentials--get", "x-filename-id":"api-v2-workflow_job_template_nodes-id-credentials-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following credential\nfields to create a new credential associated with this\nworkflow job template node.

\n
    \n
  • name: Name of this credential. (string, required)
    • \n
  • description: Optional description of this credential. (string, default=\"\")
    • \n
  • organization: (id, default=None)
    • \n
  • \n

    credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

    \n
    • \n
  • \n

    inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

    \n
    • \n
\n

Add Credentials for a Workflow Job Template Node:

\n

Make a POST request to this resource with only an id field to associate an\nexisting credential with this workflow job template node.

\n

Remove Credentials from this Workflow Job Template Node:

\n

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.

", "operationId":"api_workflow_job_template_nodes_credentials_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Credential" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Credential" } } }, "summary":"Create a Credential for a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-credentials--post", "x-filename-id":"api-v2-workflow_job_template_nodes-id-credentials-post" } }, "/api/v2/workflow_job_template_nodes/{id}/failure_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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job template node data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job template node. (integer)
    • \n
  • type: Data type for this workflow job template node. (choice)
    • \n
  • url: URL for this workflow job template node. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job template node was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job template node was last modified. (datetime)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • workflow_job_template: (id)
    • \n
  • unified_job_template: (id)
    • \n
  • success_nodes: (field)
    • \n
  • failure_nodes: (field)
    • \n
  • always_nodes: (field)
    • \n
  • 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)
    • \n
  • identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)
    • \n
\n

Sorting

\n

To specify that workflow job template nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_template_nodes_failure_nodes_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobTemplateNode" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Job Template Nodes for a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-failure_nodes--get", "x-filename-id":"api-v2-workflow_job_template_nodes-id-failure_nodes-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

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 node.

\n
    \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • timeout: (integer, default=None)
    • \n
  • workflow_job_template: (id, required)
    • \n
  • \n

    unified_job_template: (id, default=``)

    \n
    • \n
  • \n

    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)

    \n
    • \n
  • 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\")
    • \n
\n

Add Workflow Job Template Nodes for a Workflow Job Template Node:

\n

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.

\n

Remove Workflow Job Template Nodes from this Workflow Job Template Node:

\n

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.

", "operationId":"api_workflow_job_template_nodes_failure_nodes_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNode" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNode" } } }, "summary":"Create a Workflow Job Template Node for a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-failure_nodes--post", "x-filename-id":"api-v2-workflow_job_template_nodes-id-failure_nodes-post" } }, "/api/v2/workflow_job_template_nodes/{id}/instance_groups/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nworkflow job template node.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each instance group data structure includes the following fields:

\n
    \n
  • id: Database ID for this instance group. (integer)
    • \n
  • type: Data type for this instance group. (choice)
    • \n
  • url: URL for this instance group. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • name: Name of this instance group. (string)
    • \n
  • created: Timestamp when this instance group was created. (datetime)
    • \n
  • modified: Timestamp when this instance group was last modified. (datetime)
    • \n
  • capacity: (field)
    • \n
  • consumed_capacity: (field)
    • \n
  • percent_capacity_remaining: (field)
    • \n
  • jobs_running: (field)
    • \n
  • max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)
    • \n
  • jobs_total: Count of all jobs that target this instance group (integer)
    • \n
  • instances: (field)
    • \n
  • is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)
    • \n
  • credential: (id)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json)
    • \n
  • pod_spec_override: (string)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
\n

Sorting

\n

To specify that instance groups are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_template_nodes_instance_groups_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/InstanceGroup" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Instance Groups for a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-instance_groups--get", "x-filename-id":"api-v2-workflow_job_template_nodes-id-instance_groups-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following instance group\nfields to create a new instance group associated with this\nworkflow job template node.

\n
    \n
  • \n

    name: Name of this instance group. (string, required)

    \n
    • \n
  • \n

    max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=0)

    \n
    • \n
  • \n

    is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)

    \n
    • \n
  • credential: (id, default=``)
    • \n
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)
    • \n
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)
    • \n
  • pod_spec_override: (string, default=\"\")
    • \n
\n

Add Instance Groups for a Workflow Job Template Node:

\n

Make a POST request to this resource with only an id field to associate an\nexisting instance group with this workflow job template node.

\n

Remove Instance Groups from this Workflow Job Template Node:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the instance group from this workflow job template node\n without deleting the instance group.

", "operationId":"api_workflow_job_template_nodes_instance_groups_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/InstanceGroup" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/InstanceGroup" } } }, "summary":"Create an Instance Group for a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-instance_groups--post", "x-filename-id":"api-v2-workflow_job_template_nodes-id-instance_groups-post" } }, "/api/v2/workflow_job_template_nodes/{id}/labels/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job template node.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each label data structure includes the following fields:

\n
    \n
  • id: Database ID for this label. (integer)
    • \n
  • type: Data type for this label. (choice)
    • \n
  • url: URL for this label. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this label was created. (datetime)
    • \n
  • modified: Timestamp when this label was last modified. (datetime)
    • \n
  • name: Name of this label. (string)
    • \n
  • organization: Organization this label belongs to. (id)
    • \n
\n

Sorting

\n

To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_template_nodes_labels_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Label" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Labels for a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-labels--get", "x-filename-id":"api-v2-workflow_job_template_nodes-id-labels-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following label\nfields to create a new label associated with this\nworkflow job template node.

\n
    \n
  • name: Name of this label. (string, required)
    • \n
  • organization: Organization this label belongs to. (id, required)
    • \n
\n

Add Labels for a Workflow Job Template Node:

\n

Make a POST request to this resource with only an id field to associate an\nexisting label with this workflow job template node.

\n

Remove Labels from this Workflow Job Template Node:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the label from this workflow job template node\n.

", "operationId":"api_workflow_job_template_nodes_labels_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Label" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Label" } } }, "summary":"Create a Label for a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-labels--post", "x-filename-id":"api-v2-workflow_job_template_nodes-id-labels-post" } }, "/api/v2/workflow_job_template_nodes/{id}/success_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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job template node data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job template node. (integer)
    • \n
  • type: Data type for this workflow job template node. (choice)
    • \n
  • url: URL for this workflow job template node. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job template node was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job template node was last modified. (datetime)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • workflow_job_template: (id)
    • \n
  • unified_job_template: (id)
    • \n
  • success_nodes: (field)
    • \n
  • failure_nodes: (field)
    • \n
  • always_nodes: (field)
    • \n
  • 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)
    • \n
  • identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)
    • \n
\n

Sorting

\n

To specify that workflow job template nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_template_nodes_success_nodes_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobTemplateNode" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Job Template Nodes for a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-success_nodes--get", "x-filename-id":"api-v2-workflow_job_template_nodes-id-success_nodes-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

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 node.

\n
    \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • timeout: (integer, default=None)
    • \n
  • workflow_job_template: (id, required)
    • \n
  • \n

    unified_job_template: (id, default=``)

    \n
    • \n
  • \n

    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)

    \n
    • \n
  • 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\")
    • \n
\n

Add Workflow Job Template Nodes for a Workflow Job Template Node:

\n

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.

\n

Remove Workflow Job Template Nodes from this Workflow Job Template Node:

\n

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.

", "operationId":"api_workflow_job_template_nodes_success_nodes_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNode" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNode" } } }, "summary":"Create a Workflow Job Template Node for a Workflow Job Template Node", "tags":[ "Workflow Job Template Nodes" ], "x-internal-id":"api-v2-workflow_job_template_nodes-{id}-success_nodes--post", "x-filename-id":"api-v2-workflow_job_template_nodes-id-success_nodes-post" } }, "/api/v2/workflow_job_templates/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nworkflow job templates.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job template data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job template. (integer)
    • \n
  • type: Data type for this workflow job template. (choice)
    • \n
  • url: URL for this workflow job template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job template was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job template was last modified. (datetime)
    • \n
  • name: Name of this workflow job template. (string)
    • \n
  • description: Optional description of this workflow job template. (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    • none: No External Source
      • \n
    • updating: Updating
      • \n
    \n
    • \n
  • extra_vars: (json)
    • \n
  • organization: The organization used to determine access to this template. (id)
    • \n
  • survey_enabled: (boolean)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • ask_variables_on_launch: (boolean)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • limit: (string)
    • \n
  • scm_branch: (string)
    • \n
  • ask_inventory_on_launch: (boolean)
    • \n
  • ask_scm_branch_on_launch: (boolean)
    • \n
  • ask_limit_on_launch: (boolean)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • ask_labels_on_launch: (boolean)
    • \n
  • ask_skip_tags_on_launch: (boolean)
    • \n
  • ask_tags_on_launch: (boolean)
    • \n
  • skip_tags: (string)
    • \n
  • job_tags: (string)
    • \n
\n

Sorting

\n

To specify that workflow job templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_templates_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Job Templates", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates--get", "x-filename-id":"api-v2-workflow_job_templates-get" }, "parameters":[ ], "post":{ "description":"

Make a POST request to this resource with the following workflow job template\nfields to create a new workflow job template:

\n
    \n
  • name: Name of this workflow job template. (string, required)
    • \n
  • \n

    description: Optional description of this workflow job template. (string, default=\"\")

    \n
    • \n
  • \n

    extra_vars: (json, default=``)

    \n
    • \n
  • organization: The organization used to determine access to this template. (id, default=``)
    • \n
  • survey_enabled: (boolean, default=False)
    • \n
  • allow_simultaneous: (boolean, default=False)
    • \n
  • ask_variables_on_launch: (boolean, default=False)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • limit: (string, default=\"\")
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • ask_inventory_on_launch: (boolean, default=False)
    • \n
  • ask_scm_branch_on_launch: (boolean, default=False)
    • \n
  • ask_limit_on_launch: (boolean, default=False)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)
    • \n
  • ask_labels_on_launch: (boolean, default=False)
    • \n
  • ask_skip_tags_on_launch: (boolean, default=False)
    • \n
  • ask_tags_on_launch: (boolean, default=False)
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • job_tags: (string, default=\"\")
    • \n
", "operationId":"api_workflow_job_templates_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplate" } } }, "summary":"Create a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates--post", "x-filename-id":"api-v2-workflow_job_templates-post" } }, "/api/v2/workflow_job_templates/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this workflow job template.

", "operationId":"api_workflow_job_templates_delete", "parameters":[ ], "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:

\n
    \n
  • id: Database ID for this workflow job template. (integer)
    • \n
  • type: Data type for this workflow job template. (choice)
    • \n
  • url: URL for this workflow job template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job template was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job template was last modified. (datetime)
    • \n
  • name: Name of this workflow job template. (string)
    • \n
  • description: Optional description of this workflow job template. (string)
    • \n
  • last_job_run: (datetime)
    • \n
  • last_job_failed: (boolean)
    • \n
  • next_job_run: (datetime)
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    • never updated: Never Updated
      • \n
    • ok: OK
      • \n
    • missing: Missing
      • \n
    • none: No External Source
      • \n
    • updating: Updating
      • \n
    \n
    • \n
  • extra_vars: (json)
    • \n
  • organization: The organization used to determine access to this template. (id)
    • \n
  • survey_enabled: (boolean)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • ask_variables_on_launch: (boolean)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • limit: (string)
    • \n
  • scm_branch: (string)
    • \n
  • ask_inventory_on_launch: (boolean)
    • \n
  • ask_scm_branch_on_launch: (boolean)
    • \n
  • ask_limit_on_launch: (boolean)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • ask_labels_on_launch: (boolean)
    • \n
  • ask_skip_tags_on_launch: (boolean)
    • \n
  • ask_tags_on_launch: (boolean)
    • \n
  • skip_tags: (string)
    • \n
  • job_tags: (string)
    • \n
", "operationId":"api_workflow_job_templates_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplate" } } }, "summary":"Retrieve a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}--get", "x-filename-id":"api-v2-workflow_job_templates-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "patch":{ "description":"

Make a PUT or PATCH request to this resource to update this\nworkflow job template. The following fields may be modified:

\n
    \n
  • name: Name of this workflow job template. (string, required)
    • \n
  • \n

    description: Optional description of this workflow job template. (string, default=\"\")

    \n
    • \n
  • \n

    extra_vars: (json, default=``)

    \n
    • \n
  • organization: The organization used to determine access to this template. (id, default=``)
    • \n
  • survey_enabled: (boolean, default=False)
    • \n
  • allow_simultaneous: (boolean, default=False)
    • \n
  • ask_variables_on_launch: (boolean, default=False)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • limit: (string, default=\"\")
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • ask_inventory_on_launch: (boolean, default=False)
    • \n
  • ask_scm_branch_on_launch: (boolean, default=False)
    • \n
  • ask_limit_on_launch: (boolean, default=False)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)
    • \n
  • ask_labels_on_launch: (boolean, default=False)
    • \n
  • ask_skip_tags_on_launch: (boolean, default=False)
    • \n
  • ask_tags_on_launch: (boolean, default=False)
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • job_tags: (string, default=\"\")
    • \n
\n

For a PATCH request, include only the fields that are being modified.

", "operationId":"api_workflow_job_templates_partial_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobTemplate" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplate" } } }, "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":{ "description":"

Make a PUT or PATCH request to this resource to update this\nworkflow job template. The following fields may be modified:

\n
    \n
  • name: Name of this workflow job template. (string, required)
    • \n
  • \n

    description: Optional description of this workflow job template. (string, default=\"\")

    \n
    • \n
  • \n

    extra_vars: (json, default=``)

    \n
    • \n
  • organization: The organization used to determine access to this template. (id, default=``)
    • \n
  • survey_enabled: (boolean, default=False)
    • \n
  • allow_simultaneous: (boolean, default=False)
    • \n
  • ask_variables_on_launch: (boolean, default=False)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • limit: (string, default=\"\")
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • ask_inventory_on_launch: (boolean, default=False)
    • \n
  • ask_scm_branch_on_launch: (boolean, default=False)
    • \n
  • ask_limit_on_launch: (boolean, default=False)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)
    • \n
  • ask_labels_on_launch: (boolean, default=False)
    • \n
  • ask_skip_tags_on_launch: (boolean, default=False)
    • \n
  • ask_tags_on_launch: (boolean, default=False)
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • job_tags: (string, default=\"\")
    • \n
\n

For a PUT request, include all fields in the request.

", "operationId":"api_workflow_job_templates_update", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobTemplate" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplate" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each user data structure includes the following fields:

\n
    \n
  • id: Database ID for this user. (integer)
    • \n
  • type: Data type for this user. (choice)
    • \n
  • url: URL for this user. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this user was created. (datetime)
    • \n
  • modified: Timestamp when this user was last modified. (datetime)
    • \n
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
    • \n
  • first_name: (string)
    • \n
  • last_name: (string)
    • \n
  • email: (string)
    • \n
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
    • \n
  • is_system_auditor: (boolean)
    • \n
  • password: Field used to change the password. (string)
    • \n
  • ldap_dn: (string)
    • \n
  • last_login: (datetime)
    • \n
  • external_account: Set if the account is managed by an external service (field)
    • \n
\n

Sorting

\n

To specify that users are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=username\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-username\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=username,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_templates_access_list_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ResourceAccessListElement" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Users", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-access_list--get", "x-filename-id":"api-v2-workflow_job_templates-id-access_list-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_job_templates/{id}/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nworkflow job template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_templates_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-activity_stream--get", "x-filename-id":"api-v2-workflow_job_templates-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_job_templates/{id}/bitbucket_dc/":{ "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_workflow_job_templates_bitbucket_dc_create", "parameters":[ ], "responses":{ "201":{ "description":"" } }, "tags":[ "Workflow Job Templates" ], "summary":"Workflow Job Templates Bitbucket Dc Create", "x-internal-id":"api-v2-workflow_job_templates-{id}-bitbucket_dc--post", "x-filename-id":"api-v2-workflow_job_templates-id-bitbucket_dc-post" } }, "/api/v2/workflow_job_templates/{id}/copy/":{ "get":{ "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:

\n
    \n
  • can_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)
    • \n
  • can_copy_without_user_input: Flag indicating if the user should be\n prompted for confirmation before the copy is executed (boolean, read-only)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • 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)
    • \n
\n

Make a POST request to this endpoint to save a copy of this\nworkflow job template. No POST data is accepted for this action.

\n

If 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.

\n

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":"api_workflow_job_templates_copy_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Copy" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "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:

\n
    \n
  • can_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)
    • \n
  • can_copy_without_user_input: Flag indicating if the user should be\n prompted for confirmation before the copy is executed (boolean, read-only)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • 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)
    • \n
\n

Make a POST request to this endpoint to save a copy of this\nworkflow job template. No POST data is accepted for this action.

\n

If 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.

\n

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":"api_workflow_job_templates_copy_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Copy" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Copy" } } }, "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/":{ "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_workflow_job_templates_github_create", "parameters":[ ], "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/":{ "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_workflow_job_templates_gitlab_create", "parameters":[ ], "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each label data structure includes the following fields:

\n
    \n
  • id: Database ID for this label. (integer)
    • \n
  • type: Data type for this label. (choice)
    • \n
  • url: URL for this label. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this label was created. (datetime)
    • \n
  • modified: Timestamp when this label was last modified. (datetime)
    • \n
  • name: Name of this label. (string)
    • \n
  • organization: Organization this label belongs to. (id)
    • \n
\n

Sorting

\n

To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_templates_labels_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Label" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Labels for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-labels--get", "x-filename-id":"api-v2-workflow_job_templates-id-labels-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following label\nfields to create a new label associated with this\nworkflow job template.

\n
    \n
  • name: Name of this label. (string, required)
    • \n
  • organization: Organization this label belongs to. (id, required)
    • \n
\n

Add Labels for a Workflow Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting label with this workflow job template.

\n

Remove Labels from this Workflow Job Template:

\n

Make a POST request to this resource with id and disassociate fields to\nremove the label from this workflow job template\n.

\n

Labels not associated with any other resources are deleted. A label can become disassociated with a resource as a result of 3 events.

\n
    \n
  1. A label is explicitly disassociated with a related job template
    2. \n
  2. A job is deleted with labels
    3. \n
  3. A cleanup job deletes a job with labels
    4. \n
", "operationId":"api_workflow_job_templates_labels_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Label" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Label" } } }, "summary":"Create a Label for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-labels--post", "x-filename-id":"api-v2-workflow_job_templates-id-labels-post" } }, "/api/v2/workflow_job_templates/{id}/launch/":{ "get":{ "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:

\n
    \n
  • can_start_without_user_input: Flag indicating if the workflow_job_template\n can be launched without user-input (boolean, read-only)
    • \n
  • variables_needed_to_start: Required variable names required to launch the\n workflow_job_template (array, read-only)
    • \n
  • survey_enabled: Flag indicating whether the workflow_job_template has an\n enabled survey (boolean, read-only)
    • \n
  • extra_vars: Text which is the extra_vars field of this workflow_job_template\n (text, read-only)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • workflow_job_template_data: JSON object listing general information of\n this workflow_job_template (JSON object, read-only)
    • \n
\n

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.

\n

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 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":"api_workflow_job_templates_launch_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobLaunch" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "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:

\n
    \n
  • can_start_without_user_input: Flag indicating if the workflow_job_template\n can be launched without user-input (boolean, read-only)
    • \n
  • variables_needed_to_start: Required variable names required to launch the\n workflow_job_template (array, read-only)
    • \n
  • survey_enabled: Flag indicating whether the workflow_job_template has an\n enabled survey (boolean, read-only)
    • \n
  • extra_vars: Text which is the extra_vars field of this workflow_job_template\n (text, read-only)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • workflow_job_template_data: JSON object listing general information of\n this workflow_job_template (JSON object, read-only)
    • \n
\n

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.

\n

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 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":"api_workflow_job_templates_launch_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobLaunch" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobLaunch" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_templates_notification_templates_approvals_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-notification_templates_approvals--get", "x-filename-id":"api-v2-workflow_job_templates-id-notification_templates_approvals-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nworkflow job template.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a Workflow Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this workflow job template.

\n

Remove Notification Templates from this Workflow Job Template:

\n

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.

", "operationId":"api_workflow_job_templates_notification_templates_approvals_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-notification_templates_approvals--post", "x-filename-id":"api-v2-workflow_job_templates-id-notification_templates_approvals-post" } }, "/api/v2/workflow_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\nworkflow job template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_templates_notification_templates_error_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-notification_templates_error--get", "x-filename-id":"api-v2-workflow_job_templates-id-notification_templates_error-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nworkflow job template.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a Workflow Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this workflow job template.

\n

Remove Notification Templates from this Workflow Job Template:

\n

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.

", "operationId":"api_workflow_job_templates_notification_templates_error_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-notification_templates_error--post", "x-filename-id":"api-v2-workflow_job_templates-id-notification_templates_error-post" } }, "/api/v2/workflow_job_templates/{id}/notification_templates_started/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_templates_notification_templates_started_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-notification_templates_started--get", "x-filename-id":"api-v2-workflow_job_templates-id-notification_templates_started-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nworkflow job template.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a Workflow Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this workflow job template.

\n

Remove Notification Templates from this Workflow Job Template:

\n

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.

", "operationId":"api_workflow_job_templates_notification_templates_started_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-notification_templates_started--post", "x-filename-id":"api-v2-workflow_job_templates-id-notification_templates_started-post" } }, "/api/v2/workflow_job_templates/{id}/notification_templates_success/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification template data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification template. (integer)
    • \n
  • type: Data type for this notification template. (choice)
    • \n
  • url: URL for this notification template. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification template was created. (datetime)
    • \n
  • modified: Timestamp when this notification template was last modified. (datetime)
    • \n
  • name: Name of this notification template. (string)
    • \n
  • description: Optional description of this notification template. (string)
    • \n
  • organization: (id)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json)
    • \n
  • messages: Optional custom messages for notification template. (json)
    • \n
\n

Sorting

\n

To specify that notification templates are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_templates_notification_templates_success_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/NotificationTemplate" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notification Templates for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-notification_templates_success--get", "x-filename-id":"api-v2-workflow_job_templates-id-notification_templates_success-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following notification template\nfields to create a new notification template associated with this\nworkflow job template.

\n
    \n
  • name: Name of this notification template. (string, required)
    • \n
  • description: Optional description of this notification template. (string, default=\"\")
    • \n
  • organization: (id, required)
    • \n
  • notification_type: (choice, required)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • notification_configuration: (json, default={})
    • \n
  • messages: Optional custom messages for notification template. (json, default={&#x27;started&#x27;: None, &#x27;success&#x27;: None, &#x27;error&#x27;: None, &#x27;workflow_approval&#x27;: None})
    • \n
\n

Add Notification Templates for a Workflow Job Template:

\n

Make a POST request to this resource with only an id field to associate an\nexisting notification template with this workflow job template.

\n

Remove Notification Templates from this Workflow Job Template:

\n

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.

", "operationId":"api_workflow_job_templates_notification_templates_success_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/NotificationTemplate" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/NotificationTemplate" } } }, "summary":"Create a Notification Template for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-notification_templates_success--post", "x-filename-id":"api-v2-workflow_job_templates-id-notification_templates_success-post" } }, "/api/v2/workflow_job_templates/{id}/object_roles/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nroles associated with the selected\nworkflow job template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each role data structure includes the following fields:

\n
    \n
  • id: Database ID for this role. (integer)
    • \n
  • type: Data type for this role. (choice)
    • \n
  • url: URL for this role. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • name: Name of this role. (field)
    • \n
  • description: Optional description of this role. (field)
    • \n
\n

Sorting

\n

To specify that roles are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_templates_object_roles_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Role" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Roles for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-object_roles--get", "x-filename-id":"api-v2-workflow_job_templates-id-object_roles-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_job_templates/{id}/schedules/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nworkflow job template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each schedule data structure includes the following fields:

\n
    \n
  • rrule: A value representing the schedules iCal recurrence rule. (string)
    • \n
  • id: Database ID for this schedule. (integer)
    • \n
  • type: Data type for this schedule. (choice)
    • \n
  • url: URL for this schedule. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this schedule was created. (datetime)
    • \n
  • modified: Timestamp when this schedule was last modified. (datetime)
    • \n
  • name: Name of this schedule. (string)
    • \n
  • description: Optional description of this schedule. (string)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • unified_job_template: (id)
    • \n
  • enabled: Enables processing of this schedule. (boolean)
    • \n
  • dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)
    • \n
  • dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)
    • \n
  • next_run: The next time that the scheduled action will run. (datetime)
    • \n
  • timezone: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)
    • \n
  • until: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)
    • \n
\n

Sorting

\n

To specify that schedules are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_templates_schedules_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Schedule" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Schedules for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-schedules--get", "x-filename-id":"api-v2-workflow_job_templates-id-schedules-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Make a POST request to this resource with the following schedule\nfields to create a new schedule associated with this\nworkflow job template.

\n
    \n
  • \n

    rrule: A value representing the schedules iCal recurrence rule. (string, required)

    \n
    • \n
  • \n

    name: Name of this schedule. (string, required)

    \n
    • \n
  • description: Optional description of this schedule. (string, default=\"\")
    • \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • \n

    timeout: (integer, default=None)

    \n
    • \n
  • \n

    enabled: Enables processing of this schedule. (boolean, default=True)

    \n
    • \n
", "operationId":"api_workflow_job_templates_schedules_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Schedule" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Schedule" } } }, "summary":"Create a Schedule for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-schedules--post", "x-filename-id":"api-v2-workflow_job_templates-id-schedules-post" } }, "/api/v2/workflow_job_templates/{id}/survey_spec/":{ "delete":{ "description":"

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}\n
\n

name and description are required elements at the beginning of the survey specification. spec must be a\nlist of survey items.

\n

Within each survey item type must be one of:

\n
    \n
  • text: For survey questions expecting a textual answer
    • \n
  • password: For survey questions expecting a password or other sensitive information
    • \n
  • integer: For survey questions expecting a whole number answer
    • \n
  • float: For survey questions expecting a decimal number
    • \n
  • multiplechoice: For survey questions where one option from a list is required
    • \n
  • multiselect: For survey questions where multiple items from a presented list can be selected
    • \n
\n

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.

\n

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}\n
", "operationId":"api_workflow_job_templates_survey_spec_delete", "parameters":[ ], "responses":{ "204":{ "description":"" } }, "summary":"POST Requests to This Resource Should Include the Full Specification for a Workflow Job Template's Survey", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-survey_spec--delete", "x-filename-id":"api-v2-workflow_job_templates-id-survey_spec-delete" }, "get":{ "description":"

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}\n
\n

name and description are required elements at the beginning of the survey specification. spec must be a\nlist of survey items.

\n

Within each survey item type must be one of:

\n
    \n
  • text: For survey questions expecting a textual answer
    • \n
  • password: For survey questions expecting a password or other sensitive information
    • \n
  • integer: For survey questions expecting a whole number answer
    • \n
  • float: For survey questions expecting a decimal number
    • \n
  • multiplechoice: For survey questions where one option from a list is required
    • \n
  • multiselect: For survey questions where multiple items from a presented list can be selected
    • \n
\n

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.

\n

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}\n
", "operationId":"api_workflow_job_templates_survey_spec_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Empty" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"POST Requests to This Resource Should Include the Full Specification for a Workflow Job Template's Survey", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-survey_spec--get", "x-filename-id":"api-v2-workflow_job_templates-id-survey_spec-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

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}\n
\n

name and description are required elements at the beginning of the survey specification. spec must be a\nlist of survey items.

\n

Within each survey item type must be one of:

\n
    \n
  • text: For survey questions expecting a textual answer
    • \n
  • password: For survey questions expecting a password or other sensitive information
    • \n
  • integer: For survey questions expecting a whole number answer
    • \n
  • float: For survey questions expecting a decimal number
    • \n
  • multiplechoice: For survey questions where one option from a list is required
    • \n
  • multiselect: For survey questions where multiple items from a presented list can be selected
    • \n
\n

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.

\n

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}\n
", "operationId":"api_workflow_job_templates_survey_spec_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Empty" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Empty" } } }, "summary":"POST Requests to This Resource Should Include the Full Specification for a Workflow Job Template's Survey", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-survey_spec--post", "x-filename-id":"api-v2-workflow_job_templates-id-survey_spec-post" } }, "/api/v2/workflow_job_templates/{id}/webhook_key/":{ "get":{ "description":"", "operationId":"api_workflow_job_templates_webhook_key_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Empty" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "tags":[ "Workflow Job Templates" ], "summary":"Workflow Job Templates Webhook Key List", "x-internal-id":"api-v2-workflow_job_templates-{id}-webhook_key--get", "x-filename-id":"api-v2-workflow_job_templates-id-webhook_key-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"", "operationId":"api_workflow_job_templates_webhook_key_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Empty" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Empty" } } }, "tags":[ "Workflow Job Templates" ], "summary":"Workflow Job Templates Webhook Key Create", "x-internal-id":"api-v2-workflow_job_templates-{id}-webhook_key--post", "x-filename-id":"api-v2-workflow_job_templates-id-webhook_key-post" } }, "/api/v2/workflow_job_templates/{id}/workflow_jobs/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nworkflow jobs associated with the selected\nworkflow job template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job. (integer)
    • \n
  • type: Data type for this workflow job. (choice)
    • \n
  • url: URL for this workflow job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job was last modified. (datetime)
    • \n
  • name: Name of this workflow job. (string)
    • \n
  • description: Optional description of this workflow job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • workflow_job_template: (id)
    • \n
  • extra_vars: (json)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • job_template: If automatically created for a sliced job run, the job template the workflow job was created from. (id)
    • \n
  • is_sliced_job: (boolean)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • limit: (string)
    • \n
  • scm_branch: (string)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • webhook_guid: Unique identifier of the event that triggered this webhook (string)
    • \n
  • skip_tags: (string)
    • \n
  • job_tags: (string)
    • \n
\n

Sorting

\n

To specify that workflow jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_templates_workflow_jobs_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Jobs for a Workflow Job Template", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-workflow_jobs--get", "x-filename-id":"api-v2-workflow_job_templates-id-workflow_jobs-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_job_templates/{id}/workflow_nodes/":{ "get":{ "description":"

Workflow 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:

\n
    \n
  • run nodes contained in \"failure_nodes\" or \"always_nodes\" if job failed
    • \n
  • run nodes contained in \"success_nodes\" or \"always_nodes\" if job succeeded
    • \n
\n

The 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.

\n

List Workflow Job Template Nodes for a Workflow Job Template:

\n

Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job template node data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job template node. (integer)
    • \n
  • type: Data type for this workflow job template node. (choice)
    • \n
  • url: URL for this workflow job template node. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job template node was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job template node was last modified. (datetime)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • workflow_job_template: (id)
    • \n
  • unified_job_template: (id)
    • \n
  • success_nodes: (field)
    • \n
  • failure_nodes: (field)
    • \n
  • always_nodes: (field)
    • \n
  • 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)
    • \n
  • identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)
    • \n
\n

Sorting

\n

To specify that workflow job template nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_job_templates_workflow_nodes_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobTemplateNode" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"Workflow Job Template Workflow Node List", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-workflow_nodes--get", "x-filename-id":"api-v2-workflow_job_templates-id-workflow_nodes-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "post":{ "description":"

Workflow 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:

\n
    \n
  • run nodes contained in \"failure_nodes\" or \"always_nodes\" if job failed
    • \n
  • run nodes contained in \"success_nodes\" or \"always_nodes\" if job succeeded
    • \n
\n

The 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.

\n

Create a Workflow Job Template Node for a Workflow Job Template:

\n

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.

\n
    \n
  • extra_data: (json, default={})
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
    • \n
  • scm_branch: (string, default=\"\")
    • \n
  • job_type: (choice)
      \n
    • None: --------- (default)
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string, default=\"\")
    • \n
  • skip_tags: (string, default=\"\")
    • \n
  • limit: (string, default=\"\")
    • \n
  • diff_mode: (boolean, default=None)
    • \n
  • verbosity: (choice)
      \n
    • None: --------- (default)
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id, default=``)
    • \n
  • forks: (integer, default=None)
    • \n
  • job_slice_count: (integer, default=None)
    • \n
  • \n

    timeout: (integer, default=None)

    \n
    • \n
  • \n

    unified_job_template: (id, default=``)

    \n
    • \n
  • \n

    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)

    \n
    • \n
  • 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\")
    • \n
", "operationId":"api_workflow_job_templates_workflow_nodes_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNode" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobTemplateNode" } } }, "summary":"Workflow Job Template Workflow Node List", "tags":[ "Workflow Job Templates" ], "x-internal-id":"api-v2-workflow_job_templates-{id}-workflow_nodes--post", "x-filename-id":"api-v2-workflow_job_templates-id-workflow_nodes-post" } }, "/api/v2/workflow_jobs/":{ "get":{ "description":"

Make a GET request to this resource to retrieve the list of\nworkflow jobs.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job. (integer)
    • \n
  • type: Data type for this workflow job. (choice)
    • \n
  • url: URL for this workflow job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job was last modified. (datetime)
    • \n
  • name: Name of this workflow job. (string)
    • \n
  • description: Optional description of this workflow job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • workflow_job_template: (id)
    • \n
  • extra_vars: (json)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • job_template: If automatically created for a sliced job run, the job template the workflow job was created from. (id)
    • \n
  • is_sliced_job: (boolean)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • limit: (string)
    • \n
  • scm_branch: (string)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • webhook_guid: Unique identifier of the event that triggered this webhook (string)
    • \n
  • skip_tags: (string)
    • \n
  • job_tags: (string)
    • \n
\n

Sorting

\n

To specify that workflow jobs are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_jobs_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Jobs", "tags":[ "Workflow Jobs" ], "x-internal-id":"api-v2-workflow_jobs--get", "x-filename-id":"api-v2-workflow_jobs-get" }, "parameters":[ ] }, "/api/v2/workflow_jobs/{id}/":{ "delete":{ "description":"

Make a DELETE request to this resource to delete this workflow job.

", "operationId":"api_workflow_jobs_delete", "parameters":[ ], "responses":{ "204":{ "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:

\n
    \n
  • id: Database ID for this workflow job. (integer)
    • \n
  • type: Data type for this workflow job. (choice)
    • \n
  • url: URL for this workflow job. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job was last modified. (datetime)
    • \n
  • name: Name of this workflow job. (string)
    • \n
  • description: Optional description of this workflow job. (string)
    • \n
  • unified_job_template: (id)
    • \n
  • launch_type: (choice)
      \n
    • manual: Manual
      • \n
    • relaunch: Relaunch
      • \n
    • callback: Callback
      • \n
    • scheduled: Scheduled
      • \n
    • dependency: Dependency
      • \n
    • workflow: Workflow
      • \n
    • webhook: Webhook
      • \n
    • sync: Sync
      • \n
    • scm: SCM Update
      • \n
    \n
    • \n
  • status: (choice)
      \n
    • new: New
      • \n
    • pending: Pending
      • \n
    • waiting: Waiting
      • \n
    • running: Running
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    • error: Error
      • \n
    • canceled: Canceled
      • \n
    \n
    • \n
  • failed: (boolean)
    • \n
  • started: The date and time the job was queued for starting. (datetime)
    • \n
  • finished: The date and time the job finished execution. (datetime)
    • \n
  • canceled_on: The date and time when the cancel request was sent. (datetime)
    • \n
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
    • \n
  • job_args: (string)
    • \n
  • job_cwd: (string)
    • \n
  • job_env: (json)
    • \n
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
    • \n
  • result_traceback: (string)
    • \n
  • launched_by: (field)
    • \n
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
    • \n
  • workflow_job_template: (id)
    • \n
  • extra_vars: (json)
    • \n
  • allow_simultaneous: (boolean)
    • \n
  • job_template: If automatically created for a sliced job run, the job template the workflow job was created from. (id)
    • \n
  • is_sliced_job: (boolean)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • limit: (string)
    • \n
  • scm_branch: (string)
    • \n
  • webhook_service: Service that webhook requests will be accepted from (choice)
      \n
    • \"\": ---------
      • \n
    • github: GitHub
      • \n
    • gitlab: GitLab
      • \n
    • bitbucket_dc: BitBucket DataCenter
      • \n
    \n
    • \n
  • webhook_credential: Personal Access Token for posting back the status to the service API (id)
    • \n
  • webhook_guid: Unique identifier of the event that triggered this webhook (string)
    • \n
  • skip_tags: (string)
    • \n
  • job_tags: (string)
    • \n
", "operationId":"api_workflow_jobs_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJob" } } }, "summary":"Retrieve a Workflow Job", "tags":[ "Workflow Jobs" ], "x-internal-id":"api-v2-workflow_jobs-{id}--get", "x-filename-id":"api-v2-workflow_jobs-id-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_jobs/{id}/activity_stream/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nworkflow job.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each activity stream data structure includes the following fields:

\n
    \n
  • id: Database ID for this activity stream. (integer)
    • \n
  • type: Data type for this activity stream. (choice)
    • \n
  • url: URL for this activity stream. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • timestamp: (datetime)
    • \n
  • operation: The action taken with respect to the given object(s). (choice)
      \n
    • create: Entity Created
      • \n
    • update: Entity Updated
      • \n
    • delete: Entity Deleted
      • \n
    • associate: Entity Associated with another Entity
      • \n
    • disassociate: Entity was Disassociated with another Entity
      • \n
    \n
    • \n
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
    • \n
  • action_node: The cluster node the activity took place on. (string)
    • \n
  • object_type: When present, shows the model on which the role or relationship was defined. (field)
    • \n
\n

Sorting

\n

To specify that activity streams are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_jobs_activity_stream_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/ActivityStream" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Activity Streams for a Workflow Job", "tags":[ "Workflow Jobs" ], "x-internal-id":"api-v2-workflow_jobs-{id}-activity_stream--get", "x-filename-id":"api-v2-workflow_jobs-id-activity_stream-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_jobs/{id}/cancel/":{ "get":{ "description":"

Make a GET request to this resource to determine if the workflow job can be\ncanceled. The response will include the following field:

\n
    \n
  • can_cancel: Indicates whether this workflow job is in a state that can\n be canceled (boolean, read-only)
    • \n
\n

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":"api_workflow_jobs_cancel_read", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobCancel" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "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:

\n
    \n
  • can_cancel: Indicates whether this workflow job is in a state that can\n be canceled (boolean, read-only)
    • \n
\n

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":"api_workflow_jobs_cancel_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/WorkflowJobCancel" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/WorkflowJobCancel" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each label data structure includes the following fields:

\n
    \n
  • id: Database ID for this label. (integer)
    • \n
  • type: Data type for this label. (choice)
    • \n
  • url: URL for this label. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this label was created. (datetime)
    • \n
  • modified: Timestamp when this label was last modified. (datetime)
    • \n
  • name: Name of this label. (string)
    • \n
  • organization: Organization this label belongs to. (id)
    • \n
\n

Sorting

\n

To specify that labels are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_jobs_labels_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Label" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Labels for a Workflow Job", "tags":[ "Workflow Jobs" ], "x-internal-id":"api-v2-workflow_jobs-{id}-labels--get", "x-filename-id":"api-v2-workflow_jobs-id-labels-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_jobs/{id}/notifications/":{ "get":{ "description":"

Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nworkflow job.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each notification data structure includes the following fields:

\n
    \n
  • id: Database ID for this notification. (integer)
    • \n
  • type: Data type for this notification. (choice)
    • \n
  • url: URL for this notification. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this notification was created. (datetime)
    • \n
  • modified: Timestamp when this notification was last modified. (datetime)
    • \n
  • notification_template: (id)
    • \n
  • error: (string)
    • \n
  • status: (choice)
      \n
    • pending: Pending
      • \n
    • successful: Successful
      • \n
    • failed: Failed
      • \n
    \n
    • \n
  • notifications_sent: (integer)
    • \n
  • notification_type: (choice)
      \n
    • email: Email
      • \n
    • grafana: Grafana
      • \n
    • irc: IRC
      • \n
    • mattermost: Mattermost
      • \n
    • pagerduty: Pagerduty
      • \n
    • rocketchat: Rocket.Chat
      • \n
    • slack: Slack
      • \n
    • twilio: Twilio
      • \n
    • webhook: Webhook
      • \n
    \n
    • \n
  • recipients: (string)
    • \n
  • subject: (string)
    • \n
  • body: Notification body (json)
    • \n
\n

Sorting

\n

To specify that notifications are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_jobs_notifications_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Notification" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Notifications for a Workflow Job", "tags":[ "Workflow Jobs" ], "x-internal-id":"api-v2-workflow_jobs-{id}-notifications--get", "x-filename-id":"api-v2-workflow_jobs-id-notifications-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] }, "/api/v2/workflow_jobs/{id}/relaunch/":{ "get":{ "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.

\n

If successful, the response status code will be 201 and serialized data of the new workflow job will be returned.

", "operationId":"api_workflow_jobs_relaunch_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/Empty" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "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" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ], "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.

\n

If successful, the response status code will be 201 and serialized data of the new workflow job will be returned.

", "operationId":"api_workflow_jobs_relaunch_create", "parameters":[ { "in":"body", "name":"data", "required":true, "schema":{ "$ref":"#/definitions/Empty" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/Empty" } } }, "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.

\n

The resulting data structure contains:

\n
{\n    \"count\": 99,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        ...\n    ]\n}\n
\n

The 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.

\n

Results

\n

Each workflow job node data structure includes the following fields:

\n
    \n
  • id: Database ID for this workflow job node. (integer)
    • \n
  • type: Data type for this workflow job node. (choice)
    • \n
  • url: URL for this workflow job node. (string)
    • \n
  • related: Data structure with URLs of related resources. (object)
    • \n
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
    • \n
  • created: Timestamp when this workflow job node was created. (datetime)
    • \n
  • modified: Timestamp when this workflow job node was last modified. (datetime)
    • \n
  • extra_data: (json)
    • \n
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
    • \n
  • scm_branch: (string)
    • \n
  • job_type: (choice)
      \n
    • None: ---------
      • \n
    • \"\": ---------
      • \n
    • run: Run
      • \n
    • check: Check
      • \n
    \n
    • \n
  • job_tags: (string)
    • \n
  • skip_tags: (string)
    • \n
  • limit: (string)
    • \n
  • diff_mode: (boolean)
    • \n
  • verbosity: (choice)
      \n
    • None: ---------
      • \n
    • 0: 0 (Normal)
      • \n
    • 1: 1 (Verbose)
      • \n
    • 2: 2 (More Verbose)
      • \n
    • 3: 3 (Debug)
      • \n
    • 4: 4 (Connection Debug)
      • \n
    • 5: 5 (WinRM Debug)
      • \n
    \n
    • \n
  • execution_environment: The container image to be used for execution. (id)
    • \n
  • forks: (integer)
    • \n
  • job_slice_count: (integer)
    • \n
  • timeout: (integer)
    • \n
  • job: (id)
    • \n
  • workflow_job: (id)
    • \n
  • unified_job_template: (id)
    • \n
  • success_nodes: (field)
    • \n
  • failure_nodes: (field)
    • \n
  • always_nodes: (field)
    • \n
  • 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)
    • \n
  • 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)
    • \n
  • identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)
    • \n
\n

Sorting

\n

To specify that workflow job nodes are returned in a particular\norder, use the order_by query string parameter on the GET request.

\n
?order_by=name\n
\n

Prefix the field name with a dash - to sort in reverse:

\n
?order_by=-name\n
\n

Multiple sorting fields may be specified by separating the field names with a\ncomma ,:

\n
?order_by=name,some_other_field\n
\n

Pagination

\n

Use 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.

\n
?page_size=100&page=2\n
\n

The previous and next links returned with the results will set these query\nstring parameters automatically.

\n

Searching

\n

Use the search query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.

\n
?search=findme\n
\n

(Added in Ansible Tower 3.1.0) Search across related fields:

\n
?related__search=findme\n
", "operationId":"api_workflow_jobs_workflow_nodes_list", "parameters":[ { "description":"A search term.", "in":"query", "name":"search", "required":false, "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" } ], "responses":{ "200":{ "description":"", "schema":{ "properties":{ "count":{ "type":"integer" }, "next":{ "format":"uri", "type":"string", "x-nullable":true }, "previous":{ "format":"uri", "type":"string", "x-nullable":true }, "results":{ "items":{ "$ref":"#/definitions/WorkflowJobNodeList" }, "type":"array" } }, "required":[ "count", "results" ], "type":"object" } } }, "summary":"List Workflow Job Nodes for a Workflow Job", "tags":[ "Workflow Jobs" ], "x-internal-id":"api-v2-workflow_jobs-{id}-workflow_nodes--get", "x-filename-id":"api-v2-workflow_jobs-id-workflow_nodes-get" }, "parameters":[ { "in":"path", "name":"id", "required":true, "type":"string" } ] } }, "produces":[ "application/json" ], "schemes":[ "https" ], "security":[ { "Basic":[ ] } ], "securityDefinitions":{ "Basic":{ "type":"basic" } }, "swagger":"2.0", "tags":[ { "name":"API", "description":"The operations from the API category." }, { "name":"Activity Stream", "description":"

REST API endpoints for Activity Stream

" }, { "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":"Analytics", "description":"

REST API endpoints for Analytics

" }, { "name":"Applications", "description":"

REST API endpoints for Applications

" }, { "name":"Auth", "description":"

REST API endpoints for Auth

" }, { "name":"Bulk", "description":"

REST API endpoints for Bulk

" }, { "name":"Config", "description":"

REST API endpoints for Config

" }, { "name":"Constructed Inventories", "description":"

REST API endpoints for Constructed Inventories

" }, { "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":"Dashboard", "description":"

REST API endpoints for Dashboard

" }, { "name":"Dependency Manager", "description":"

REST API endpoints for Dependency Manager

" }, { "name":"Execution Environments", "description":"

REST API endpoints for Execution Environments

" }, { "name":"Groups", "description":"

REST API endpoints for Groups

" }, { "name":"Host Metric Summary Monthly", "description":"

REST API endpoints for Host Metric Summary Monthly

" }, { "name":"Host Metrics", "description":"

REST API endpoints for Host Metrics

" }, { "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":"Me", "description":"

REST API endpoints for Me

" }, { "name":"Mesh Visualizer", "description":"

REST API endpoints for Mesh Visualizer

" }, { "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":"Ping", "description":"

REST API endpoints for Ping

" }, { "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 Job Templates", "description":"

REST API endpoints for System Job Templates

" }, { "name":"System Jobs", "description":"

REST API endpoints for System Jobs

" }, { "name":"Task Manager", "description":"

REST API endpoints for Task Manager

" }, { "name":"Teams", "description":"

REST API endpoints for Teams

" }, { "name":"Tokens", "description":"

REST API endpoints for Tokens

" }, { "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":"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

" }, { "name":"Workflow Manager", "description":"

REST API endpoints for Workflow Manager

" } ] }