How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red Hat Ansible Automation Platform Groups API

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

Red Hat Ansible Automation Platform Groups API is one of 333 APIs that Red Hat Ansible Automation Platform publishes on the 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.

This API exposes 35 operations across 20 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, http://automation-hub-backend-cwa.automation-hub-prod.svc.cluster.local:8000/.

35 operations 20 paths 29 schemas 3 DELETE18 GET3 PATCH8 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://controller-host/api/v2/
Resource Areas
1

Paths & Operations 35

Across 20 paths, the API surfaces 35 operations — 3 DELETE, 18 GET, 3 PATCH, 8 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Groups 35
GET
/api/v2/groups/
Groups list
groups_list 7 params → 200
POST
/api/v2/groups/
Groups create
groups_create body → 201
GET
/api/v2/groups/{id}/
Groups retrieve
groups_retrieve 1 param → 200
PUT
/api/v2/groups/{id}/
Groups update
groups_update 1 param body → 200
PATCH
/api/v2/groups/{id}/
Groups partial update
groups_partial_update 1 param body → 200
DELETE
/api/v2/groups/{id}/
Groups destroy
groups_destroy 1 param → 204
GET
/api/v2/groups/{id}/activity_stream/
Groups activity stream list
groups_activity_stream_list 8 params → 200
GET
/api/v2/groups/{id}/ad_hoc_commands/
Groups ad hoc commands list
groups_ad_hoc_commands_list 8 params → 200
POST
/api/v2/groups/{id}/ad_hoc_commands/
Groups ad hoc commands create
groups_ad_hoc_commands_create 1 param body → 201
GET
/api/v2/groups/{id}/all_hosts/
Groups all hosts list
groups_all_hosts_list 8 params → 200
GET
/api/v2/groups/{id}/children/
Groups children list
groups_children_list 8 params → 200
POST
/api/v2/groups/{id}/children/
Groups children create
groups_children_create 1 param body → 201
GET
/api/v2/groups/{id}/hosts/
Groups hosts list
groups_hosts_list 8 params → 200
POST
/api/v2/groups/{id}/hosts/
Groups hosts create
groups_hosts_create 1 param body → 201
GET
/api/v2/groups/{id}/inventory_sources/
Groups inventory sources list
groups_inventory_sources_list 8 params → 200
GET
/api/v2/groups/{id}/job_events/
Groups job events list
groups_job_events_list 8 params → 200
GET
/api/v2/groups/{id}/job_host_summaries/
Groups job host summaries list
groups_job_host_summaries_list 8 params → 200
GET
/api/v2/groups/{id}/potential_children/
Groups potential children list
groups_potential_children_list 8 params → 200
GET
/api/v2/groups/{id}/variable_data/
Groups variable data retrieve
groups_variable_data_retrieve 2 params → 200
PUT
/api/v2/groups/{id}/variable_data/
Groups variable data update
groups_variable_data_update 2 params body → 200
PATCH
/api/v2/groups/{id}/variable_data/
Groups variable data partial update
groups_variable_data_partial_update 2 params body → 200
GET
/api/automation-hub/_ui/v1/groups/
List groups
_api_automation-hub__ui_v1_groups_groups_list 9 params → 200
POST
/api/automation-hub/_ui/v1/groups/
Create a group
_api_automation-hub__ui_v1_groups_groups_create body → 201
GET
/api/automation-hub/_ui/v1/groups/{id}/
Inspect a group
_api_automation-hub__ui_v1_groups_{id}_groups_read 3 params → 200
DELETE
/api/automation-hub/_ui/v1/groups/{id}/
Delete a group
_api_automation-hub__ui_v1_groups_{id}_groups_delete 1 param → 204
GET
/api/automation-hub/pulp/api/v3/groups/
List groups
_api_automation-hub_pulp_api_v3_groups_groups_list 15 params → 200
POST
/api/automation-hub/pulp/api/v3/groups/
Create a group
_api_automation-hub_pulp_api_v3_groups_groups_create body → 201
GET
/api/automation-hub/pulp/api/v3/groups/{id}/
Inspect a group
_api_automation-hub_pulp_api_v3_groups_{id}_groups_read 3 params → 200
PUT
/api/automation-hub/pulp/api/v3/groups/{id}/
Update a group
putApiAutomationHubPulpApiV3GroupsById 1 param body → 200
PATCH
/api/automation-hub/pulp/api/v3/groups/{id}/
Update a group
patchApiAutomationHubPulpApiV3GroupsById 1 param body → 200
DELETE
/api/automation-hub/pulp/api/v3/groups/{id}/
Delete a group
_api_automation-hub_pulp_api_v3_groups_{id}_groups_delete 1 param → 204
POST
/api/automation-hub/pulp/api/v3/groups/{id}/add_role/
Add a role
groups_add_role 1 param body → 201
GET
/api/automation-hub/pulp/api/v3/groups/{id}/list_roles/
List roles
groups_list_roles 3 params → 200
GET
/api/automation-hub/pulp/api/v3/groups/{id}/my_permissions/
List user permissions
groups_my_permissions 3 params → 200
POST
/api/automation-hub/pulp/api/v3/groups/{id}/remove_role/
Remove a role
groups_remove_role 1 param body → 201

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are InventorySource (34 properties), AdHocCommandList (32 properties), JobEvent (27 properties), JobHostSummary (20 properties). Each schema is shown below with its type and property counts.

Host
object
18 properties 2 required
JobHostSummary
object
20 properties
ActivityStream
object
13 properties 3 required
PatchedGroupRequest
object
4 properties
JobEvent
object
27 properties 1 required
PaginatedInventorySourceList
object
4 properties 2 required
Group
object
11 properties 2 required
AdHocCommandListRequest
object
12 properties
HostRequest
object
6 properties 2 required
PaginatedHostList
object
4 properties 2 required
PaginatedAdHocCommandListList
object
4 properties 2 required
AdHocCommandList
object
32 properties
GroupVariableDataRequest
object
1 property
PaginatedActivityStreamList
object
4 properties 2 required
InventorySource
object
34 properties 3 required
PaginatedJobEventList
object
4 properties 2 required
GroupVariableData
object
1 property
PaginatedGroupList
object
4 properties 2 required
PatchedGroupVariableDataRequest
object
1 property
PaginatedJobHostSummaryList
object
4 properties 2 required
GroupRequest
object
4 properties 2 required
Group_2
object
Serializer for Group.
1 property 1 required
PatchedGroup
object
1 property
GroupResponse
object
Serializer for Group.
3 properties 1 required
MyPermissionsResponse
object
1 property 1 required
PaginatedGroupResponseList
object
3 properties
NestedRole
object
Serializer to add/remove object roles to/from users/groups. This is used in conjunction with pulpcore.app.viewsets.base.RolesMixin and requires the underlying…
3 properties 1 required
NestedRoleResponse
object
Serializer to add/remove object roles to/from users/groups. This is used in conjunction with pulpcore.app.viewsets.base.RolesMixin and requires the underlying…
3 properties 1 required
ObjectRolesResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-ansible-automation-platform-groups-api-openapi.yml Raw ↑

Other APIs Red Hat Ansible Automation Platform publishes across the network.

Red Hat Automation Services Catalog API
Red Hat Ansible Automation Platform Access Policies API
Red Hat Ansible Automation Platform Acs: File API
Red Hat Ansible Automation Platform Activation Instances API
Red Hat Ansible Automation Platform Activations API
Red Hat Ansible Automation Platform Activity Stream API
Red Hat Ansible Automation Platform Ad Hoc Command Events API
Red Hat Ansible Automation Platform Ad Hoc Commands API
Red Hat Ansible Automation Platform AI API
Red Hat Ansible Automation Platform Analytics API
Red Hat Ansible Automation Platform Ansible: Collections API
Red Hat Ansible Automation Platform Api: API
Where this information came from

This is an independent, third-party profile of Red Hat Ansible Automation Platform Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.