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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Red Hat Ansible Automation Platform

Red Hat Ansible Automation Platform Hosts API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Red Hat Ansible Automation Platform Hosts 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 Hosts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 21 operations across 13 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version v2.

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

21 operations 13 paths 26 schemas 1 DELETE13 GET2 PATCH3 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/
Contact
ansible-community@redhat.com
License
Apache License
Resource Areas
1

Paths & Operations 21

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

Hosts 21
GET
/api/v2/hosts/
Hosts list
hosts_list 7 params → 200
POST
/api/v2/hosts/
Hosts create
hosts_create body → 201
GET
/api/v2/hosts/{id}/
Hosts retrieve
hosts_retrieve 1 param → 200
PUT
/api/v2/hosts/{id}/
Hosts update
hosts_update 1 param body → 200
PATCH
/api/v2/hosts/{id}/
Hosts partial update
hosts_partial_update 1 param body → 200
DELETE
/api/v2/hosts/{id}/
Hosts destroy
hosts_destroy 1 param → 204
GET
/api/v2/hosts/{id}/activity_stream/
Hosts activity stream list
hosts_activity_stream_list 8 params → 200
GET
/api/v2/hosts/{id}/ad_hoc_command_events/
Hosts ad hoc command events list
hosts_ad_hoc_command_events_list 8 params → 200
GET
/api/v2/hosts/{id}/ad_hoc_commands/
Hosts ad hoc commands list
hosts_ad_hoc_commands_list 8 params → 200
POST
/api/v2/hosts/{id}/ad_hoc_commands/
Hosts ad hoc commands create
hosts_ad_hoc_commands_create 1 param body → 201
GET
/api/v2/hosts/{id}/all_groups/
Hosts all groups list
hosts_all_groups_list 8 params → 200
GET
/api/v2/hosts/{id}/ansible_facts/
Hosts ansible facts retrieve
hosts_ansible_facts_retrieve 1 param → 200
GET
/api/v2/hosts/{id}/groups/
Hosts groups list
hosts_groups_list 8 params → 200
POST
/api/v2/hosts/{id}/groups/
Hosts groups create
hosts_groups_create 1 param body → 201
GET
/api/v2/hosts/{id}/inventory_sources/
Hosts inventory sources list
hosts_inventory_sources_list 8 params → 200
GET
/api/v2/hosts/{id}/job_events/
Hosts job events list
hosts_job_events_list 8 params → 200
GET
/api/v2/hosts/{id}/job_host_summaries/
Hosts job host summaries list
hosts_job_host_summaries_list 8 params → 200
GET
/api/v2/hosts/{id}/smart_inventories/
Hosts smart inventories list
hosts_smart_inventories_list 8 params → 200
GET
/api/v2/hosts/{id}/variable_data/
Hosts variable data retrieve
hosts_variable_data_retrieve 2 params → 200
PUT
/api/v2/hosts/{id}/variable_data/
Hosts variable data update
hosts_variable_data_update 2 params body → 200
PATCH
/api/v2/hosts/{id}/variable_data/
Hosts variable data partial update
hosts_variable_data_partial_update 2 params body → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are InventorySource (34 properties), AdHocCommandList (32 properties), JobEvent (27 properties), Inventory (23 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
HostVariableDataRequest
object
1 property
PaginatedInventoryList
object
4 properties 2 required
JobEvent
object
27 properties 1 required
PaginatedInventorySourceList
object
4 properties 2 required
Group
object
11 properties 2 required
AdHocCommandListRequest
object
12 properties
PaginatedHostList
object
4 properties 2 required
HostRequest
object
6 properties 2 required
PaginatedAdHocCommandListList
object
4 properties 2 required
AdHocCommandList
object
32 properties
PatchedHostVariableDataRequest
object
1 property
HostVariableData
object
1 property
PaginatedActivityStreamList
object
4 properties 2 required
InventorySource
object
34 properties 3 required
PaginatedAdHocCommandEventList
object
4 properties 2 required
PatchedHostRequest
object
6 properties
PaginatedJobEventList
object
4 properties 2 required
PaginatedGroupList
object
4 properties 2 required
Inventory
object
23 properties 2 required
AnsibleFacts
object
9 properties 1 required
PaginatedJobHostSummaryList
object
4 properties 2 required
AdHocCommandEvent
object
21 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-hosts-api-openapi.yml Raw ↑

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

Red Hat Automation Services Catalog API
AE Profile APIs.io
Red Hat Ansible Automation Platform Access Policies API
AE Profile APIs.io
Red Hat Ansible Automation Platform Acs: File API
AE Profile APIs.io
Red Hat Ansible Automation Platform Activation Instances API
AE Profile APIs.io
Red Hat Ansible Automation Platform Activations API
AE Profile APIs.io
Red Hat Ansible Automation Platform Activity Stream API
AE Profile APIs.io
Red Hat Ansible Automation Platform Ad Hoc Command Events API
AE Profile APIs.io
Red Hat Ansible Automation Platform Ad Hoc Commands API
AE Profile APIs.io
Red Hat Ansible Automation Platform AI API
AE Profile APIs.io
Red Hat Ansible Automation Platform Analytics API
AE Profile APIs.io
Red Hat Ansible Automation Platform Ansible: Collections API
AE Profile APIs.io
Red Hat Ansible Automation Platform Api: API
AE Profile APIs.io
#Hosts
← Back to R APIs
API Details
ID
red-hat-ansible-automation-platform:red-hat-ansible-automation-platform-hosts-api
Base URL
https://controller-host/api/v2/
Docs
https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/
Provider
Red Hat Ansible Automation Platform
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=red-hat-ansible-automation-platform-hosts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/red-hat-ansible-automation-platform-hosts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Red Hat Ansible Automation Platform Hosts 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.