Studio Project workflows for Ansible AWX job templates, inventories, credentials, and projects
Ansible AWX (the upstream open-source project behind Red Hat Ansible Automation Platform's Controller) is a web UI, REST API, and task engine for Ansible — managing job templates, inventories, credentials, projects, and job/workflow execution.
This project provides OpenAPI specs for automating against the AWX (AAP) REST API via an Integration Model. The -latest spec is a curated subset covering common CRUD for automation — see OpenAPIs below.
| Asset | Description |
|---|---|
| OpenAPIs/ | Ansible AWX (AAP) REST API OpenAPI specs — curated -latest plus the full dated spec |
| Studio Projects/Ansible AWX (AAP) | 30 workflows covering common CRUD automation |
| Requirement | Version |
|---|---|
| Itential Platform | 6.x |
| Ansible AWX / AAP | API v2 |
| Ansible AWX (AAP) Integration Model | Required to build automation against the OpenAPI specs |
Import one of the OpenAPI specs from OpenAPIs/ as an Integration Model in Admin > Integrations, then create an integration pointing at your AWX/AAP instance.
Authentication is a bearer token in the Authorization header:
Authorization: Bearer <token> Generate a token by issuing POST /api/v2/tokens/ with your AWX username and password.
The instance's authentication/server properties should look like this once configured:
{
"authentication": {
"bearerAuth": "<your-bearer-token>"
},
"server": {
"protocol": "https",
"host": "<your-host>",
"base_path": ""
}
} | Spec | Version | Operations | Description |
|---|---|---|---|
ansible_awx_aap-latest.json | latest (curated) | 277 | Trimmed to 277 of 631 upstream operations — see breakdown below |
ansible_awx_aap-v2.json | v2 | 631 | Full, unmodified vendor spec |
ansible_awx_aap-latest.jsonActively-maintained spec (x-vendor-api-version: v2). Trimmed to 277 of 631 upstream operations covering common CRUD for automation. Pull the full spec from a running AWX instance's /api/v2/ OpenAPI schema endpoint if you need something not covered here.
Resources included, by category:
update), project updates (read/cancel/events/stdout), playbooks, schedulesupdate), read/cancel/events/stdout on updatesExcluded as long-tail/admin surface: activity streams, analytics/reporting, bulk operations, instance/instance-group and mesh/receptor infrastructure administration, RBAC role management (roles, role_definitions, role_*_assignments), the service-index federation API, system jobs/settings/config administration, workflow approvals, and webhook receiver endpoints (GitHub/GitLab/Bitbucket callback hooks).
ansible_awx_aap-v2.jsonFull, unmodified vendor spec (API v2, 631 operations) — the vendor's complete API surface, preserved as-is. See ansible_awx_aap-latest.json above for the curated subset if you just need common CRUD automation.
Backed by the Ansible AWX (AAP):latest Integration Model (see ansible_awx_aap-latest.json above). The project contains 30 workflows organized into 6 folders, one atomic workflow per API operation, covering the common-CRUD subset of the curated spec.
| Folder | Workflows | Scope |
|---|---|---|
| Job Templates | List, Get, Create, Update, Delete, Launch Job Template | Job template lifecycle and launch |
| Jobs | List, Get, Relaunch, Delete Job | Job monitoring and control |
| Inventories | List, Get, Create, Update, Delete Inventory | Inventory lifecycle |
| Projects | List, Get, Create, Update, Delete Project | SCM project lifecycle |
| Credentials | List, Get, Create, Update, Delete Credential | Credential lifecycle |
| Hosts | List, Get, Create, Update, Delete Host | Host lifecycle |
| Dependency | Notes |
|---|---|
Ansible AWX (AAP):latest Integration Model | Import from ansible_awx_aap-latest.json before importing the project |
Ansible AWX (AAP) integration instance | Create in Admin > Integrations with the connection properties above. Workflows are wired to an integration instance named Ansible AWX (AAP) — update the adapter_id value in each workflow task if yours is named differently |