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 Service Index API

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

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

This API exposes 61 operations across 49 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, /api/eda/v1.

61 operations 49 paths 32 schemas 3 DELETE33 GET3 PATCH19 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://controller-host/api/v2/
Authentication
API Key, API Key, HTTP Basic, OAuth 2.0, API Key
Resource Areas
1

Authentication & Security 5

Red Hat Ansible Automation Platform Service Index API declares 5 security schemes for authenticating requests. An API key is passed in the header as X-DAB-JW-TOKEN (EDAJWTAuthentication). An API key is passed in the cookie as sessionid (cookieAuth). It accepts HTTP basic authentication (Basic_Authentication). It supports OAuth 2.0 (OAuth2_Authentication) using the authorizationCode and password flows, exposing 2 scopes. An API key is passed in the cookie as gateway_sessionid (SessionAuthentication).

Paths & Operations 61

Across 49 paths, the API surfaces 61 operations — 3 DELETE, 33 GET, 3 PATCH, 19 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Service Index 61
GET
/api/v2/service-index/
Service index retrieve
service_index_retrieve → 200
GET
/api/v2/service-index/metadata/
Service index metadata retrieve
service_index_metadata_retrieve → 200
POST
/api/v2/service-index/object-delete/
Service index object delete create
service_index_object_delete_create → 201
GET
/api/v2/service-index/resource-types/
Service index resource types list
service_index_resource_types_list 15 params → 200
GET
/api/v2/service-index/resource-types/{name}/
Service index resource types retrieve
service_index_resource_types_retrieve 1 param → 200
GET
/api/v2/service-index/resource-types/{name}/manifest/
Service index resource types manifest retrieve
service_index_resource_types_manifest_retrieve 1 param → 200
GET
/api/v2/service-index/resources/
Service index resources list
service_index_resources_list 20 params → 200
POST
/api/v2/service-index/resources/
Service index resources create
service_index_resources_create body → 201
GET
/api/v2/service-index/resources/{ansible_id}/
Service index resources retrieve
service_index_resources_retrieve 1 param → 200
PUT
/api/v2/service-index/resources/{ansible_id}/
Service index resources update
service_index_resources_update 1 param body → 200
PATCH
/api/v2/service-index/resources/{ansible_id}/
Service index resources partial update
service_index_resources_partial_update 1 param body → 200
DELETE
/api/v2/service-index/resources/{ansible_id}/
Service index resources destroy
service_index_resources_destroy 1 param → 204
POST
/api/v2/service-index/resources/bulk-update/
Service index resources bulk update create
service_index_resources_bulk_update_create body → 200
GET
/api/v2/service-index/role-permissions/
Service index role permissions list
service_index_role_permissions_list 19 params → 200
GET
/api/v2/service-index/role-team-assignments/
Service index role team assignments list
service_index_role_team_assignments_list 7 params → 200
POST
/api/v2/service-index/role-team-assignments/assign/
Service index role team assignments assign create
service_index_role_team_assignments_assign_create body → 200
POST
/api/v2/service-index/role-team-assignments/unassign/
Service index role team assignments unassign create
service_index_role_team_assignments_unassign_create body → 200
GET
/api/v2/service-index/role-types/
Service index role types list
service_index_role_types_list 23 params → 200
GET
/api/v2/service-index/role-user-assignments/
Service index role user assignments list
service_index_role_user_assignments_list 7 params → 200
POST
/api/v2/service-index/role-user-assignments/assign/
Service index role user assignments assign create
service_index_role_user_assignments_assign_create body → 200
POST
/api/v2/service-index/role-user-assignments/unassign/
Service index role user assignments unassign create
service_index_role_user_assignments_unassign_create body → 200
GET
/service-index/
Service index retrieve
getServiceIndex → 200
GET
/service-index/metadata/
Service index metadata retrieve
getServiceIndexMetadata → 200
POST
/service-index/object-delete/
Service index object delete create
postServiceIndexObjectDelete → 201
GET
/service-index/resource-types/
Service index resource types list
getServiceIndexResourceTypes 2 params → 200
GET
/service-index/resource-types/{name}/
Service index resource types retrieve
getServiceIndexResourceTypesByName 1 param → 200
GET
/service-index/resource-types/{name}/manifest/
Service index resource types manifest retrieve
getServiceIndexResourceTypesByNameManifest 1 param → 200
GET
/service-index/resources/
Service index resources list
getServiceIndexResources 2 params → 200
POST
/service-index/resources/
Service index resources create
postServiceIndexResources body → 201
GET
/service-index/resources/{ansible_id}/
Service index resources retrieve
getServiceIndexResourcesByAnsibleId 1 param → 200
PUT
/service-index/resources/{ansible_id}/
Service index resources update
putServiceIndexResourcesByAnsibleId 1 param body → 200
PATCH
/service-index/resources/{ansible_id}/
Service index resources partial update
patchServiceIndexResourcesByAnsibleId 1 param body → 200
DELETE
/service-index/resources/{ansible_id}/
Service index resources destroy
deleteServiceIndexResourcesByAnsibleId 1 param → 204
GET
/service-index/role-permissions/
Service index role permissions list
getServiceIndexRolePermissions 3 params → 200
GET
/service-index/role-team-assignments/
Service index role team assignments list
getServiceIndexRoleTeamAssignments 3 params → 200
POST
/service-index/role-team-assignments/assign/
Service index role team assignments assign create
postServiceIndexRoleTeamAssignmentsAssign body → 200
POST
/service-index/role-team-assignments/unassign/
Service index role team assignments unassign create
postServiceIndexRoleTeamAssignmentsUnassign body → 200
GET
/service-index/role-types/
Service index role types list
getServiceIndexRoleTypes 3 params → 200
GET
/service-index/role-user-assignments/
Service index role user assignments list
getServiceIndexRoleUserAssignments 3 params → 200
POST
/service-index/role-user-assignments/assign/
Service index role user assignments assign create
postServiceIndexRoleUserAssignmentsAssign body → 200
POST
/service-index/role-user-assignments/unassign/
Service index role user assignments unassign create
postServiceIndexRoleUserAssignmentsUnassign body → 200
GET
/api/gateway/v1/service-index/
Service index retrieve
getApiGatewayV1ServiceIndex → 200
GET
/api/gateway/v1/service-index/metadata/
Service index metadata retrieve
getApiGatewayV1ServiceIndexMetadata → 200
POST
/api/gateway/v1/service-index/object-delete/
Service index object delete create
postApiGatewayV1ServiceIndexObjectDelete → 201
GET
/api/gateway/v1/service-index/resource-types/
Service index resource types list
getApiGatewayV1ServiceIndexResourceTypes 14 params → 200
GET
/api/gateway/v1/service-index/resource-types/{name}/
Service index resource types retrieve
getApiGatewayV1ServiceIndexResourceTypesByName 1 param → 200
GET
/api/gateway/v1/service-index/resource-types/{name}/manifest/
Service index resource types manifest retrieve
getApiGatewayV1ServiceIndexResourceTypesByNameManifest 1 param → 200
GET
/api/gateway/v1/service-index/resources/
Service index resources list
getApiGatewayV1ServiceIndexResources 19 params → 200
POST
/api/gateway/v1/service-index/resources/
Service index resources create
postApiGatewayV1ServiceIndexResources body → 201
GET
/api/gateway/v1/service-index/resources/{ansible_id}/
Service index resources retrieve
getApiGatewayV1ServiceIndexResourcesByAnsibleId 1 param → 200
PUT
/api/gateway/v1/service-index/resources/{ansible_id}/
Service index resources update
putApiGatewayV1ServiceIndexResourcesByAnsibleId 1 param body → 200
PATCH
/api/gateway/v1/service-index/resources/{ansible_id}/
Service index resources partial update
patchApiGatewayV1ServiceIndexResourcesByAnsibleId 1 param body → 200
DELETE
/api/gateway/v1/service-index/resources/{ansible_id}/
Service index resources destroy
deleteApiGatewayV1ServiceIndexResourcesByAnsibleId 1 param → 204
GET
/api/gateway/v1/service-index/role-permissions/
Service index role permissions list
getApiGatewayV1ServiceIndexRolePermissions 19 params → 200
GET
/api/gateway/v1/service-index/role-team-assignments/
Service index role team assignments list
getApiGatewayV1ServiceIndexRoleTeamAssignments 25 params → 200
POST
/api/gateway/v1/service-index/role-team-assignments/assign/
Service index role team assignments assign create
postApiGatewayV1ServiceIndexRoleTeamAssignmentsAssign body → 200
POST
/api/gateway/v1/service-index/role-team-assignments/unassign/
Service index role team assignments unassign create
postApiGatewayV1ServiceIndexRoleTeamAssignmentsUnassign body → 200
GET
/api/gateway/v1/service-index/role-types/
Service index role types list
getApiGatewayV1ServiceIndexRoleTypes 23 params → 200
GET
/api/gateway/v1/service-index/role-user-assignments/
Service index role user assignments list
getApiGatewayV1ServiceIndexRoleUserAssignments 25 params → 200
POST
/api/gateway/v1/service-index/role-user-assignments/assign/
Service index role user assignments assign create
postApiGatewayV1ServiceIndexRoleUserAssignmentsAssign body → 200
POST
/api/gateway/v1/service-index/role-user-assignments/unassign/
Service index role user assignments unassign create
postApiGatewayV1ServiceIndexRoleUserAssignmentsUnassign body → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Resource (10 properties), PatchedResource (10 properties), Resource_2 (10 properties), ResourceList_3 (9 properties). Each schema is shown below with its type and property counts.

PaginatedServiceRoleUserAssignmentList
object
4 properties 2 required
DABPermission
object
4 properties 2 required
ServiceRoleUserAssignmentRequest
object
5 properties 2 required
ServiceRoleTeamAssignment
object
8 properties 2 required
PaginatedDABPermissionList
object
4 properties 2 required
PaginatedServiceRoleTeamAssignmentList
object
4 properties 2 required
ServiceRoleUserAssignment
object
8 properties 2 required
PaginatedDABContentTypeList
object
4 properties 2 required
ServiceRoleTeamAssignmentRequest
object
5 properties 2 required
Resource
object
10 properties 1 required
ResourceRequest
object
5 properties 1 required
DABContentType
object
6 properties 2 required
ResourceType
object
5 properties 1 required
PaginatedResourceListList
object
4 properties 2 required
PatchedResourceRequest
object
5 properties
PaginatedResourceTypeList
object
4 properties 2 required
ResourceList
object
8 properties
PaginatedServiceRoleUserAssignmentList_2
object
6 properties
DABPermission_2
object
4 properties 3 required
PatchedResource
object
10 properties
ServiceRoleTeamAssignment_2
object
7 properties 4 required
PaginatedDABPermissionList_2
object
6 properties
PaginatedServiceRoleTeamAssignmentList_2
object
6 properties
ServiceRoleUserAssignment_2
object
7 properties 4 required
DABContentType_2
object
6 properties 3 required
Resource_2
object
10 properties 6 required
ResourceType_2
object
5 properties 5 required
PaginatedDABContentTypeList_2
object
6 properties
ResourceList_2
object
9 properties 4 required
ServiceRoleTeamAssignment_3
object
7 properties 2 required
ServiceRoleUserAssignment_3
object
7 properties 2 required
ResourceList_3
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-ansible-automation-platform-service-index-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 Service Index 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.