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

REST API for the Ansible Automation Platform Gateway, the single front door introduced in AAP 2.5 that fronts every platform component. Manages users, teams, organizations, role definitions and assignments, identity authenticators (LDAP/SAML/OIDC), OAuth applications and tokens, HTTP routing and platform settings.

Documentation Provider Profile APIs.io OpenAPI GitHub

Red Hat Ansible Automation Platform Gateway API is one of 7 APIs that Red Hat Ansible Automation Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Gateway, Identity, RBAC, and REST. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 206 operations across 125 paths, organized into 41 resource areas, and defines 121 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against the base URL https://gateway-host/api/gateway/v1/.

206 operations 125 paths 121 schemas 22 DELETE103 GET19 PATCH43 POST19 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://gateway-host/api/gateway/v1/
Authentication
HTTP Basic, OAuth 2.0, API Key
Resource Areas
41

Authentication & Security 3

Red Hat Ansible Automation Platform Gateway API declares 3 security schemes for authenticating requests. 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 206

Across 125 paths, the API surfaces 206 operations — 22 DELETE, 103 GET, 19 PATCH, 43 POST, 19 PUT. They span 41 resource areas, including api, Operations, activitystream, app_urls, applications, authenticator_maps, authenticator_plugins, authenticator_users, and 33 more. Each is listed below with its method, path, parameters, and response codes.

api 2
GET
/api/
api_retrieve → 200
GET
/api/gateway/
api_gateway_retrieve → 200
Operations 1
GET
/api/gateway/v1/
This responds to GET requests made to it with a sorted list of available API endpoints
root_retrieve → 200
activitystream 2
GET
/api/gateway/v1/activitystream/
API endpoint that allows for read-only access to activity stream entries.
activitystream_list 6 params → 200
GET
/api/gateway/v1/activitystream/{id}/
API endpoint that allows for read-only access to activity stream entries.
activitystream_retrieve 1 param → 200
app_urls 1
GET
/api/gateway/v1/app_urls/
API endpoint that allows oauth apps to be listed for name and appurl
app_urls_list 7 params → 200
applications 7
GET
/api/gateway/v1/applications/
applications_list 47 params → 200
POST
/api/gateway/v1/applications/
applications_create body → 201
GET
/api/gateway/v1/applications/{id}/
applications_retrieve 1 param → 200
PUT
/api/gateway/v1/applications/{id}/
applications_update 1 param body → 200
PATCH
/api/gateway/v1/applications/{id}/
applications_partial_update 1 param body → 200
DELETE
/api/gateway/v1/applications/{id}/
applications_destroy 1 param → 204
GET
/api/gateway/v1/applications/{id}/tokens/
Manage Access Token objects in the 'accesstokens' relationship of this particular Application. Starting from the detail URL: GET /:id/accesstokens/ to show access tokens currently in the relationship
applications_tokens_list 46 params → 200
authenticator_maps 9
GET
/api/gateway/v1/authenticator_maps/
API endpoint that allows authenticator maps to be viewed or edited.
authenticator_maps_list 42 params → 200
POST
/api/gateway/v1/authenticator_maps/
API endpoint that allows authenticator maps to be viewed or edited.
authenticator_maps_create body → 201
GET
/api/gateway/v1/authenticator_maps/{id}/
API endpoint that allows authenticator maps to be viewed or edited.
authenticator_maps_retrieve 1 param → 200
PUT
/api/gateway/v1/authenticator_maps/{id}/
API endpoint that allows authenticator maps to be viewed or edited.
authenticator_maps_update 1 param body → 200
PATCH
/api/gateway/v1/authenticator_maps/{id}/
API endpoint that allows authenticator maps to be viewed or edited.
authenticator_maps_partial_update 1 param body → 200
DELETE
/api/gateway/v1/authenticator_maps/{id}/
API endpoint that allows authenticator maps to be viewed or edited.
authenticator_maps_destroy 1 param → 204
GET
/api/gateway/v1/authenticator_maps/{id}/authenticators/
Manage Authenticator objects in the 'authenticators' relationship of this particular Authenticator Map. Starting from the detail URL: GET /:id/authenticators/ to show authenticators currently in the…
authenticator_maps_authenticators_list 41 params → 200
POST
/api/gateway/v1/authenticator_maps/{id}/authenticators/associate/
Manage Authenticator objects in the 'authenticators' relationship of this particular Authenticator Map. Starting from the detail URL: GET /:id/authenticators/ to show authenticators currently in the…
authenticator_maps_authenticators_associate_create 1 param body → 200
POST
/api/gateway/v1/authenticator_maps/{id}/authenticators/disassociate/
Manage Authenticator objects in the 'authenticators' relationship of this particular Authenticator Map. Starting from the detail URL: GET /:id/authenticators/ to show authenticators currently in the…
authenticator_maps_authenticators_disassociate_create 1 param body → 200
authenticator_plugins 1
GET
/api/gateway/v1/authenticator_plugins/
authenticator_plugins_retrieve → 200
authenticator_users 3
GET
/api/gateway/v1/authenticator_users/
API endpoint that allows AuthenticatorUsers to be viewed and listed.
authenticator_users_list 32 params → 200
GET
/api/gateway/v1/authenticator_users/{id}/
API endpoint that allows AuthenticatorUsers to be viewed and listed.
authenticator_users_retrieve 1 param → 200
POST
/api/gateway/v1/authenticator_users/{id}/move/
API endpoint that allows AuthenticatorUsers to be viewed and listed.
authenticator_users_move_create 1 param body → 200
authenticators 8
GET
/api/gateway/v1/authenticators/
API endpoint that allows authenticators to be viewed or edited.
authenticators_list 40 params → 200
POST
/api/gateway/v1/authenticators/
API endpoint that allows authenticators to be viewed or edited.
authenticators_create body → 201
GET
/api/gateway/v1/authenticators/{id}/
API endpoint that allows authenticators to be viewed or edited.
authenticators_retrieve 1 param → 200
PUT
/api/gateway/v1/authenticators/{id}/
API endpoint that allows authenticators to be viewed or edited.
authenticators_update 1 param body → 200
PATCH
/api/gateway/v1/authenticators/{id}/
API endpoint that allows authenticators to be viewed or edited.
authenticators_partial_update 1 param body → 200
DELETE
/api/gateway/v1/authenticators/{id}/
API endpoint that allows authenticators to be viewed or edited.
authenticators_destroy 1 param → 204
GET
/api/gateway/v1/authenticators/{id}/authenticator_maps/
Manage Authenticator Map objects in the 'authenticatormaps' relationship of this particular Authenticator. Starting from the detail URL: GET /:id/authenticatormaps/ to show authenticator maps current…
authenticators_authenticator_maps_list 43 params → 200
GET
/api/gateway/v1/authenticators/{id}/users/
API endpoint that allows users to be viewed or edited.
authenticators_users_list 51 params → 200
ca_certificates 6
GET
/api/gateway/v1/ca_certificates/
API endpoint that allows to manage a CA Certificate
ca_certificates_list 32 params → 200
POST
/api/gateway/v1/ca_certificates/
API endpoint that allows to manage a CA Certificate
ca_certificates_create body → 201
GET
/api/gateway/v1/ca_certificates/{id}/
API endpoint that allows to manage a CA Certificate
ca_certificates_retrieve 1 param → 200
PUT
/api/gateway/v1/ca_certificates/{id}/
API endpoint that allows to manage a CA Certificate
ca_certificates_update 1 param body → 200
PATCH
/api/gateway/v1/ca_certificates/{id}/
API endpoint that allows to manage a CA Certificate
ca_certificates_partial_update 1 param body → 200
DELETE
/api/gateway/v1/ca_certificates/{id}/
API endpoint that allows to manage a CA Certificate
ca_certificates_destroy 1 param → 204
docs 1
GET
/api/gateway/v1/docs/schema/
OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
docs_schema_retrieve 2 params → 200
feature_flags 5
GET
/api/gateway/v1/feature_flags/
API endpoint that allows feature flags to be viewed or edited.
feature_flags_list 44 params → 200
GET
/api/gateway/v1/feature_flags/{id}/
API endpoint that allows feature flags to be viewed or edited.
feature_flags_retrieve 1 param → 200
PATCH
/api/gateway/v1/feature_flags/{id}/
Handle PATCH requests to update feature flag values.
feature_flags_partial_update 1 param body → 200
GET
/api/gateway/v1/feature_flags/states/
A view class for displaying feature flags states. To add/update/remove a feature flag, see the instructions in docs/apps/featureflags.md
feature_flags_states_list 44 params → 200
GET
/api/gateway/v1/feature_flags/states/{id}/
A view class for displaying feature flags states. To add/update/remove a feature flag, see the instructions in docs/apps/featureflags.md
feature_flags_states_retrieve 1 param → 200
feature_flags_state 1
GET
/api/gateway/v1/feature_flags_state/
A view class for displaying feature flags
feature_flags_state_retrieve → 200
http_ports 9
GET
/api/gateway/v1/http_ports/
API endpoint that allows HTTP ports to be viewed or edited.
http_ports_list 35 params → 200
POST
/api/gateway/v1/http_ports/
API endpoint that allows HTTP ports to be viewed or edited.
http_ports_create body → 201
GET
/api/gateway/v1/http_ports/{id}/
API endpoint that allows HTTP ports to be viewed or edited.
http_ports_retrieve 1 param → 200
PUT
/api/gateway/v1/http_ports/{id}/
API endpoint that allows HTTP ports to be viewed or edited.
http_ports_update 1 param body → 200
PATCH
/api/gateway/v1/http_ports/{id}/
API endpoint that allows HTTP ports to be viewed or edited.
http_ports_partial_update 1 param body → 200
DELETE
/api/gateway/v1/http_ports/{id}/
API endpoint that allows HTTP ports to be viewed or edited.
http_ports_destroy 1 param → 204
GET
/api/gateway/v1/http_ports/{id}/routes/
Manage Additional Route objects in the 'routes' relationship of this particular Http Port. Starting from the detail URL: GET /:id/routes/ to show additional routes currently in the relationship POST…
http_ports_routes_list 63 params → 200
POST
/api/gateway/v1/http_ports/{id}/routes/associate/
Manage Additional Route objects in the 'routes' relationship of this particular Http Port. Starting from the detail URL: GET /:id/routes/ to show additional routes currently in the relationship POST…
http_ports_routes_associate_create 1 param body → 200
POST
/api/gateway/v1/http_ports/{id}/routes/disassociate/
Manage Additional Route objects in the 'routes' relationship of this particular Http Port. Starting from the detail URL: GET /:id/routes/ to show additional routes currently in the relationship POST…
http_ports_routes_disassociate_create 1 param body → 200
jwt_claims 1
GET
/api/gateway/v1/jwt_claims/{user_ansible_id}/
Get JWT claims for a specific user by their Ansible ID. Accessible by service tokens or superusers.
jwt_claims_retrieve 1 param → 200404
jwt_key 1
GET
/api/gateway/v1/jwt_key/
jwt_key_retrieve → 200
me 1
GET
/api/gateway/v1/me/
me_list 7 params → 200
organizations 13
GET
/api/gateway/v1/organizations/
API endpoint that allows organizations to be viewed or edited.
organizations_list 30 params → 200
POST
/api/gateway/v1/organizations/
API endpoint that allows organizations to be viewed or edited.
organizations_create body → 201
GET
/api/gateway/v1/organizations/{id}/
API endpoint that allows organizations to be viewed or edited.
organizations_retrieve 1 param → 200
PUT
/api/gateway/v1/organizations/{id}/
API endpoint that allows organizations to be viewed or edited.
organizations_update 1 param body → 200
PATCH
/api/gateway/v1/organizations/{id}/
API endpoint that allows organizations to be viewed or edited.
organizations_partial_update 1 param body → 200
DELETE
/api/gateway/v1/organizations/{id}/
API endpoint that allows organizations to be viewed or edited.
organizations_destroy 1 param → 204
GET
/api/gateway/v1/organizations/{id}/admins/deprecated
Manage User objects in the 'admins' relationship of this particular Organization. Starting from the detail URL: GET /:id/admins/ to show users currently in the relationship POST a list of instances t…
organizations_admins_list 51 params → 200
POST
/api/gateway/v1/organizations/{id}/admins/associate/deprecated
Manage User objects in the 'admins' relationship of this particular Organization. Starting from the detail URL: GET /:id/admins/ to show users currently in the relationship POST a list of instances t…
organizations_admins_associate_create 1 param body → 200
POST
/api/gateway/v1/organizations/{id}/admins/disassociate/deprecated
Manage User objects in the 'admins' relationship of this particular Organization. Starting from the detail URL: GET /:id/admins/ to show users currently in the relationship POST a list of instances t…
organizations_admins_disassociate_create 1 param body → 200
GET
/api/gateway/v1/organizations/{id}/teams/
Manage Team objects in the 'teams' relationship of this particular Organization. Starting from the detail URL: GET /:id/teams/ to show teams currently in the relationship
organizations_teams_list 31 params → 200
GET
/api/gateway/v1/organizations/{id}/users/deprecated
Manage User objects in the 'users' relationship of this particular Organization. Starting from the detail URL: GET /:id/users/ to show users currently in the relationship POST a list of instances to…
organizations_users_list 51 params → 200
POST
/api/gateway/v1/organizations/{id}/users/associate/deprecated
Manage User objects in the 'users' relationship of this particular Organization. Starting from the detail URL: GET /:id/users/ to show users currently in the relationship POST a list of instances to…
organizations_users_associate_create 1 param body → 200
POST
/api/gateway/v1/organizations/{id}/users/disassociate/deprecated
Manage User objects in the 'users' relationship of this particular Organization. Starting from the detail URL: GET /:id/users/ to show users currently in the relationship POST a list of instances to…
organizations_users_disassociate_create 1 param body → 200
ping 1
GET
/api/gateway/v1/ping/
ping_retrieve → 200
role_definitions 8
GET
/api/gateway/v1/role_definitions/
Update the corresponding resource in each service.
role_definitions_list 31 params → 200
POST
/api/gateway/v1/role_definitions/
Update the corresponding resource in each service.
role_definitions_create body → 201
GET
/api/gateway/v1/role_definitions/{id}/
Update the corresponding resource in each service.
role_definitions_retrieve 1 param → 200
PUT
/api/gateway/v1/role_definitions/{id}/
Update the corresponding resource in each service.
role_definitions_update 1 param body → 200
PATCH
/api/gateway/v1/role_definitions/{id}/
Update the corresponding resource in each service.
role_definitions_partial_update 1 param body → 200
DELETE
/api/gateway/v1/role_definitions/{id}/
Update the corresponding resource in each service.
role_definitions_destroy 1 param → 204
GET
/api/gateway/v1/role_definitions/{id}/team_assignments/
Manage Role Team Assignment objects in the 'teamassignments' relationship of this particular Role Definition. Starting from the detail URL: GET /:id/teamassignments/ to show role team assignments cur…
role_definitions_team_assignments_list 8 params → 200
GET
/api/gateway/v1/role_definitions/{id}/user_assignments/
Manage Role User Assignment objects in the 'userassignments' relationship of this particular Role Definition. Starting from the detail URL: GET /:id/userassignments/ to show role user assignments cur…
role_definitions_user_assignments_list 8 params → 200
role_team_access 2
GET
/api/gateway/v1/role_team_access/{model_name}/{id}/
Use this endpoint to get a list of users who have access to a resource. This is a list-only view that provides a list of users, plus extra data.
role_team_access_list 9 params → 200
GET
/api/gateway/v1/role_team_access/{model_name}/{id}/{actor_pk}/
This gives drill-down information about the means of inheritance for all the permissions show in the higher-level view of the access list
role_team_access_list_2 10 params → 200
role_team_assignments 4
GET
/api/gateway/v1/role_team_assignments/
Use this endpoint to give a team permission to a resource or an organization. The needed data is the team, the role definition, and the object id. The object must be of the type specified in the role…
role_team_assignments_list 7 params → 200
POST
/api/gateway/v1/role_team_assignments/
Use this endpoint to give a team permission to a resource or an organization. The needed data is the team, the role definition, and the object id. The object must be of the type specified in the role…
role_team_assignments_create body → 201
GET
/api/gateway/v1/role_team_assignments/{id}/
Use this endpoint to give a team permission to a resource or an organization. The needed data is the team, the role definition, and the object id. The object must be of the type specified in the role…
role_team_assignments_retrieve 1 param → 200
DELETE
/api/gateway/v1/role_team_assignments/{id}/
Use this endpoint to give a team permission to a resource or an organization. The needed data is the team, the role definition, and the object id. The object must be of the type specified in the role…
role_team_assignments_destroy 1 param → 204
role_user_access 2
GET
/api/gateway/v1/role_user_access/{model_name}/{id}/
Use this endpoint to get a list of users who have access to a resource. This is a list-only view that provides a list of users, plus extra data.
role_user_access_list 9 params → 200
GET
/api/gateway/v1/role_user_access/{model_name}/{id}/{actor_pk}/
This gives drill-down information about the means of inheritance for all the permissions show in the higher-level view of the access list
role_user_access_list_2 10 params → 200
role_user_assignments 4
GET
/api/gateway/v1/role_user_assignments/
role_user_assignments_list 7 params → 200
POST
/api/gateway/v1/role_user_assignments/
Give a user permission to a resource, an organization, or globally (when allowed). Must specify 'roledefinition' and exactly one of 'user' or 'useransibleid'. Can specify at most one of 'objectid' or…
role_user_assignments_create body → 201
GET
/api/gateway/v1/role_user_assignments/{id}/
role_user_assignments_retrieve 1 param → 200
DELETE
/api/gateway/v1/role_user_assignments/{id}/
role_user_assignments_destroy 1 param → 204
routes 6
GET
/api/gateway/v1/routes/
API endpoint that allows additional routes to be viewed or edited.
routes_list 62 params → 200
POST
/api/gateway/v1/routes/
API endpoint that allows additional routes to be viewed or edited.
routes_create body → 201
GET
/api/gateway/v1/routes/{id}/
API endpoint that allows additional routes to be viewed or edited.
routes_retrieve 1 param → 200
PUT
/api/gateway/v1/routes/{id}/
API endpoint that allows additional routes to be viewed or edited.
routes_update 1 param body → 200
PATCH
/api/gateway/v1/routes/{id}/
API endpoint that allows additional routes to be viewed or edited.
routes_partial_update 1 param body → 200
DELETE
/api/gateway/v1/routes/{id}/
API endpoint that allows additional routes to be viewed or edited.
routes_destroy 1 param → 204
service-index 20
GET
/api/gateway/v1/service-index/
Link other resource registry endpoints
service_index_retrieve → 200
GET
/api/gateway/v1/service-index/metadata/
service_index_metadata_retrieve → 200
POST
/api/gateway/v1/service-index/object-delete/
Delete all role assignments (user and team) for a specific resource. Expected request data: { "resourcetype": "main.inventory", "resourcepk": "4" }
service_index_object_delete_create → 201
GET
/api/gateway/v1/service-index/resource-types/
Index of the resource types that are configured in the system.
service_index_resource_types_list 14 params → 200
GET
/api/gateway/v1/service-index/resource-types/{name}/
Index of the resource types that are configured in the system.
service_index_resource_types_retrieve 1 param → 200
GET
/api/gateway/v1/service-index/resource-types/{name}/manifest/
Returns the as a stream the csv of resourceid,hash for a given resource type.
service_index_resource_types_manifest_retrieve 1 param → 200
GET
/api/gateway/v1/service-index/resources/
Index of all the resources in the system.
service_index_resources_list 19 params → 200
POST
/api/gateway/v1/service-index/resources/
Index of all the resources in the system.
service_index_resources_create body → 201
GET
/api/gateway/v1/service-index/resources/{ansible_id}/
Index of all the resources in the system.
service_index_resources_retrieve 1 param → 200
PUT
/api/gateway/v1/service-index/resources/{ansible_id}/
Index of all the resources in the system.
service_index_resources_update 1 param body → 200
PATCH
/api/gateway/v1/service-index/resources/{ansible_id}/
Index of all the resources in the system.
service_index_resources_partial_update 1 param body → 200
DELETE
/api/gateway/v1/service-index/resources/{ansible_id}/
Index of all the resources in the system.
service_index_resources_destroy 1 param → 204
GET
/api/gateway/v1/service-index/role-permissions/
List of permissions managed with the RBAC system
service_index_role_permissions_list 19 params → 200
GET
/api/gateway/v1/service-index/role-team-assignments/
List of team role assignments for cross-service communication
service_index_role_team_assignments_list 25 params → 200
POST
/api/gateway/v1/service-index/role-team-assignments/assign/
List of team role assignments for cross-service communication
service_index_role_team_assignments_assign_create body → 200
POST
/api/gateway/v1/service-index/role-team-assignments/unassign/
List of team role assignments for cross-service communication
service_index_role_team_assignments_unassign_create body → 200
GET
/api/gateway/v1/service-index/role-types/
List of types registered with the RBAC system, or loaded in from external system
service_index_role_types_list 23 params → 200
GET
/api/gateway/v1/service-index/role-user-assignments/
List of user assignments for cross-service communication
service_index_role_user_assignments_list 25 params → 200
POST
/api/gateway/v1/service-index/role-user-assignments/assign/
List of user assignments for cross-service communication
service_index_role_user_assignments_assign_create body → 200
POST
/api/gateway/v1/service-index/role-user-assignments/unassign/
List of user assignments for cross-service communication
service_index_role_user_assignments_unassign_create body → 200
service_clusters 14
GET
/api/gateway/v1/service_clusters/
API endpoint that allows service clusters to be viewed or edited.
service_clusters_list 83 params → 200
POST
/api/gateway/v1/service_clusters/
API endpoint that allows service clusters to be viewed or edited.
service_clusters_create body → 201
GET
/api/gateway/v1/service_clusters/{id}/
API endpoint that allows service clusters to be viewed or edited.
service_clusters_retrieve 1 param → 200
PUT
/api/gateway/v1/service_clusters/{id}/
API endpoint that allows service clusters to be viewed or edited.
service_clusters_update 1 param body → 200
PATCH
/api/gateway/v1/service_clusters/{id}/
API endpoint that allows service clusters to be viewed or edited.
service_clusters_partial_update 1 param body → 200
DELETE
/api/gateway/v1/service_clusters/{id}/
API endpoint that allows service clusters to be viewed or edited.
service_clusters_destroy 1 param → 204
GET
/api/gateway/v1/service_clusters/{id}/nodes/
Manage Service Node objects in the 'nodes' relationship of this particular Service Cluster. Starting from the detail URL: GET /:id/nodes/ to show service nodes currently in the relationship
service_clusters_nodes_list 32 params → 200
GET
/api/gateway/v1/service_clusters/{id}/routes/
Manage Additional Route objects in the 'routes' relationship of this particular Service Cluster. Starting from the detail URL: GET /:id/routes/ to show additional routes currently in the relationship…
service_clusters_routes_list 63 params → 200
POST
/api/gateway/v1/service_clusters/{id}/routes/associate/
Manage Additional Route objects in the 'routes' relationship of this particular Service Cluster. Starting from the detail URL: GET /:id/routes/ to show additional routes currently in the relationship…
service_clusters_routes_associate_create 1 param body → 200
POST
/api/gateway/v1/service_clusters/{id}/routes/disassociate/
Manage Additional Route objects in the 'routes' relationship of this particular Service Cluster. Starting from the detail URL: GET /:id/routes/ to show additional routes currently in the relationship…
service_clusters_routes_disassociate_create 1 param body → 200
GET
/api/gateway/v1/service_clusters/{id}/service_keys/
Manage Service Key objects in the 'servicekeys' relationship of this particular Service Cluster. Starting from the detail URL: GET /:id/servicekeys/ to show service keys currently in the relationship
service_clusters_service_keys_list 33 params → 200
GET
/api/gateway/v1/service_clusters/{id}/service_types/
Manage Service Type objects in the 'servicetypes' relationship of this particular Service Cluster. Starting from the detail URL: GET /:id/servicetypes/ to show service types currently in the relation…
service_clusters_service_types_list 35 params → 200
POST
/api/gateway/v1/service_clusters/{id}/service_types/associate/
Manage Service Type objects in the 'servicetypes' relationship of this particular Service Cluster. Starting from the detail URL: GET /:id/servicetypes/ to show service types currently in the relation…
service_clusters_service_types_associate_create 1 param body → 200
POST
/api/gateway/v1/service_clusters/{id}/service_types/disassociate/
Manage Service Type objects in the 'servicetypes' relationship of this particular Service Cluster. Starting from the detail URL: GET /:id/servicetypes/ to show service types currently in the relation…
service_clusters_service_types_disassociate_create 1 param body → 200
service_keys 6
GET
/api/gateway/v1/service_keys/
API endpoint that allows configuring service authentication keys.
service_keys_list 32 params → 200
POST
/api/gateway/v1/service_keys/
API endpoint that allows configuring service authentication keys.
service_keys_create body → 201
GET
/api/gateway/v1/service_keys/{id}/
API endpoint that allows configuring service authentication keys.
service_keys_retrieve 1 param → 200
PUT
/api/gateway/v1/service_keys/{id}/
API endpoint that allows configuring service authentication keys.
service_keys_update 1 param body → 200
PATCH
/api/gateway/v1/service_keys/{id}/
API endpoint that allows configuring service authentication keys.
service_keys_partial_update 1 param body → 200
DELETE
/api/gateway/v1/service_keys/{id}/
API endpoint that allows configuring service authentication keys.
service_keys_destroy 1 param → 204
service_nodes 6
GET
/api/gateway/v1/service_nodes/
API endpoint that allows service nodes to be viewed or edited.
service_nodes_list 31 params → 200
POST
/api/gateway/v1/service_nodes/
API endpoint that allows service nodes to be viewed or edited.
service_nodes_create body → 201
GET
/api/gateway/v1/service_nodes/{id}/
API endpoint that allows service nodes to be viewed or edited.
service_nodes_retrieve 1 param → 200
PUT
/api/gateway/v1/service_nodes/{id}/
API endpoint that allows service nodes to be viewed or edited.
service_nodes_update 1 param body → 200
PATCH
/api/gateway/v1/service_nodes/{id}/
API endpoint that allows service nodes to be viewed or edited.
service_nodes_partial_update 1 param body → 200
DELETE
/api/gateway/v1/service_nodes/{id}/
API endpoint that allows service nodes to be viewed or edited.
service_nodes_destroy 1 param → 204
service_types 7
GET
/api/gateway/v1/service_types/
API endpoint that allows service types to be viewed or edited
service_types_list 34 params → 200
POST
/api/gateway/v1/service_types/
API endpoint that allows service types to be viewed or edited
service_types_create body → 201
GET
/api/gateway/v1/service_types/{id}/
API endpoint that allows service types to be viewed or edited
service_types_retrieve 1 param → 200
PUT
/api/gateway/v1/service_types/{id}/
API endpoint that allows service types to be viewed or edited
service_types_update 1 param body → 200
PATCH
/api/gateway/v1/service_types/{id}/
API endpoint that allows service types to be viewed or edited
service_types_partial_update 1 param body → 200
DELETE
/api/gateway/v1/service_types/{id}/
API endpoint that allows service types to be viewed or edited
service_types_destroy 1 param → 204
GET
/api/gateway/v1/service_types/{id}/clusters/
Manage Service Cluster objects in the 'clusters' relationship of this particular Service Type. Starting from the detail URL: GET /:id/clusters/ to show service clusters currently in the relationship
service_types_clusters_list 84 params → 200
services 6
GET
/api/gateway/v1/services/
API endpoint that allows service API routes to be viewed or edited.
services_list 64 params → 200
POST
/api/gateway/v1/services/
API endpoint that allows service API routes to be viewed or edited.
services_create body → 201
GET
/api/gateway/v1/services/{id}/
API endpoint that allows service API routes to be viewed or edited.
services_retrieve 1 param → 200
PUT
/api/gateway/v1/services/{id}/
API endpoint that allows service API routes to be viewed or edited.
services_update 1 param body → 200
PATCH
/api/gateway/v1/services/{id}/
API endpoint that allows service API routes to be viewed or edited.
services_partial_update 1 param body → 200
DELETE
/api/gateway/v1/services/{id}/
API endpoint that allows service API routes to be viewed or edited.
services_destroy 1 param → 204
session 2
GET
/api/gateway/v1/session/
session_retrieve → 200404
POST
/api/gateway/v1/session/
session_create → 200
settings 6
GET
/api/gateway/v1/settings/
A view class for managing and displaying all section of settings, with their urls and names Endpoint: '/api/gateway/v1/settings/'
settings_list 2 params → 200
GET
/api/gateway/v1/settings/{category_slug}/
A view class for managing and displaying a group of settings for a specific category. Endpoint: '/api/gateway/v1/settings/ /' Parameters: - categoryslug: The category of the setting (e.g., 'proxy', '…
settings_getter 1 param → 200
PUT
/api/gateway/v1/settings/{category_slug}/
A view class for managing and displaying a group of settings for a specific category. Endpoint: '/api/gateway/v1/settings/ /' Parameters: - categoryslug: The category of the setting (e.g., 'proxy', '…
settings_update 1 param body → 200
DELETE
/api/gateway/v1/settings/{category_slug}/
Revert all preferences in the current category to their default values except for readonly or encrypted settings
settings_destroyer 1 param → 204
GET
/api/gateway/v1/settings/{category_slug}/{preference_name}/
A view class for managing and displaying a single setting information for a specified category. URL pattern: '/api/gateway/v1/settings/ / /' Parameters: - categoryslug: The category of the setting (e…
settings_retrieve 2 params → 200
DELETE
/api/gateway/v1/settings/{category_slug}/{preference_name}/
revert the setting preferencename in section categoryslug to its default value. The categoryslug parameter must be specified (i.e., cannot be 'all') because Preference only guarantees uniqueness for…
settings_destroy 2 params → 204
status 1
GET
/api/gateway/v1/status/
API endpoint that shows status of platform services.
status_retrieve 1 param → 200
teams 12
GET
/api/gateway/v1/teams/
API endpoint that allows groups to be viewed or edited.
teams_list 30 params → 200
POST
/api/gateway/v1/teams/
API endpoint that allows groups to be viewed or edited.
teams_create body → 201
GET
/api/gateway/v1/teams/{id}/
API endpoint that allows groups to be viewed or edited.
teams_retrieve 1 param → 200
PUT
/api/gateway/v1/teams/{id}/
API endpoint that allows groups to be viewed or edited.
teams_update 1 param body → 200
PATCH
/api/gateway/v1/teams/{id}/
API endpoint that allows groups to be viewed or edited.
teams_partial_update 1 param body → 200
DELETE
/api/gateway/v1/teams/{id}/
API endpoint that allows groups to be viewed or edited.
teams_destroy 1 param → 204
GET
/api/gateway/v1/teams/{id}/admins/deprecated
Manage User objects in the 'admins' relationship of this particular Team. Starting from the detail URL: GET /:id/admins/ to show users currently in the relationship POST a list of instances to /:id/a…
teams_admins_list 51 params → 200
POST
/api/gateway/v1/teams/{id}/admins/associate/deprecated
Manage User objects in the 'admins' relationship of this particular Team. Starting from the detail URL: GET /:id/admins/ to show users currently in the relationship POST a list of instances to /:id/a…
teams_admins_associate_create 1 param body → 200
POST
/api/gateway/v1/teams/{id}/admins/disassociate/deprecated
Manage User objects in the 'admins' relationship of this particular Team. Starting from the detail URL: GET /:id/admins/ to show users currently in the relationship POST a list of instances to /:id/a…
teams_admins_disassociate_create 1 param body → 200
GET
/api/gateway/v1/teams/{id}/users/deprecated
Manage User objects in the 'users' relationship of this particular Team. Starting from the detail URL: GET /:id/users/ to show users currently in the relationship POST a list of instances to /:id/use…
teams_users_list 51 params → 200
POST
/api/gateway/v1/teams/{id}/users/associate/deprecated
Manage User objects in the 'users' relationship of this particular Team. Starting from the detail URL: GET /:id/users/ to show users currently in the relationship POST a list of instances to /:id/use…
teams_users_associate_create 1 param body → 200
POST
/api/gateway/v1/teams/{id}/users/disassociate/deprecated
Manage User objects in the 'users' relationship of this particular Team. Starting from the detail URL: GET /:id/users/ to show users currently in the relationship POST a list of instances to /:id/use…
teams_users_disassociate_create 1 param body → 200
tokens 6
GET
/api/gateway/v1/tokens/
tokens_list 45 params → 200
POST
/api/gateway/v1/tokens/
tokens_create body → 201
GET
/api/gateway/v1/tokens/{id}/
tokens_retrieve 1 param → 200
PUT
/api/gateway/v1/tokens/{id}/
tokens_update 1 param body → 200
PATCH
/api/gateway/v1/tokens/{id}/
tokens_partial_update 1 param body → 200
DELETE
/api/gateway/v1/tokens/{id}/
tokens_destroy 1 param → 204
trigger_definition 1
GET
/api/gateway/v1/trigger_definition/
trigger_definition_retrieve → 200
ui_auth 1
GET
/api/gateway/v1/ui_auth/
Get UI authentication configuration including available authenticators and settings.
ui_auth_retrieve → 200
ui_plugin_routes 6
GET
/api/gateway/v1/ui_plugin_routes/
API endpoint that allows service plugin routes to be viewed or edited.
ui_plugin_routes_list 64 params → 200
POST
/api/gateway/v1/ui_plugin_routes/
API endpoint that allows service plugin routes to be viewed or edited.
ui_plugin_routes_create body → 201
GET
/api/gateway/v1/ui_plugin_routes/{id}/
API endpoint that allows service plugin routes to be viewed or edited.
ui_plugin_routes_retrieve 1 param → 200
PUT
/api/gateway/v1/ui_plugin_routes/{id}/
API endpoint that allows service plugin routes to be viewed or edited.
ui_plugin_routes_update 1 param body → 200
PATCH
/api/gateway/v1/ui_plugin_routes/{id}/
API endpoint that allows service plugin routes to be viewed or edited.
ui_plugin_routes_partial_update 1 param body → 200
DELETE
/api/gateway/v1/ui_plugin_routes/{id}/
API endpoint that allows service plugin routes to be viewed or edited.
ui_plugin_routes_destroy 1 param → 204
users 12
GET
/api/gateway/v1/users/
API endpoint that allows users to be viewed or edited.
users_list 50 params → 200
POST
/api/gateway/v1/users/
API endpoint that allows users to be viewed or edited.
users_create body → 201
GET
/api/gateway/v1/users/{id}/
API endpoint that allows users to be viewed or edited.
users_retrieve 1 param → 200
PUT
/api/gateway/v1/users/{id}/
API endpoint that allows users to be viewed or edited.
users_update 1 param body → 200
PATCH
/api/gateway/v1/users/{id}/
API endpoint that allows users to be viewed or edited.
users_partial_update 1 param body → 200
DELETE
/api/gateway/v1/users/{id}/
API endpoint that allows users to be viewed or edited.
users_destroy 1 param → 204
GET
/api/gateway/v1/users/{id}/authenticators/
API endpoint that allows users to be viewed or edited.
users_authenticators_retrieve 1 param → 200
GET
/api/gateway/v1/users/{id}/authorized_tokens/
API endpoint that allows users to be viewed or edited.
users_authorized_tokens_retrieve 1 param → 200
GET
/api/gateway/v1/users/{id}/organizations/deprecated
Update the corresponding resource in each service.
users_organizations_list 8 params → 200
GET
/api/gateway/v1/users/{id}/personal_tokens/
API endpoint that allows users to be viewed or edited.
users_personal_tokens_retrieve 1 param → 200
GET
/api/gateway/v1/users/{id}/teams/deprecated
Update the corresponding resource in each service.
users_teams_list 8 params → 200
GET
/api/gateway/v1/users/{id}/tokens/
API endpoint that allows users to be viewed or edited.
users_tokens_retrieve 1 param → 200
role_metadata 1
GET
/role_metadata/
General data about models and permissions tracked by django-ansible-base RBAC Information from this endpoint should be static given a server version. This reflects model definitions, registrations wi…
role_metadata_retrieve → 200

Schemas 121

The contract defines 121 schemas that model the data the API accepts and returns. The most detailed are SettingSection (42 properties), ServiceCluster (27 properties), PatchedServiceCluster (27 properties), PatchedServiceAPIRoute (26 properties). Each schema is shown below with its type and property counts.

AdditionalRoute
object
Base serializer for route models. Provides common validation logic for routes including: - Gateway authentication validation for internal routes - Mutual TLS (…
24 properties 7 required
AdditionalRouteAssociate
object
Serializer used for adding objects to a many-to-many relationship
1 property 1 required
AdditionalRouteDisassociate
object
Serializer used for removing objects that are currently associated via a many-to-many relationship
1 property 1 required
AppUrl
object
10 properties 1 required
Authenticator
object
17 properties 3 required
AuthenticatorAssociate
object
Serializer used for adding objects to a many-to-many relationship
1 property 1 required
AuthenticatorDisassociate
object
Serializer used for removing objects that are currently associated via a many-to-many relationship
1 property 1 required
AuthenticatorMap
object
17 properties 3 required
AuthenticatorUpdate
object
Specialized serializer for update operations that makes type field read-only.
17 properties 2 required
AuthenticatorUser
object
12 properties 3 required
AuthenticatorUserMove
object
6 properties 4 required
CACertificate
object
12 properties 3 required
ClusterInfo
object
15 properties
DABContentType
object
6 properties 2 required
DABPermission
object
4 properties 2 required
Entry
object
14 properties 2 required
FeatureFlag
object
Serialize list of feature flags
20 properties
FeatureFlagPatch
object
1 property
FeatureFlagStates
object
Serialize list of feature flags
2 properties 1 required
GatewayRoleDefinition
object
Custom serializer with Gateway-specific validation Generated by Claude Sonnet 4
13 properties 2 required
GatewayRoleTeamAssignment
object
Custom serializer with Galaxy-specific validation for team role assignments Teams can only be assigned roles where all permissions are in the 'galaxy' service.…
12 properties 1 required
HTTPPort
object
12 properties 2 required
OAuth2Application
object
21 properties 4 required
OAuth2Token
object
16 properties
Organization
object
11 properties 1 required
PaginatedAdditionalRouteList
object
4 properties 2 required
PaginatedAppUrlList
object
4 properties 2 required
PaginatedAuthenticatorList
object
4 properties 2 required
PaginatedAuthenticatorMapList
object
4 properties 2 required
PaginatedAuthenticatorUserList
object
4 properties 2 required
PaginatedCACertificateList
object
4 properties 2 required
PaginatedDABContentTypeList
object
4 properties 2 required
PaginatedDABPermissionList
object
4 properties 2 required
PaginatedEntryList
object
4 properties 2 required
PaginatedFeatureFlagList
object
4 properties 2 required
PaginatedFeatureFlagStatesList
object
4 properties 2 required
PaginatedGatewayRoleDefinitionList
object
4 properties 2 required
PaginatedGatewayRoleTeamAssignmentList
object
4 properties 2 required
PaginatedHTTPPortList
object
4 properties 2 required
PaginatedOAuth2ApplicationList
object
4 properties 2 required
PaginatedOAuth2TokenList
object
4 properties 2 required
PaginatedOrganizationList
object
4 properties 2 required
PaginatedResourceListList
object
4 properties 2 required
PaginatedResourceTypeList
object
4 properties 2 required
PaginatedRoleUserAssignmentList
object
4 properties 2 required
PaginatedServiceAPIRouteList
object
4 properties 2 required
PaginatedServiceClusterList
object
4 properties 2 required
PaginatedServiceKeyList
object
4 properties 2 required
PaginatedServiceNodeList
object
4 properties 2 required
PaginatedServiceRoleTeamAssignmentList
object
4 properties 2 required
PaginatedServiceRoleUserAssignmentList
object
4 properties 2 required
PaginatedServiceTypeList
object
4 properties 2 required
PaginatedSettingSectionListList
object
4 properties 2 required
PaginatedTeamAccessAssignmentList
object
4 properties 2 required
PaginatedTeamAccessViewSet_Team_List
object
4 properties 2 required
PaginatedTeamList
object
4 properties 2 required
PaginatedUIPluginRouteList
object
4 properties 2 required
PaginatedUserAccessAssignmentList
object
4 properties 2 required
PaginatedUserAccessViewSet_User_List
object
4 properties 2 required
PaginatedUserList
object
4 properties 2 required
PasswordAuthenticator
object
Serializer for password authenticator items in UI auth response.
1 property
PatchedAdditionalRoute
object
Base serializer for route models. Provides common validation logic for routes including: - Gateway authentication validation for internal routes - Mutual TLS (…
24 properties
PatchedAuthenticatorMap
object
17 properties
PatchedAuthenticatorUpdate
object
Specialized serializer for update operations that makes type field read-only.
17 properties
PatchedCACertificate
object
12 properties
PatchedFeatureFlagPatch
object
1 property
PatchedGatewayRoleDefinition
object
Custom serializer with Gateway-specific validation Generated by Claude Sonnet 4
13 properties
PatchedHTTPPort
object
12 properties
PatchedOAuth2Application
object
21 properties
PatchedOAuth2Token
object
16 properties
PatchedOrganization
object
11 properties
PatchedResource
object
10 properties
PatchedServiceAPIRoute
object
Base serializer for route models. Provides common validation logic for routes including: - Gateway authentication validation for internal routes - Mutual TLS (…
26 properties
PatchedServiceCluster
object
27 properties
PatchedServiceKey
object
15 properties
PatchedServiceNode
object
12 properties
PatchedServiceType
object
13 properties
PatchedTeam
object
Class to be used by apps to check permissions to related objects This is a core part of integrating permission checks with REST APIs. Full enablement of checks…
11 properties
PatchedUIPluginRoute
object
Base serializer for route models. Provides common validation logic for routes including: - Gateway authentication validation for internal routes - Mutual TLS (…
22 properties
PatchedUser
object
Disallows editing of system user and enforces superuser requirement.
21 properties
Ping
object
8 properties
RedisResponse
object
4 properties
Resource
object
10 properties 1 required
ResourceList
object
9 properties
ResourceType
object
5 properties 1 required
RoleDefinitionDetail
object
13 properties 2 required
RoleMetadata
object
1 property 1 required
RoleUserAssignment
object
12 properties 1 required
SSOAuthenticator
object
Serializer for SSO authenticator items in UI auth response.
3 properties
ServiceAPIRoute
object
Base serializer for route models. Provides common validation logic for routes including: - Gateway authentication validation for internal routes - Mutual TLS (…
26 properties 7 required
ServiceCluster
object
27 properties 2 required
ServiceKey
object
15 properties 2 required
ServiceKeysStatus
object
3 properties 2 required
ServiceNode
object
12 properties 3 required
ServiceRoleTeamAssignment
object
7 properties 2 required
ServiceRoleUserAssignment
object
7 properties 2 required
ServiceType
object
13 properties 1 required
ServiceTypeAssociate
object
Serializer used for adding objects to a many-to-many relationship
1 property 1 required
ServiceTypeDisassociate
object
Serializer used for removing objects that are currently associated via a many-to-many relationship
1 property 1 required
SettingPreference
object
3 properties 1 required
SettingSection
object
42 properties
SettingSectionList
object
Serialize list of settings category
2 properties
Status
object
3 properties 2 required
StatusNode
object
16 properties
StatusResponseOptions
StatusService
object
4 properties 1 required
Team
object
Class to be used by apps to check permissions to related objects This is a core part of integrating permission checks with REST APIs. Full enablement of checks…
11 properties 2 required
TeamAccessAssignment
object
12 properties 1 required
TeamAccessViewSet_Team_
object
6 properties 2 required
UIAuthResponse
object
Serializer for UI authentication configuration response.
7 properties
UIPluginRoute
object
Base serializer for route models. Provides common validation logic for routes including: - Gateway authentication validation for internal routes - Mutual TLS (…
22 properties 6 required
User
object
Disallows editing of system user and enforces superuser requirement.
21 properties 1 required
UserAccessAssignment
object
13 properties 1 required
UserAccessViewSet_User_
object
controller uses auth.User model so this needs to be as compatible as possible, thus ModelSerializer
8 properties 1 required
UserAssociate
object
Serializer used for adding objects to a many-to-many relationship
1 property 1 required
UserDisassociate
object
Serializer used for removing objects that are currently associated via a many-to-many relationship
1 property 1 required
api_gateway_root_view
object
2 properties 2 required
api_root_view
object
2 properties 2 required
session_view
object
3 properties 3 required
session_view_404
object
1 property 1 required
session_view_post
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-ansible-automation-platform-platform-gateway-openapi.json Raw ↑

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

Red Hat Ansible Automation Controller API
AE Profile APIs.io
Red Hat Ansible Private Automation Hub API
AE Profile APIs.io
Red Hat Event-Driven Ansible Controller API
AE Profile APIs.io
Red Hat Automation Services Catalog API
AE Profile APIs.io
Red Hat Ansible Lightspeed with IBM watsonx Code Assistant API
AE Profile APIs.io
Red Hat Automation Hub API (Hybrid Cloud Console)
AE Profile APIs.io
#Gateway#Identity#RBAC#REST
← Back to R APIs
API Details
ID
red-hat-ansible-automation-platform:platform-gateway-api
Base URL
https://gateway-host/api/gateway/v1/
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=platform-gateway-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/platform-gateway-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 Gateway 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.