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 Inventories API

The inventories API from Red Hat Ansible Automation Platform — 19 operation(s) for inventories.

Red Hat Ansible Automation Platform Inventories 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 Inventories. 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 19 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against the base URL https://controller-host/api/v2/.

35 operations 19 paths 37 schemas 1 DELETE19 GET2 PATCH11 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 35

Across 19 paths, the API surfaces 35 operations — 1 DELETE, 19 GET, 2 PATCH, 11 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Inventories 35
GET
/api/v2/inventories/
Inventories list
inventories_list 7 params → 200
POST
/api/v2/inventories/
Inventories create
inventories_create body → 201
GET
/api/v2/inventories/{id}/
Inventories retrieve
inventories_retrieve 1 param → 200
PUT
/api/v2/inventories/{id}/
Inventories update
inventories_update 1 param body → 200
PATCH
/api/v2/inventories/{id}/
Inventories partial update
inventories_partial_update 1 param body → 200
DELETE
/api/v2/inventories/{id}/
Inventories destroy
inventories_destroy 1 param → 204
GET
/api/v2/inventories/{id}/access_list/
Inventories access list list
inventories_access_list_list 8 params → 200
GET
/api/v2/inventories/{id}/activity_stream/
Inventories activity stream list
inventories_activity_stream_list 8 params → 200
GET
/api/v2/inventories/{id}/ad_hoc_commands/
Inventories ad hoc commands list
inventories_ad_hoc_commands_list 8 params → 200
POST
/api/v2/inventories/{id}/ad_hoc_commands/
Inventories ad hoc commands create
inventories_ad_hoc_commands_create 1 param body → 201
GET
/api/v2/inventories/{id}/copy/
Inventories copy retrieve
inventories_copy_retrieve 1 param → 200
POST
/api/v2/inventories/{id}/copy/
Inventories copy create
inventories_copy_create 1 param body → 200
GET
/api/v2/inventories/{id}/groups/
Inventories groups list
inventories_groups_list 8 params → 200
POST
/api/v2/inventories/{id}/groups/
Inventories groups create
inventories_groups_create 1 param body → 201
GET
/api/v2/inventories/{id}/hosts/
Inventories hosts list
inventories_hosts_list 8 params → 200
POST
/api/v2/inventories/{id}/hosts/
Inventories hosts create
inventories_hosts_create 1 param body → 201
GET
/api/v2/inventories/{id}/input_inventories/
Inventories input inventories list
inventories_input_inventories_list 8 params → 200
POST
/api/v2/inventories/{id}/input_inventories/
Inventories input inventories create
inventories_input_inventories_create 1 param body → 201
GET
/api/v2/inventories/{id}/instance_groups/
Inventories instance groups list
inventories_instance_groups_list 8 params → 200
POST
/api/v2/inventories/{id}/instance_groups/
Inventories instance groups create
inventories_instance_groups_create 1 param body → 201
GET
/api/v2/inventories/{id}/inventory_sources/
Inventories inventory sources list
inventories_inventory_sources_list 8 params → 200
POST
/api/v2/inventories/{id}/inventory_sources/
Inventories inventory sources create
inventories_inventory_sources_create 1 param body → 201
GET
/api/v2/inventories/{id}/job_templates/
Inventories job templates list
inventories_job_templates_list 8 params → 200
GET
/api/v2/inventories/{id}/labels/
Inventories labels list
inventories_labels_list 8 params → 200
POST
/api/v2/inventories/{id}/labels/
Inventories labels create
inventories_labels_create 1 param body → 201
GET
/api/v2/inventories/{id}/object_roles/
Inventories object roles list
inventories_object_roles_list 8 params → 200
GET
/api/v2/inventories/{id}/root_groups/
Inventories root groups list
inventories_root_groups_list 8 params → 200
POST
/api/v2/inventories/{id}/root_groups/
Inventories root groups create
inventories_root_groups_create 1 param body → 201
GET
/api/v2/inventories/{id}/script/
Inventories script retrieve
inventories_script_retrieve 1 param → 200
GET
/api/v2/inventories/{id}/tree/
Inventories tree retrieve
inventories_tree_retrieve 1 param → 200
GET
/api/v2/inventories/{id}/update_inventory_sources/
Inventories update inventory sources retrieve
inventories_update_inventory_sources_retrieve 1 param → 200
POST
/api/v2/inventories/{id}/update_inventory_sources/
Inventories update inventory sources create
inventories_update_inventory_sources_create 1 param → 200
GET
/api/v2/inventories/{id}/variable_data/
Inventories variable data retrieve
inventories_variable_data_retrieve 2 params → 200
PUT
/api/v2/inventories/{id}/variable_data/
Inventories variable data update
inventories_variable_data_update 2 params body → 200
PATCH
/api/v2/inventories/{id}/variable_data/
Inventories variable data partial update
inventories_variable_data_partial_update 2 params body → 200

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are JobTemplate (57 properties), InventorySource (34 properties), AdHocCommandList (32 properties), Inventory (23 properties). Each schema is shown below with its type and property counts.

PaginatedJobTemplateList
object
4 properties 2 required
Copy
object
1 property 1 required
Host
object
18 properties 2 required
JobTemplate
object
Provide recent jobs and survey details in summaryfields
57 properties 1 required
GroupTree
object
12 properties 2 required
InstanceGroupRequest
object
9 properties 1 required
ActivityStream
object
13 properties 3 required
Role
object
7 properties
PaginatedInventoryList
object
4 properties 2 required
PaginatedInstanceGroupList
object
4 properties 2 required
PaginatedInventorySourceList
object
4 properties 2 required
Group
object
11 properties 2 required
InventoryRequest
object
8 properties 2 required
CopyRequest
object
1 property 1 required
AdHocCommandListRequest
object
12 properties
PaginatedLabelList
object
4 properties 2 required
InventorySourceRequest
object
20 properties 3 required
HostRequest
object
6 properties 2 required
PaginatedHostList
object
4 properties 2 required
InventoryVariableDataRequest
object
1 property
InventorySourceUpdate
object
1 property
AdHocCommandList
object
32 properties
PaginatedAdHocCommandListList
object
4 properties 2 required
InventoryVariableData
object
1 property
PaginatedActivityStreamList
object
4 properties 2 required
InventorySource
object
34 properties 3 required
ResourceAccessListElement
object
15 properties 1 required
PatchedInventoryRequest
object
8 properties
PaginatedRoleList
object
4 properties 2 required
LabelRequest
object
2 properties 2 required
PatchedInventoryVariableDataRequest
object
1 property
Label
object
9 properties 2 required
PaginatedGroupList
object
4 properties 2 required
Inventory
object
23 properties 2 required
PaginatedResourceAccessListElementList
object
4 properties 2 required
InstanceGroup
object
22 properties 1 required
GroupRequest
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-ansible-automation-platform-inventories-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 Inventories 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.