# Red Hat Ansible Automation Platform Groups API

**Canonical:** https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-groups-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 Groups 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 Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The groups API from Red Hat Ansible Automation Platform — 20 operation(s) for groups.

## Operations (35)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v2/groups/` | Groups list |
| POST | `/api/v2/groups/` | Groups create |
| GET | `/api/v2/groups/{id}/` | Groups retrieve |
| PUT | `/api/v2/groups/{id}/` | Groups update |
| PATCH | `/api/v2/groups/{id}/` | Groups partial update |
| DELETE | `/api/v2/groups/{id}/` | Groups destroy |
| GET | `/api/v2/groups/{id}/activity_stream/` | Groups activity stream list |
| GET | `/api/v2/groups/{id}/ad_hoc_commands/` | Groups ad hoc commands list |
| POST | `/api/v2/groups/{id}/ad_hoc_commands/` | Groups ad hoc commands create |
| GET | `/api/v2/groups/{id}/all_hosts/` | Groups all hosts list |
| GET | `/api/v2/groups/{id}/children/` | Groups children list |
| POST | `/api/v2/groups/{id}/children/` | Groups children create |
| GET | `/api/v2/groups/{id}/hosts/` | Groups hosts list |
| POST | `/api/v2/groups/{id}/hosts/` | Groups hosts create |
| GET | `/api/v2/groups/{id}/inventory_sources/` | Groups inventory sources list |
| GET | `/api/v2/groups/{id}/job_events/` | Groups job events list |
| GET | `/api/v2/groups/{id}/job_host_summaries/` | Groups job host summaries list |
| GET | `/api/v2/groups/{id}/potential_children/` | Groups potential children list |
| GET | `/api/v2/groups/{id}/variable_data/` | Groups variable data retrieve |
| PUT | `/api/v2/groups/{id}/variable_data/` | Groups variable data update |
| PATCH | `/api/v2/groups/{id}/variable_data/` | Groups variable data partial update |
| GET | `/api/automation-hub/_ui/v1/groups/` | List groups |
| POST | `/api/automation-hub/_ui/v1/groups/` | Create a group |
| GET | `/api/automation-hub/_ui/v1/groups/{id}/` | Inspect a group |
| DELETE | `/api/automation-hub/_ui/v1/groups/{id}/` | Delete a group |
| GET | `/api/automation-hub/pulp/api/v3/groups/` | List groups |
| POST | `/api/automation-hub/pulp/api/v3/groups/` | Create a group |
| GET | `/api/automation-hub/pulp/api/v3/groups/{id}/` | Inspect a group |
| PUT | `/api/automation-hub/pulp/api/v3/groups/{id}/` | Update a group |
| PATCH | `/api/automation-hub/pulp/api/v3/groups/{id}/` | Update a group |
| DELETE | `/api/automation-hub/pulp/api/v3/groups/{id}/` | Delete a group |
| POST | `/api/automation-hub/pulp/api/v3/groups/{id}/add_role/` | Add a role |
| GET | `/api/automation-hub/pulp/api/v3/groups/{id}/list_roles/` | List roles |
| GET | `/api/automation-hub/pulp/api/v3/groups/{id}/my_permissions/` | List user permissions |
| POST | `/api/automation-hub/pulp/api/v3/groups/{id}/remove_role/` | Remove a role |

## 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-groups-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

Group

---

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-groups-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/red-hat-ansible-automation-platform/.