Red Hat Event-Driven Ansible Controller API

REST API for the Event-Driven Ansible Controller enabling management of event sources, rulebook activations, decision environments, and automated response workflows for infrastructure and application events.

Operations 120

GET /activation-instances/ #
GET /activation-instances/{id}/logs/ #
GET /activation-instances/{id}/ #
GET /activations/ #
POST /activations/ #
GET /activations/{id}/instances/ #
GET /activations/{id}/ #
PATCH /activations/{id}/ #
DELETE /activations/{id}/ #
POST /activations/{id}/copy/ #
POST /activations/{id}/disable/ #
POST /activations/{id}/enable/ #
POST /activations/{id}/restart/ #
GET /audit-rules/ #
GET /audit-rules/{id}/actions/ #
GET /audit-rules/{id}/events/ #
GET /audit-rules/{id}/ #
GET /auth/session/login/ #
POST /auth/session/login/ #
POST /auth/session/logout/ #
POST /auth/token/refresh/ #
GET /config/ #
GET /credential-input-sources/ #
POST /credential-input-sources/ #
GET /credential-input-sources/{id}/ #
PATCH /credential-input-sources/{id}/ #
DELETE /credential-input-sources/{id}/ #
GET /credential-types/ #
POST /credential-types/ #
GET /credential-types/{id}/ #
PATCH /credential-types/{id}/ #
DELETE /credential-types/{id}/ #
POST /credential-types/{id}/test/ #
GET /decision-environments/ #
POST /decision-environments/ #
GET /decision-environments/{id}/ #
PATCH /decision-environments/{id}/ #
DELETE /decision-environments/{id}/ #
GET /eda-credentials/ #
POST /eda-credentials/ #
GET /eda-credentials/{id}/input_sources/ #
GET /eda-credentials/{id}/ #
PATCH /eda-credentials/{id}/ #
DELETE /eda-credentials/{id}/ #
POST /eda-credentials/{id}/copy/ #
POST /eda-credentials/{id}/test/ #
GET /event-streams/ #
POST /event-streams/ #
GET /event-streams/{id}/activations/ #
GET /event-streams/{id}/ #
PATCH /event-streams/{id}/ #
DELETE /event-streams/{id}/ #
GET /feature_flags/states/ #
GET /feature_flags/states/{id}/ #
GET /feature_flags_state/ #
GET /organizations/ #
GET /organizations/{id}/teams/ #
GET /organizations/{id}/ #
GET /projects/ #
POST /projects/ #
GET /projects/{id}/ #
PATCH /projects/{id}/ #
DELETE /projects/{id}/ #
POST /projects/{id}/sync/ #
GET /role_definitions/ #
POST /role_definitions/ #
GET /role_definitions/{id}/ #
PUT /role_definitions/{id}/ #
PATCH /role_definitions/{id}/ #
DELETE /role_definitions/{id}/ #
GET /role_definitions/{id}/team_assignments/ #
GET /role_definitions/{id}/user_assignments/ #
GET /role_metadata/ #
GET /role_team_access/{model_name}/{id}/ #
GET /role_team_access/{model_name}/{id}/{actor_pk}/ #
GET /role_team_assignments/ #
POST /role_team_assignments/ #
GET /role_team_assignments/{id}/ #
DELETE /role_team_assignments/{id}/ #
GET /role_user_access/{model_name}/{id}/ #
GET /role_user_access/{model_name}/{id}/{actor_pk}/ #
GET /role_user_assignments/ #
POST /role_user_assignments/ #
GET /role_user_assignments/{id}/ #
DELETE /role_user_assignments/{id}/ #
GET /rulebooks/ #
GET /rulebooks/{id}/sources/ #
GET /rulebooks/{id}/ #
GET /rulebooks/{id}/json/ #
GET /service-index/ #
GET /service-index/metadata/ #
POST /service-index/object-delete/ #
GET /service-index/resource-types/ #
GET /service-index/resource-types/{name}/ #
GET /service-index/resource-types/{name}/manifest/ #
GET /service-index/resources/ #
POST /service-index/resources/ #
GET /service-index/resources/{ansible_id}/ #
PUT /service-index/resources/{ansible_id}/ #
PATCH /service-index/resources/{ansible_id}/ #
DELETE /service-index/resources/{ansible_id}/ #
GET /service-index/role-permissions/ #
GET /service-index/role-team-assignments/ #
POST /service-index/role-team-assignments/assign/ #
POST /service-index/role-team-assignments/unassign/ #
GET /service-index/role-types/ #
GET /service-index/role-user-assignments/ #
POST /service-index/role-user-assignments/assign/ #
POST /service-index/role-user-assignments/unassign/ #
GET /status/ #
GET /teams/ #
GET /teams/{id}/ #
GET /users/ #
GET /users/{id}/ #
PATCH /users/{id}/ #
GET /users/me/ #
GET /users/me/awx-tokens/ #
POST /users/me/awx-tokens/ #
GET /users/me/awx-tokens/{id}/ #
DELETE /users/me/awx-tokens/{id}/ #

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/eda-controller-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

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

OpenAPI Specification

red-hat-ansible-automation-platform-event-driven-ansible-openapi.json Raw ↑
{
    "openapi": "3.0.3",
    "info": {
        "title": "Event Driven Ansible API",
        "version": "0.2.0"
    },
    "paths": {
        "/activation-instances/": {
            "get": {
                "operationId": "activation_instances_list",
                "description": "List Activation Instances",
                "parameters": [
                    {
                        "in": "query",
                        "name": "name",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by activation instance name."
                    },
                    {
                        "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": "status",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by activation instance status."
                    }
                ],
                "tags": [
                    "activation-instances"
                ],
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/PaginatedActivationInstanceList"
                                }
                            }
                        },
                        "description": ""
                    }
                },
                "x-ai-description": "List activation instances. Returns status, queue, and start/end times. Supports filtering and pagination."
            }
        },
        "/activation-instances/{id}/logs/": {
            "get": {
                "operationId": "activation_instances_logs_list",
                "description": "List Activation instance logs",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "schema": {
                            "type": "integer"
                        },
                        "description": "A unique integer value identifying this Activation Instance.",
                        "required": true
                    },
                    {
                        "in": "query",
                        "name": "log",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by activation instance log."
                    },
                    {
                        "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"
                        }
                    }
                ],
                "tags": [
                    "activation-instances"
                ],
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/PaginatedActivationInstanceLogList"
                                }
                            }
                        },
                        "description": ""
                    }
                },
                "x-ai-description": "List logs for an activation instance by ID. Returns log records with timestamps and levels. Supports filtering and pagination."
            }
        },
        "/activation-instances/{id}/": {
            "get": {
                "operationId": "activation_instances_retrieve",
                "description": "Get the Activation Instance by its id",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "schema": {
                            "type": "integer"
                        },
                        "description": "A unique integer value identifying this rulebook process.",
                        "required": true
                    }
                ],
                "tags": [
                    "activation-instances"
                ],
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ActivationInstance"
                                }
                            }
                        },
                        "description": ""
                    }
                }
            }
        },
        "/activations/": {
            "get": {
                "operationId": "activations_list",
                "description": "List Activations",
                "parameters": [
                    {
                        "in": "query",
                        "name": "decision_environment_id",
                        "schema": {
                            "type": "number"
                        },
                        "description": "Filter by Decision Environment ID."
                    },
                    {
                        "in": "query",
                        "name": "name",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by activation name."
                    },
                    {
                        "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": "project_id",
                        "schema": {
                            "type": "number"
                        },
                        "description": "Filter by project id"
                    },
                    {
                        "in": "query",
                        "name": "status",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by activation status."
                    }
                ],
                "tags": [
                    "activations"
                ],
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/PaginatedActivationListList"
                                }
                            }
                        },
                        "description": "Return a list of Activations."
                    }
                },
                "x-ai-description": "List activations. Returns activation records. Supports filtering and pagination."
            },
            "post": {
                "operationId": "activations_create",
                "tags": [
                    "activations"
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ActivationCreate"
                            }
                        },
                        "application/x-www-form-urlencoded": {
                            "schema": {
                                "$ref": "#/components/schemas/ActivationCreate"
                            }
                        },
                        "multipart/form-data": {
                            "schema": {
                                "$ref": "#/components/schemas/ActivationCreate"
                            }
                        }
                    },
                    "required": true
                },
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "201": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ActivationRead"
                                }
                            }
                        },
                        "description": ""
                    },
                    "400": {
                        "description": "Invalid data to create activation."
                    },
                    "503": {
                        "description": "Dependent service issues"
                    }
                },
                "x-ai-description": "Create an activation. Returns the created activation."
            }
        },
        "/activations/{id}/instances/": {
            "get": {
                "operationId": "activations_instances_list",
                "description": "List all instances for the Activation",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "schema": {
                            "type": "integer"
                        },
                        "description": "A unique integer value identifying this rulebook.",
                        "required": true
                    },
                    {
                        "in": "query",
                        "name": "name",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by activation instance name."
                    },
                    {
                        "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": "status",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by activation instance status."
                    }
                ],
                "tags": [
                    "activations"
                ],
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/PaginatedActivationInstanceList"
                                }
                            }
                        },
                        "description": ""
                    }
                }
            }
        },
        "/activations/{id}/": {
            "get": {
                "operationId": "activations_retrieve",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "schema": {
                            "type": "integer"
                        },
                        "description": "A unique integer value identifying this activation.",
                        "required": true
                    }
                ],
                "tags": [
                    "activations"
                ],
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ActivationRead"
                                }
                            }
                        },
                        "description": ""
                    }
                }
            },
            "patch": {
                "operationId": "activations_partial_update",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "schema": {
                            "type": "integer"
                        },
                        "description": "A unique integer value identifying this activation.",
                        "required": true
                    }
                ],
                "tags": [
                    "activations"
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/PatchedActivationUpdate"
                            }
                        },
                        "application/x-www-form-urlencoded": {
                            "schema": {
                                "$ref": "#/components/schemas/PatchedActivationUpdate"
                            }
                        },
                        "multipart/form-data": {
                            "schema": {
                                "$ref": "#/components/schemas/PatchedActivationUpdate"
                            }
                        }
                    }
                },
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ActivationRead"
                                }
                            }
                        },
                        "description": ""
                    },
                    "400": {
                        "description": "Invalid data to update activation."
                    },
                    "409": {
                        "description": "The activation is not allowed to be updated."
                    }
                },
                "x-ai-description": "Update an activation by ID. Returns the updated activation."
            },
            "delete": {
                "operationId": "activations_destroy",
                "description": "Delete an existing Activation",
                "parameters": [
                    {
                        "in": "query",
                        "name": "force",
                        "schema": {
                            "type": "boolean"
                        },
                        "description": "Force delete after worker node offline"
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "schema": {
                            "type": "integer"
                        },
                        "description": "A unique integer value identifying this activation.",
                        "required": true
                    }
                ],
                "tags": [
                    "activations"
                ],
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "204": {
                        "description": "The Activation has been deleted."
                    },
                    "409": {
                        "description": "Activation blocked while Workers offline."
                    }
                }
            }
        },
        "/activations/{id}/copy/": {
            "post": {
                "operationId": "activations_copy_create",
                "description": "Copy an activation.",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "schema": {
                            "type": "integer"
                        },
                        "description": "A unique integer value identifying this activation.",
                        "required": true
                    }
                ],
                "tags": [
                    "activations"
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ActivationCopy"
                            }
                        },
                        "application/x-www-form-urlencoded": {
                            "schema": {
                                "$ref": "#/components/schemas/ActivationCopy"
                            }
                        },
                        "multipart/form-data": {
                            "schema": {
                                "$ref": "#/components/schemas/ActivationCopy"
                            }
                        }
                    },
                    "required": true
                },
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "201": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ActivationRead"
                                }
                            }
                        },
                        "description": "Return the copied activation."
                    },
                    "404": {
                        "description": "Activation not found."
                    }
                }
            }
        },
        "/activations/{id}/disable/": {
            "post": {
                "operationId": "activations_disable_create",
                "description": "Disable the Activation",
                "parameters": [
                    {
                        "in": "query",
                        "name": "force",
                        "schema": {
                            "type": "boolean"
                        },
                        "description": "Force disable after worker node offline"
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "schema": {
                            "type": "integer"
                        },
                        "description": "A unique integer value identifying this activation.",
                        "required": true
                    }
                ],
                "tags": [
                    "activations"
                ],
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Activation has been disabled."
                    },
                    "409": {
                        "description": "Activation blocked while Workers offline."
                    }
                },
                "x-ai-description": "Disable an activation by ID. Stops the rulebook process if running."
            }
        },
        "/activations/{id}/enable/": {
            "post": {
                "operationId": "activations_enable_create",
                "description": "Enable the Activation",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "schema": {
                            "type": "integer"
                        },
                        "description": "A unique integer value identifying this activation.",
                        "required": true
                    }
                ],
                "tags": [
                    "activations"
                ],
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Activation has been enabled."
                    },
                    "400": {
                        "description": "Activation not enabled."
                    },
                    "409": {
                        "description": "Processing of enable is disallowed."
                    }
                },
                "x-ai-description": "Enable an activation by ID. Starts the rulebook process if valid."
            }
        },
        "/activations/{id}/restart/": {
            "post": {
                "operationId": "activations_restart_create",
                "description": "Restart the Activation",
                "parameters": [
                    {
                        "in": "query",
                        "name": "force",
                        "schema": {
                            "type": "boolean"
                        },
                        "description": "Force restart after worker node offline"
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "schema": {
                            "type": "integer"
                        },
                        "description": "A unique integer value identifying this activation.",
                        "required": true
                    }
                ],
                "tags": [
                    "activations"
                ],
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "204": {
                        "description": "Activation restart was successful."
                    },
                    "400": {
                        "description": "Activation not enabled."
                    },
                    "409": {
                        "description": "Activation blocked while Workers offline."
                    }
                }
            }
        },
        "/audit-rules/": {
            "get": {
                "operationId": "audit_rules_list",
                "description": "List all fired rules",
                "parameters": [
                    {
                        "in": "query",
                        "name": "activation_instance_id",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by activation_instance_id"
                    },
                    {
                        "in": "query",
                        "name": "created_at",
                        "schema": {
                            "type": "string",
                            "format": "date-time"
                        },
                        "description": "Filter by created_at"
                    },
                    {
                        "in": "query",
                        "name": "fired_at",
                        "schema": {
                            "type": "string",
                            "format": "date-time"
                        },
                        "description": "Filter by fired_at"
                    },
                    {
                        "in": "query",
                        "name": "id",
                        "schema": {
                            "type": "number"
                        },
                        "description": "Filter by id"
                    },
                    {
                        "in": "query",
                        "name": "job_instance_id",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by job_instance_id"
                    },
                    {
                        "in": "query",
                        "name": "name",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by name"
                    },
                    {
                        "in": "query",
                        "name": "organization_id",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by organization_id"
                    },
                    {
                        "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": "rule_uuid",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by rule_uuid"
                    },
                    {
                        "in": "query",
                        "name": "ruleset_name",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by ruleset_name"
                    },
                    {
                        "in": "query",
                        "name": "ruleset_uuid",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by ruleset_uuid"
                    },
                    {
                        "name": "search",
                        "required": false,
                        "in": "query",
                        "description": "A search term.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "in": "query",
                        "name": "status",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by status"
                    }
                ],
                "tags": [
                    "audit-rules"
                ],
                "security": [
                    {
                        "EDAJWTAuthentication": []
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/PaginatedAuditRuleListList"
                                }
                            }
                        },
                        "description": "Return a list of fired rules."
                    }
                },
                "x-ai-description": "List fired audit rules. Returns audit rule records. Supports filtering and pagination."
            }
        },
        "/audit-rules/{id}/actions/": {
            "get": {
                "operationId": "audit_rules_actions_list",
                "description": "Action list of a fired rule by its id",
                "parameters": [
                    {
                        "in": "query",
                        "name": "audit_rule_id",
                        "schema": {
                            "type": "string"
                        },
                        "description": "Filter by audit_rule_id"
                    },
                    {
                        "in": "query",
                        "name": "fired_at",
                        "schema": {
                            "type": "string",
                            "format": "date-time"
                        },
                        "description": "Filter by fired_at"
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "schema": {
                            "type": "integer"
                        },
                        "description": "A unique integer value identifying this rule audit.",
                        "required": true
                    },
                    {
                        "in": "query",
                        "name": "id",
                        "schema": {
                            "type": "string

# --- truncated at 32 KB (426 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/red-hat-ansible-automation-platform/refs/heads/main/openapi/red-hat-ansible-automation-platform-event-driven-ansible-openapi.json