Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ansible/awx/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Organizations are the top-level organizational units in AWX. They contain teams, users, projects, inventories, and job templates.

​
Endpoints

MethodEndpointDescription
GET/api/v2/organizations/List organizations
POST/api/v2/organizations/Create organization
GET/api/v2/organizations/{id}/Retrieve organization
PATCH/api/v2/organizations/{id}/Update organization
DELETE/api/v2/organizations/{id}/Delete organization

​
List Organizations

curl -X GET \
  https://awx.example.com/api/v2/organizations/ \
  -H "Authorization: Bearer YOUR_TOKEN"
​
count
integer
Total number of organizations
​
results
array
Array of organization objects

​
Create Organization

curl -X POST \
  https://awx.example.com/api/v2/organizations/ \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Engineering",
    "description": "Engineering team organization",
    "max_hosts": 100,
    "default_environment": 1
  }'
​
name
string
required
Name of the organization (unique)
​
description
string
Description of the organization
​
max_hosts
integer
Maximum number of hosts allowed (superuser only)
​
default_environment
integer
ID of the default execution environment

​
Retrieve Organization

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response Schema

​
id
integer
Organization ID
​
name
string
Organization name
​
description
string
Organization description
​
max_hosts
integer
Maximum hosts allowed for this organization
​
created
string
Creation timestamp (ISO 8601)
​
modified
string
Last modification timestamp
​
related
object
Links to related resources:
  • projects - Organization’s projects
  • inventories - Organization’s inventories
  • job_templates - Organization’s job templates
  • workflow_job_templates - Organization’s workflow templates
  • users - Organization members
  • admins - Organization administrators
  • teams - Organization teams
  • credentials - Organization credentials
  • execution_environments - Available execution environments
  • activity_stream - Activity log
  • notification_templates - Notification templates
  • instance_groups - Instance groups
  • galaxy_credentials - Galaxy credentials for Ansible content
  • object_roles - Available roles
  • access_list - User access list
​
summary_fields
object
Summary information about related objects and counts

​
Update Organization

curl -X PATCH \
  https://awx.example.com/api/v2/organizations/1/ \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Updated description",
    "default_environment": 2
  }'
Only superusers can modify the max_hosts field.

​
Delete Organization

curl -X DELETE \
  https://awx.example.com/api/v2/organizations/1/ \
  -H "Authorization: Bearer YOUR_TOKEN"
Deleting an organization will also delete all associated resources (projects, inventories, job templates, etc.)

​
Organization Users

​
List Organization Users

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/users/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
List Organization Admins

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/admins/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Organization Resources

​
List Organization Projects

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/projects/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
List Organization Inventories

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/inventories/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
List Organization Job Templates

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/job_templates/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
List Organization Workflow Job Templates

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/workflow_job_templates/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
List Organization Teams

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/teams/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
List Organization Credentials

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/credentials/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Notification Templates

​
List Notification Templates

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/notification_templates/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
List Started Notification Templates

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/notification_templates_started/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
List Success Notification Templates

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/notification_templates_success/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
List Error Notification Templates

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/notification_templates_error/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
List Approval Notification Templates

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/notification_templates_approvals/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Instance Groups

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/instance_groups/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Galaxy Credentials

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/galaxy_credentials/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Activity Stream

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/activity_stream/ \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Roles and Access

​
List Object Roles

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/object_roles/ \
  -H "Authorization: Bearer YOUR_TOKEN"
Returns available roles:
  • admin_role - Full administrative access
  • member_role - Organization membership
  • auditor_role - Read-only access
  • execute_role - Execute job templates
  • project_admin_role - Manage projects
  • inventory_admin_role - Manage inventories
  • credential_admin_role - Manage credentials
  • workflow_admin_role - Manage workflows
  • notification_admin_role - Manage notifications
  • job_template_admin_role - Manage job templates
Admin and member roles are user-only and cannot be assigned to teams.

​
List Access

curl -X GET \
  https://awx.example.com/api/v2/organizations/1/access_list/ \
  -H "Authorization: Bearer YOUR_TOKEN"
Shows which users and teams have access and their roles.

​
Filtering

# By name
?name=Engineering

# By name (partial match)
?name__icontains=eng

# By created date
?created__gte=2024-01-01

# Search
?search=engineering

​
Ordering

# By name
?order_by=name

# By creation date (newest first)
?order_by=-created

​
Complete Example

import requests
import json

base_url = "https://awx.example.com/api/v2"
token = "YOUR_TOKEN"
headers = {
    "Authorization": f"Bearer {token}",
    "Content-Type": "application/json"
}

# Create organization
org_data = {
    "name": "DevOps Team",
    "description": "DevOps organization"
}

response = requests.post(
    f"{base_url}/organizations/",
    headers=headers,
    data=json.dumps(org_data)
)

if response.status_code == 201:
    org = response.json()
    org_id = org['id']
    print(f"Created organization {org_id}")
    
    # List organization projects
    projects = requests.get(
        f"{base_url}/organizations/{org_id}/projects/",
        headers=headers
    ).json()
    
    print(f"Organization has {projects['count']} projects")
else:
    print(f"Error: {response.status_code}")
    print(response.json())

Build docs developers (and LLMs) love

Get started for freeTalk to us