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

The instances API from Red Hat Ansible Automation Platform — 8 operation(s) for instances.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

13 operations 8 paths 12 schemas 8 GET1 PATCH3 POST1 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 13

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

Instances 13
GET
/api/v2/instances/
Instances list
instances_list 7 params → 200
POST
/api/v2/instances/
Instances create
instances_create body → 201
GET
/api/v2/instances/{id}/
Instances retrieve
instances_retrieve 1 param → 200
PUT
/api/v2/instances/{id}/
Instances update
instances_update 1 param body → 200
PATCH
/api/v2/instances/{id}/
Instances partial update
instances_partial_update 1 param body → 200
GET
/api/v2/instances/{id}/health_check/
Instances health check retrieve
instances_health_check_retrieve 1 param → 200
POST
/api/v2/instances/{id}/health_check/
Instances health check create
instances_health_check_create 1 param → 200
GET
/api/v2/instances/{id}/install_bundle/
Instances install bundle retrieve
instances_install_bundle_retrieve 1 param → 200
GET
/api/v2/instances/{id}/instance_groups/
Instances instance groups list
instances_instance_groups_list 8 params → 200
POST
/api/v2/instances/{id}/instance_groups/
Instances instance groups create
instances_instance_groups_create 1 param body → 201
GET
/api/v2/instances/{id}/jobs/
Instances jobs list
instances_jobs_list 8 params → 200
GET
/api/v2/instances/{id}/peers/
Instances peers list
instances_peers_list 8 params → 200
GET
/api/v2/instances/{id}/receptor_addresses/
Instances receptor addresses list
instances_receptor_addresses_list 8 params → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Instance (36 properties), UnifiedJobList (23 properties), InstanceGroup (22 properties), ReceptorAddress (11 properties). Each schema is shown below with its type and property counts.

InstanceHealthCheck
object
11 properties
UnifiedJobList
object
23 properties 1 required
PaginatedInstanceList
object
4 properties 2 required
PatchedInstanceRequest
object
9 properties
PaginatedInstanceGroupList
object
4 properties 2 required
InstanceRequest
object
9 properties 1 required
InstanceGroupRequest
object
9 properties 1 required
ReceptorAddress
object
11 properties 2 required
PaginatedUnifiedJobListList
object
4 properties 2 required
PaginatedReceptorAddressList
object
4 properties 2 required
Instance
object
36 properties 1 required
InstanceGroup
object
22 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-ansible-automation-platform-instances-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
#Instances
← Back to R APIs
API Details
ID
red-hat-ansible-automation-platform:red-hat-ansible-automation-platform-instances-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-instances-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/red-hat-ansible-automation-platform-instances-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 Instances 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.