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.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/platform-gateway-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
{
"openapi": "3.0.3",
"info": {
"title": "AAP gateway API",
"version": "v1",
"description": "AAP gateway API"
},
"paths": {
"/api/": {
"get": {
"operationId": "api_retrieve",
"tags": [
"api"
],
"security": [
{
"OAuth2_Authentication": []
},
{
"SessionAuthentication": []
},
{
"Basic_Authentication": []
},
{}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api_root_view"
}
}
},
"description": ""
}
},
"x-ai-description": "Retrieve single api"
}
},
"/api/gateway/": {
"get": {
"operationId": "api_gateway_retrieve",
"tags": [
"api"
],
"security": [
{
"OAuth2_Authentication": []
},
{
"SessionAuthentication": []
},
{
"Basic_Authentication": []
},
{}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api_gateway_root_view"
}
}
},
"description": ""
}
},
"x-ai-description": "Retrieve single api gateway"
}
},
"/api/gateway/v1/": {
"get": {
"operationId": "root_retrieve",
"description": "This responds to GET requests made to it with a sorted list of available API endpoints",
"security": [
{
"OAuth2_Authentication": []
},
{
"SessionAuthentication": []
},
{
"Basic_Authentication": []
},
{}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
}
},
"description": ""
}
},
"x-ai-description": "Retrieve single root"
}
},
"/api/gateway/v1/activitystream/": {
"get": {
"operationId": "activitystream_list",
"description": "API endpoint that allows for read-only access to activity stream entries.",
"parameters": [
{
"in": "query",
"name": "order",
"schema": {
"type": "string"
},
"description": "Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields."
},
{
"in": "query",
"name": "order_by",
"schema": {
"type": "string"
},
"description": "Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields."
},
{
"name": "page",
"required": false,
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "page_size",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "A search term.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string"
},
"description": "Filter by object type. Supports comma-separated values for multiple types."
}
],
"tags": [
"activitystream"
],
"security": [
{
"OAuth2_Authentication": []
},
{
"SessionAuthentication": []
},
{
"Basic_Authentication": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedEntryList"
}
}
},
"description": ""
}
},
"x-ai-description": "List audit trail entries for tracking system changes and user actions"
}
},
"/api/gateway/v1/activitystream/{id}/": {
"get": {
"operationId": "activitystream_retrieve",
"description": "API endpoint that allows for read-only access to activity stream entries.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this entry.",
"required": true
}
],
"tags": [
"activitystream"
],
"security": [
{
"OAuth2_Authentication": []
},
{
"SessionAuthentication": []
},
{
"Basic_Authentication": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Entry"
}
}
},
"description": ""
}
},
"x-ai-description": "Retrieve a audit trail entry for tracking system changes and user actions"
}
},
"/api/gateway/v1/app_urls/": {
"get": {
"operationId": "app_urls_list",
"description": "API endpoint that allows oauth apps to be listed for name and app_url",
"parameters": [
{
"in": "query",
"name": "order",
"schema": {
"type": "string"
},
"description": "Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields."
},
{
"in": "query",
"name": "order_by",
"schema": {
"type": "string"
},
"description": "Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields."
},
{
"name": "page",
"required": false,
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "page_size",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "role_level",
"schema": {
"type": "string"
},
"description": "Filter by role level for RBAC"
},
{
"name": "search",
"required": false,
"in": "query",
"description": "A search term.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string"
},
"description": "Filter by object type. Supports comma-separated values for multiple types."
}
],
"tags": [
"app_urls"
],
"security": [
{
"OAuth2_Authentication": []
},
{
"SessionAuthentication": []
},
{
"Basic_Authentication": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedAppUrlList"
}
}
},
"description": ""
}
},
"x-ai-description": "List all app urls"
}
},
"/api/gateway/v1/applications/": {
"get": {
"operationId": "applications_list",
"parameters": [
{
"in": "query",
"name": "algorithm",
"schema": {
"type": "string"
},
"description": "Filter by algorithm (exact match)"
},
{
"in": "query",
"name": "algorithm__icontains",
"schema": {
"type": "string"
},
"description": "Filter by algorithm (case-insensitive partial match)"
},
{
"in": "query",
"name": "app_url",
"schema": {
"type": "string"
},
"description": "Filter by app_url (exact match)"
},
{
"in": "query",
"name": "app_url__icontains",
"schema": {
"type": "string"
},
"description": "Filter by app_url (case-insensitive partial match)"
},
{
"in": "query",
"name": "authorization_grant_type",
"schema": {
"type": "string"
},
"description": "Filter by authorization_grant_type (exact match)"
},
{
"in": "query",
"name": "authorization_grant_type__icontains",
"schema": {
"type": "string"
},
"description": "Filter by authorization_grant_type (case-insensitive partial match)"
},
{
"in": "query",
"name": "client_id",
"schema": {
"type": "string"
},
"description": "Filter by client_id (exact match)"
},
{
"in": "query",
"name": "client_id__icontains",
"schema": {
"type": "string"
},
"description": "Filter by client_id (case-insensitive partial match)"
},
{
"in": "query",
"name": "client_secret",
"schema": {
"type": "string"
},
"description": "Filter by client_secret (exact match)"
},
{
"in": "query",
"name": "client_secret__icontains",
"schema": {
"type": "string"
},
"description": "Filter by client_secret (case-insensitive partial match)"
},
{
"in": "query",
"name": "client_type",
"schema": {
"type": "string"
},
"description": "Filter by client_type (exact match)"
},
{
"in": "query",
"name": "client_type__icontains",
"schema": {
"type": "string"
},
"description": "Filter by client_type (case-insensitive partial match)"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "string"
},
"description": "Filter by created (exact match)"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "string"
},
"description": "Filter by created (gt)"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "string"
},
"description": "Filter by created (gte)"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "string"
},
"description": "Filter by created (lt)"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "string"
},
"description": "Filter by created (lte)"
},
{
"in": "query",
"name": "created_by",
"schema": {
"type": "string"
},
"description": "Filter by created_by (exact match)"
},
{
"in": "query",
"name": "description",
"schema": {
"type": "string"
},
"description": "Filter by description (exact match)"
},
{
"in": "query",
"name": "description__icontains",
"schema": {
"type": "string"
},
"description": "Filter by description (case-insensitive partial match)"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "string"
},
"description": "Filter by id (exact match)"
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "string"
},
"description": "Filter by id (gt)"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "string"
},
"description": "Filter by id (gte)"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "string"
},
"description": "Filter by id (lt)"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "string"
},
"description": "Filter by id (lte)"
},
{
"in": "query",
"name": "modified",
"schema": {
"type": "string"
},
"description": "Filter by modified (exact match)"
},
{
"in": "query",
"name": "modified__gt",
"schema": {
"type": "string"
},
"description": "Filter by modified (gt)"
},
{
"in": "query",
"name": "modified__gte",
"schema": {
"type": "string"
},
"description": "Filter by modified (gte)"
},
{
"in": "query",
"name": "modified__lt",
"schema": {
"type": "string"
},
"description": "Filter by modified (lt)"
},
{
"in": "query",
"name": "modified__lte",
"schema": {
"type": "string"
},
"description": "Filter by modified (lte)"
},
{
"in": "query",
"name": "modified_by",
"schema": {
"type": "string"
},
"description": "Filter by modified_by (exact match)"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "string"
},
"description": "Filter by name (exact match)"
},
{
"in": "query",
"name": "name__icontains",
"schema": {
"type": "string"
},
"description": "Filter by name (case-insensitive partial match)"
},
{
"in": "query",
"name": "order",
"schema": {
"type": "string"
},
"description": "Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields."
},
{
"in": "query",
"name": "order_by",
"schema": {
"type": "string"
},
"description": "Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields."
},
{
"in": "query",
"name": "organization",
"schema": {
"type": "string"
},
"description": "Filter by organization (exact match)"
},
{
"name": "page",
"required": false,
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"name": "page_size",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "post_logout_redirect_uris",
"schema": {
"type": "string"
},
"description": "Filter by post_logout_redirect_uris (exact match)"
},
{
"in": "query",
"name": "post_logout_redirect_uris__icontains",
"schema": {
"type": "string"
},
"description": "Filter by post_logout_redirect_uris (case-insensitive partial match)"
},
{
"in": "query",
"name": "redirect_uris",
"schema": {
"type": "string"
},
"description": "Filter by redirect_uris (exact match)"
},
{
"in": "query",
"name": "redirect_uris__icontains",
"schema": {
"type": "string"
},
"description": "Filter by redirect_uris (case-insensitive partial match)"
},
{
"in": "query",
"name": "role_level",
"schema": {
"type": "string"
},
"description": "Filter by role level for RBAC"
},
{
"name": "search",
"required": false,
"in": "query",
"description": "A search term.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "skip_authorization",
"schema": {
"type": "string"
},
"description": "Filter by skip_authorization (exact match)"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string"
},
"description": "Filter by object type. Supports comma-separated values for multiple types."
},
{
"in": "query",
"name": "user",
"schema": {
"type": "string"
},
"description": "Filter by user (exact match)"
}
],
"tags": [
"applications"
],
"security": [
{
"OAuth2_Authentication": []
},
{
"SessionAuthentication": []
},
{
"Basic_Authentication": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedOAuth2ApplicationList"
}
}
},
"description": ""
}
},
"x-ai-description": "List all applications"
},
"post": {
"operationId": "applications_create",
"tags": [
"applications"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OAuth2Application"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/OAuth2Application"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/OAuth2Application"
}
}
},
"required": true
},
"security": [
{
"OAuth2_Authentication": []
},
{
"SessionAuthentication": []
},
{
"Basic_Authentication": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OAuth2Application"
}
}
},
"description": ""
}
},
"x-ai-description": "Create new application"
}
},
"/api/gateway/v1/applications/{id}/": {
"get": {
"operationId": "applications_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this application.",
"required": true
}
],
"tags": [
"applications"
],
"security": [
{
"OAuth2_Authentication": []
},
{
"SessionAuthentication": []
},
{
"Basic_Authentication": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OAuth2Application"
}
}
},
"description": ""
}
},
"x-ai-description": "Retrieve single application"
},
"put": {
"operationId": "applications_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this application.",
"required": true
}
],
"tags": [
"applications"
],
"requestBody": {
"content": {
"application/json": {
"s
# --- truncated at 32 KB (1241 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/red-hat-ansible-automation-platform/refs/heads/main/openapi/red-hat-ansible-automation-platform-platform-gateway-openapi.json