---
title: Redhat Ansible Automation Platform
slug: connectors/redhat-ansible-automation-platform
createdAt: 2026-11-16T09:02:45.760Z
---

Red Hat Ansible Automation Platform provides enterprise-grade automation for IT operations, enabling centralized orchestration, configuration management, and workflow automation across diverse environments.

Redhat Ansible Automation Platform is an enterprise-grade solution for automating IT operations, configuration management, and application deployment. This connector enables Swimlane Turbine users to seamlessly launch, monitor, retrieve output from, and manage Ansible jobs and job templates directly within automated workflows. By integrating Ansible Automation Platform with Swimlane Turbine, security and IT teams can orchestrate complex remediation, provisioning, and operational tasks without manual intervention. This empowers organizations to accelerate incident response, enforce consistency, and reduce operational overhead through low-code automation.

### Limitations

- This connector covers automation controller job templates and jobs. Automation Hub, Event-Driven Ansible, workflow job templates, and approvals are not included.
- Get Job Output expects the `json` format so the response can be parsed.

### Supported Versions

- This connector uses Ansible Automation Platform 2.7. Controller calls go through the platform gateway at `/api/controller/v2/`.

### Additional Documents

- Documentation [Browse the REST API](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.7/develop-assembly_controller_api_browsing_api)
- Documentation [OAuth 2 token authentication](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.7/secure-con_controller_api_oauth2_token)

## Configuration

### Prerequisites

To use the Red Hat Ansible Automation Platform connector, ensure you have the following prerequisites:

- HTTP Bearer Token authentication for accessing the automation controller API, requiring:
  - URL: The endpoint address of your Ansible Automation Platform instance.
  - API Token: A valid bearer token generated for API access with appropriate permissions.

## Authentication Methods

- URL: The platform gateway base URL.
- API Token: A gateway access token sent as an Authorization Bearer header.

## Capabilities

This Red Hat Ansible Automation Platform connector provides the following capabilities:

- List Job Templates
- Get Job Template
- Get Launch Options
- Launch Job
- List Jobs
- Get Job Status
- Get Job Output
- Cancel Job

### List Job Templates

- List automation controller job templates [Click Here](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.7/develop-assembly_controller_api_browsing_api).

### Get Job Template

- Retrieve one job template by ID [Click Here](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.7/develop-assembly_controller_api_browsing_api).

### Get Launch Options

- Retrieve the prompts, defaults, and passwords required before a job template can be launched [Click Here](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.7/develop-proc_controller_launch_job_template).

### Launch Job

- Launch a job from a job template. Extra vars, inventory, credentials, limit, tags, branch, verbosity, and job type can be supplied when the template asks for them [Click Here](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.7/develop-proc_controller_launch_job_template).

### List Jobs

- List automation controller jobs. Results can be filtered by name, status, or job template [Click Here](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.7/develop-con_controller_playbook_run_jobs).

### Get Job Status

- Retrieve a job, including its current status [Click Here](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.7/develop-con_controller_playbook_run_jobs).

### Get Job Output

- Retrieve the stdout of a job. Use the `json` format [Click Here](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.7/develop-con_controller_playbook_run_jobs).

### Cancel Job

- Cancel a job that is pending or running [Click Here](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.7/develop-assembly_controller_api_browsing_api).

# Configurations

## Ansible Automation Platform

Gateway bearer token for the automation controller API.

### Configuration Parameters

| **Parameter** | **Description**                                               | **Type** | **Required** |
| ------------- | ------------------------------------------------------------- | -------- | ------------ |
| url           | Gateway base URL. Do not include a path.                      | string   | Required     |
| token         | Gateway access token. Sent as an Authorization Bearer header. | string   | Required     |
| verify\_ssl   | Verify the gateway TLS certificate.                           | boolean  | Optional     |
| http\_proxy   | Proxy to route requests through.                              | string   | Optional     |

# Actions

## Cancel Job

Cancel a running job on the Redhat Ansible Automation Platform by specifying the job ID.

### Endpoint

- **URL:** `api/controller/v2/jobs/{{id}}/cancel/`
- **Method:** `POST`

### Input

| **Argument Name**    | **Type** | **Required** | **Description** |
| -------------------- | -------- | ------------ | --------------- |
| `path_parameters.id` | string   | Required     | Numeric job ID. |

### Input Example

`{"path_parameters":{"id":"12345678-1234-1234-1234-123456789abc"}}`

## Get Job Output

Retrieve the standard output (stdout) of a specified job in JSON format for easy parsing from Redhat Ansible Automation Platform.

### Endpoint

- **URL:** `api/controller/v2/jobs/{{id}}/stdout/`
- **Method:** `GET`

### Input

| **Argument Name**    | **Type** | **Required** | **Description**                                                           |
| -------------------- | -------- | ------------ | ------------------------------------------------------------------------- |
| `path_parameters.id` | string   | Required     | Numeric job ID.                                                           |
| `parameters.format`  | string   | Optional     | Output format. json returns structured stdout that this action can parse. |

### Input Example

`{"path_parameters":{"id":"12345678-1234-1234-1234-123456789abc"},"parameters":{"format":"json"}}`

## Get Job Status

Retrieve detailed information and the current status of a specific job in Redhat Ansible Automation Platform using the job ID.

### Endpoint

- **URL:** `api/controller/v2/jobs/{{id}}/`
- **Method:** `GET`

### Input

| **Argument Name**    | **Type** | **Required** | **Description** |
| -------------------- | -------- | ------------ | --------------- |
| `path_parameters.id` | string   | Required     | Numeric job ID. |

### Input Example

`{"path_parameters":{"id":"12345678-1234-1234-1234-123456789abc"}}`

## Get Job Template

Retrieve details of a specific automation controller job template in Redhat Ansible Automation Platform using the template ID.

### Endpoint

- **URL:** `api/controller/v2/job_templates/{{id}}/`
- **Method:** `GET`

### Input

| **Argument Name**    | **Type** | **Required** | **Description**          |
| -------------------- | -------- | ------------ | ------------------------ |
| `path_parameters.id` | string   | Required     | Numeric job template ID. |

### Input Example

`{"path_parameters":{"id":"12345678-1234-1234-1234-123456789abc"}}`

## Get Launch Options

Retrieve prompts, default values, and required passwords for launching a job template in Redhat Ansible Automation Platform using the specified template ID.

### Endpoint

- **URL:** `api/controller/v2/job_templates/{{id}}/launch/`
- **Method:** `GET`

### Input

| **Argument Name**    | **Type** | **Required** | **Description**          |
| -------------------- | -------- | ------------ | ------------------------ |
| `path_parameters.id` | string   | Required     | Numeric job template ID. |

### Input Example

`{"path_parameters":{"id":"12345678-1234-1234-1234-123456789abc"}}`

## Launch Job

Initiate a job using a specified automation controller job template in Redhat Ansible Automation Platform by providing the required job template ID.

### Endpoint

- **URL:** `api/controller/v2/job_templates/{{id}}/launch/`
- **Method:** `POST`

### Input

| **Argument Name**       | **Type** | **Required** | **Description**                                                             |
| ----------------------- | -------- | ------------ | --------------------------------------------------------------------------- |
| `path_parameters.id`    | string   | Required     | Numeric job template ID.                                                    |
| `extra_vars`            | object   | Optional     | Extra variables passed to the playbook.                                     |
| `inventory`             | integer  | Optional     | Inventory ID to use when the template asks for one at launch.               |
| `credentials`           | array    | Optional     | Credential IDs to use when the template asks for credentials at launch.     |
| `credential_passwords`  | object   | Optional     | Map of password prompt names to values. Names come from Get Launch Options. |
| `limit`                 | string   | Optional     | Host pattern that limits where the job runs.                                |
| `job_tags`              | string   | Optional     | Comma-separated Ansible tags to run.                                        |
| `skip_tags`             | string   | Optional     | Comma-separated Ansible tags to skip.                                       |
| `scm_branch`            | string   | Optional     | Source control branch, tag, or commit to run.                               |
| `job_type`              | string   | Optional     | Whether to run the job or run it in check mode.                             |
| `verbosity`             | integer  | Optional     | Ansible verbosity from 0 (normal) through 5 (connection debug).             |
| `diff_mode`             | boolean  | Optional     | Show file differences in the job output.                                    |
| `execution_environment` | integer  | Optional     | Execution environment ID to use for this launch.                            |

### Input Example

`{"path_parameters":{"id":"12345678-1234-1234-1234-123456789abc"},"extra_vars":{},"inventory":123,"credentials":[],"credential_passwords":{},"limit":"string","job_tags":"string","skip_tags":"string","scm_branch":"string","job_type":"string","verbosity":123,"diff_mode":true,"execution_environment":123}`

## List Job Templates

Retrieve a list of job templates from Redhat Ansible Automation Platform to view available automation workflows.

### Endpoint

- **URL:** `api/controller/v2/job_templates/`
- **Method:** `GET`

### Input

| **Argument Name**      | **Type** | **Required** | **Description**                                                    |
| ---------------------- | -------- | ------------ | ------------------------------------------------------------------ |
| `parameters.page`      | integer  | Optional     | Page number within the paginated result set.                       |
| `parameters.page_size` | integer  | Optional     | Number of results to return per page.                              |
| `parameters.search`    | string   | Optional     | Search term matched against job template fields.                   |
| `parameters.name`      | string   | Optional     | Filter by job template name.                                       |
| `parameters.order_by`  | string   | Optional     | Field name to order by. Prefix with a hyphen for descending order. |

### Input Example

`{"parameters":{"page":123,"page_size":123,"search":"string","name":"Example Name","order_by":"string"}}`

## List Jobs

Retrieve a list of all automation controller jobs from Redhat Ansible Automation Platform, including job details and statuses.

### Endpoint

- **URL:** `api/controller/v2/jobs/`
- **Method:** `GET`

### Input

| **Argument Name**         | **Type** | **Required** | **Description**                                                                      |
| ------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------ |
| `parameters.page`         | integer  | Optional     | Page number within the paginated result set.                                         |
| `parameters.page_size`    | integer  | Optional     | Number of results to return per page.                                                |
| `parameters.search`       | string   | Optional     | Search term matched against job fields.                                              |
| `parameters.name`         | string   | Optional     | Filter by job name.                                                                  |
| `parameters.status`       | string   | Optional     | Filter by job status, for example successful, failed, running, pending, or canceled. |
| `parameters.job_template` | integer  | Optional     | Filter by job template ID.                                                           |
| `parameters.order_by`     | string   | Optional     | Field name to order by. Prefix with a hyphen for descending order.                   |

### Input Example

`{"parameters":{"page":123,"page_size":123,"search":"string","name":"Example Name","status":"active","job_template":123,"order_by":"string"}}`

# Response Headers

| **Header**   | **Description**                                       | **Example**                   |
| ------------ | ----------------------------------------------------- | ----------------------------- |
| Content-Type | The media type of the resource                        | application/json              |
| Date         | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |
