# Red Hat Ansible Automation Platform Hosts API

**Canonical:** https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-hosts-api/  
**Provider:** Red Hat Ansible Automation Platform — https://apis.io/providers/red-hat-ansible-automation-platform/  
**Base URL:** https://controller-host/api/v2/  
**Documentation:** https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/

Red Hat Ansible Automation Platform Hosts API is one of 333 APIs that [Red Hat Ansible Automation Platform](https://apis.io/providers/red-hat-ansible-automation-platform/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Hosts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The hosts API from Red Hat Ansible Automation Platform — 13 operation(s) for hosts.

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v2/hosts/` | Hosts list |
| POST | `/api/v2/hosts/` | Hosts create |
| GET | `/api/v2/hosts/{id}/` | Hosts retrieve |
| PUT | `/api/v2/hosts/{id}/` | Hosts update |
| PATCH | `/api/v2/hosts/{id}/` | Hosts partial update |
| DELETE | `/api/v2/hosts/{id}/` | Hosts destroy |
| GET | `/api/v2/hosts/{id}/activity_stream/` | Hosts activity stream list |
| GET | `/api/v2/hosts/{id}/ad_hoc_command_events/` | Hosts ad hoc command events list |
| GET | `/api/v2/hosts/{id}/ad_hoc_commands/` | Hosts ad hoc commands list |
| POST | `/api/v2/hosts/{id}/ad_hoc_commands/` | Hosts ad hoc commands create |
| GET | `/api/v2/hosts/{id}/all_groups/` | Hosts all groups list |
| GET | `/api/v2/hosts/{id}/ansible_facts/` | Hosts ansible facts retrieve |
| GET | `/api/v2/hosts/{id}/groups/` | Hosts groups list |
| POST | `/api/v2/hosts/{id}/groups/` | Hosts groups create |
| GET | `/api/v2/hosts/{id}/inventory_sources/` | Hosts inventory sources list |
| GET | `/api/v2/hosts/{id}/job_events/` | Hosts job events list |
| GET | `/api/v2/hosts/{id}/job_host_summaries/` | Hosts job host summaries list |
| GET | `/api/v2/hosts/{id}/smart_inventories/` | Hosts smart inventories list |
| GET | `/api/v2/hosts/{id}/variable_data/` | Hosts variable data retrieve |
| PUT | `/api/v2/hosts/{id}/variable_data/` | Hosts variable data update |
| PATCH | `/api/v2/hosts/{id}/variable_data/` | Hosts variable data partial update |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/red-hat-ansible-automation-platform/refs/heads/main/openapi/red-hat-ansible-automation-platform-hosts-api-openapi.yml
- **Documentation** — https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/
- **APIReference** — https://docs.ansible.com/automation-controller/latest/html/controllerapi/api_ref.html
- **Authentication** — https://docs.ansible.com/automation-controller/latest/html/controllerapi/authentication.html
- **Documentation** — https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4/html/managing_red_hat_certified_and_ansible_galaxy_collections_in_automation_hub/
- **Documentation** — https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4/html/event-driven_ansible_controller_user_guide/
- **Console** — https://console.redhat.com/ansible/ansible-dashboard

## Other Red Hat Ansible Automation Platform APIs (12)

- [Red Hat Automation Services Catalog API](https://apis.io/apis/red-hat-ansible-automation-platform/services-catalog-api/)
- [Red Hat Ansible Automation Platform Access Policies API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-access-policies-api/)
- [Red Hat Ansible Automation Platform Acs: File API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-acs-file-api/)
- [Red Hat Ansible Automation Platform Activation Instances API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-activation-instances-api/)
- [Red Hat Ansible Automation Platform Activations API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-activations-api/)
- [Red Hat Ansible Automation Platform Activity Stream API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-activity-stream-api/)
- [Red Hat Ansible Automation Platform Ad Hoc Command Events API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-ad-hoc-command-events-api/)
- [Red Hat Ansible Automation Platform Ad Hoc Commands API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-ad-hoc-commands-api/)
- [Red Hat Ansible Automation Platform AI API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-ai-api/)
- [Red Hat Ansible Automation Platform Analytics API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-analytics-api/)
- [Red Hat Ansible Automation Platform Ansible: Collections API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-ansible-collections-api/)
- [Red Hat Ansible Automation Platform Api: API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-api-api-api/)

## Tags

Hosts

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-hosts-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/red-hat-ansible-automation-platform/.