AWX API Reference

Developer reference for the AWX API.

This guide applies to the latest version of AWX only. The content in this guide is updated frequently and might contain functionality that is not available in previous versions. Likewise content in this guide can be removed or replaced if it applies to functionality that is no longer available in the latest version.

Join us online

Need help or want to discuss AWX including the documentation? See the Communication guide to learn how to join the conversation!

• AWX API Reference
• 1. Tools
• 2. Browsable API
• 3. Conventions
• 4. Sorting
• 5. Searching
• 6. Filtering
• 7. Pagination
• 8. Access Resources
  • 8.1. Configuration Settings
  • 8.2. Identifier Format Protocol
• 9. Read-only Fields
• 10. Authentication Methods Using the API
  • 10.1. Session Authentication
  • 10.2. Basic Authentication
• 11. The awx-manage Utility
  • 11.1. Inventory Import
  • 11.2. Cleanup of old data
  • 11.3. Cluster management
  • 11.4. Session management
  • 11.5. Analytics gathering
• 12. AWX API Reference Guide