# Red Hat Ansible Automation Platform Service Index API

**Canonical:** https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-service-index-api/  
**Provider:** Red Hat Ansible Automation Platform — https://apis.io/providers/red-hat-ansible-automation-platform/  
**Base URL:** https://controller-host/api/v2/  
**Documentation:** https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/

Red Hat Ansible Automation Platform Service Index API is one of 333 APIs that [Red Hat Ansible Automation Platform](https://apis.io/providers/red-hat-ansible-automation-platform/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include ServiceIndex. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

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

## Operations (60 of 61)

| Method | Path | Summary |
|---|---|---|
| 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 |

…and 1 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/red-hat-ansible-automation-platform/refs/heads/main/openapi/red-hat-ansible-automation-platform-service-index-api-openapi.yml
- **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/
- **Console** — https://console.redhat.com/ansible/ansible-dashboard

## Other Red Hat Ansible Automation Platform APIs (12)

- [Red Hat Automation Services Catalog API](https://apis.io/apis/red-hat-ansible-automation-platform/services-catalog-api/)
- [Red Hat Ansible Automation Platform Access Policies API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-access-policies-api/)
- [Red Hat Ansible Automation Platform Acs: File API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-acs-file-api/)
- [Red Hat Ansible Automation Platform Activation Instances API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-activation-instances-api/)
- [Red Hat Ansible Automation Platform Activations API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-activations-api/)
- [Red Hat Ansible Automation Platform Activity Stream API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-activity-stream-api/)
- [Red Hat Ansible Automation Platform Ad Hoc Command Events API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-ad-hoc-command-events-api/)
- [Red Hat Ansible Automation Platform Ad Hoc Commands API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-ad-hoc-commands-api/)
- [Red Hat Ansible Automation Platform AI API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-ai-api/)
- [Red Hat Ansible Automation Platform Analytics API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-analytics-api/)
- [Red Hat Ansible Automation Platform Ansible: Collections API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-ansible-collections-api/)
- [Red Hat Ansible Automation Platform Api: API](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-api-api-api/)

## Tags

ServiceIndex

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/red-hat-ansible-automation-platform/red-hat-ansible-automation-platform-service-index-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/red-hat-ansible-automation-platform/.