Red Hat Ansible Automation Platform

Red Hat Ansible Automation Platform Service Index API

The service-index API from Red Hat Ansible Automation Platform — 49 operation(s) for service-index.

GitHub OpenAPI

Operations 61

GET /api/v2/service-index/ Service index retrieve #
GET /api/v2/service-index/metadata/ Service index metadata retrieve #
POST /api/v2/service-index/object-delete/ Service index object delete create #
GET /api/v2/service-index/resource-types/ Service index resource types list #
GET /api/v2/service-index/resource-types/{name}/ Service index resource types retrieve #
GET /api/v2/service-index/resource-types/{name}/manifest/ Service index resource types manifest retrieve #
GET /api/v2/service-index/resources/ Service index resources list #
POST /api/v2/service-index/resources/ Service index resources create #
GET /api/v2/service-index/resources/{ansible_id}/ Service index resources retrieve #
PUT /api/v2/service-index/resources/{ansible_id}/ Service index resources update #
PATCH /api/v2/service-index/resources/{ansible_id}/ Service index resources partial update #
DELETE /api/v2/service-index/resources/{ansible_id}/ Service index resources destroy #
POST /api/v2/service-index/resources/bulk-update/ Service index resources bulk update create #
GET /api/v2/service-index/role-permissions/ Service index role permissions list #
GET /api/v2/service-index/role-team-assignments/ Service index role team assignments list #
POST /api/v2/service-index/role-team-assignments/assign/ Service index role team assignments assign create #
POST /api/v2/service-index/role-team-assignments/unassign/ Service index role team assignments unassign create #
GET /api/v2/service-index/role-types/ Service index role types list #
GET /api/v2/service-index/role-user-assignments/ Service index role user assignments list #
POST /api/v2/service-index/role-user-assignments/assign/ Service index role user assignments assign create #
POST /api/v2/service-index/role-user-assignments/unassign/ Service index role user assignments unassign create #
GET /service-index/ Service index retrieve #
GET /service-index/metadata/ Service index metadata retrieve #
POST /service-index/object-delete/ Service index object delete create #
GET /service-index/resource-types/ Service index resource types list #
GET /service-index/resource-types/{name}/ Service index resource types retrieve #
GET /service-index/resource-types/{name}/manifest/ Service index resource types manifest retrieve #
GET /service-index/resources/ Service index resources list #
POST /service-index/resources/ Service index resources create #
GET /service-index/resources/{ansible_id}/ Service index resources retrieve #
PUT /service-index/resources/{ansible_id}/ Service index resources update #
PATCH /service-index/resources/{ansible_id}/ Service index resources partial update #
DELETE /service-index/resources/{ansible_id}/ Service index resources destroy #
GET /service-index/role-permissions/ Service index role permissions list #
GET /service-index/role-team-assignments/ Service index role team assignments list #
POST /service-index/role-team-assignments/assign/ Service index role team assignments assign create #
POST /service-index/role-team-assignments/unassign/ Service index role team assignments unassign create #
GET /service-index/role-types/ Service index role types list #
GET /service-index/role-user-assignments/ Service index role user assignments list #
POST /service-index/role-user-assignments/assign/ Service index role user assignments assign create #
POST /service-index/role-user-assignments/unassign/ Service index role user assignments unassign create #
GET /api/gateway/v1/service-index/ Service index retrieve #
GET /api/gateway/v1/service-index/metadata/ Service index metadata retrieve #
POST /api/gateway/v1/service-index/object-delete/ Service index object delete create #
GET /api/gateway/v1/service-index/resource-types/ Service index resource types list #
GET /api/gateway/v1/service-index/resource-types/{name}/ Service index resource types retrieve #
GET /api/gateway/v1/service-index/resource-types/{name}/manifest/ Service index resource types manifest retrieve #
GET /api/gateway/v1/service-index/resources/ Service index resources list #
POST /api/gateway/v1/service-index/resources/ Service index resources create #
GET /api/gateway/v1/service-index/resources/{ansible_id}/ Service index resources retrieve #
PUT /api/gateway/v1/service-index/resources/{ansible_id}/ Service index resources update #
PATCH /api/gateway/v1/service-index/resources/{ansible_id}/ Service index resources partial update #
DELETE /api/gateway/v1/service-index/resources/{ansible_id}/ Service index resources destroy #
GET /api/gateway/v1/service-index/role-permissions/ Service index role permissions list #
GET /api/gateway/v1/service-index/role-team-assignments/ Service index role team assignments list #
POST /api/gateway/v1/service-index/role-team-assignments/assign/ Service index role team assignments assign create #
POST /api/gateway/v1/service-index/role-team-assignments/unassign/ Service index role team assignments unassign create #
GET /api/gateway/v1/service-index/role-types/ Service index role types list #
GET /api/gateway/v1/service-index/role-user-assignments/ Service index role user assignments list #
POST /api/gateway/v1/service-index/role-user-assignments/assign/ Service index role user assignments assign create #
POST /api/gateway/v1/service-index/role-user-assignments/unassign/ Service index role user assignments unassign create #

Documentation

📖
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/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/red-hat-ansible-automation-platform/openapi/red-hat-ansible-automation-platform-service-index-api-openapi.yml

Other Resources

🔗
Console
https://console.redhat.com/ansible/ansible-dashboard

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/red-hat-ansible-automation-platform:red-hat-ansible-automation-platform-service-index-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

red-hat-ansible-automation-platform-service-index-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Red Hat Ansible Automation Platform Service Index API
  version: '1.0'
  description: 'Operations tagged service-index across 3 of this provider''s published API definitions: red-hat-ansible-automation-platform-automation-controller-openapi.json, red-hat-ansible-automation-platform-event-driven-ansible-openapi.json, red-hat-ansible-automation-platform-platform-gateway-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/eda/v1
tags:


# --- truncated at 32 KB (112 KB total) ---
# Full source: https://artifacts.apis.io/red-hat-ansible-automation-platform/openapi/red-hat-ansible-automation-platform-service-index-api-openapi.yml