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.
Red Hat Event-Driven Ansible Controller 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 EDA, Event-Driven, REST, and Rulebooks. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.
This API exposes
120 operations
across 83 paths,
organized into 25 resource areas,
and defines 116 schemas.
It is described by OpenAPI 3.0.3, at version 0.2.0.
Requests are made against a single base URL, /api/eda/v1.
120 operations83 paths116 schemas12 DELETE68 GET10 PATCH28 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.3
API Version
0.2.0
Base URL
https://eda-host/api/eda/v1/
Authentication
API Key, API Key
Resource Areas
25
Authentication & Security 2
Red Hat Event-Driven Ansible Controller API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-DAB-JW-TOKEN (EDAJWTAuthentication).
An API key is passed in the cookie as sessionid (cookieAuth).
Paths & Operations 120
Across 83 paths, the API surfaces 120 operations — 12 DELETE, 68 GET, 10 PATCH, 28 POST, 2 PUT. They span 25 resource areas, including activation-instances, activations, audit-rules, auth, config, credential-input-sources, credential-types, decision-environments, and 17 more. Each is listed below with its method, path, parameters, and response codes.
The CredentialInputSourceViewSet is used to link fields to external SMS. When the linkage happens we need the Source, Target credential and the field name
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_list3 params→ 200
GET
/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_retrieve1 param→ 200
feature_flags_state 1
GET
/feature_flags_state/
A view class for displaying feature flags
feature_flags_state_retrieve→ 200
organizations 3
GET
/organizations/
List all organizations.
organizations_list5 params→ 200
GET
/organizations/{id}/teams/
List all teams of the organization
organizations_teams_list6 params→ 200
GET
/organizations/{id}/
organizations_retrieve1 param→ 200
projects 6
GET
/projects/
List all projects
projects_list4 params→ 200
POST
/projects/
Import a project.
projects_createbody→ 201503
GET
/projects/{id}/
Get a project by id
projects_retrieve1 param→ 200
PATCH
/projects/{id}/
Partial update of a project
projects_partial_update1 parambody→ 200400409503
DELETE
/projects/{id}/
Delete a project by id
projects_destroy1 param→ 204
POST
/projects/{id}/sync/
Sync a project
projects_sync_create1 param→ 202409503
role_definitions 8
GET
/role_definitions/
Role Definitions (roles) contain a list of permissions and can be used to assign those permissions to a user or team through the respective assignment endpoints. Custom roles can be created, modified…
role_definitions_list3 params→ 200
POST
/role_definitions/
Create a RoleDefinition.
role_definitions_createbody→ 201
GET
/role_definitions/{id}/
Role Definitions (roles) contain a list of permissions and can be used to assign those permissions to a user or team through the respective assignment endpoints. Custom roles can be created, modified…
role_definitions_retrieve1 param→ 200
PUT
/role_definitions/{id}/
Update a RoleDefinition.
role_definitions_update1 parambody→ 200
PATCH
/role_definitions/{id}/
Role Definitions (roles) contain a list of permissions and can be used to assign those permissions to a user or team through the respective assignment endpoints. Custom roles can be created, modified…
role_definitions_partial_update1 parambody→ 200
DELETE
/role_definitions/{id}/
Role Definitions (roles) contain a list of permissions and can be used to assign those permissions to a user or team through the respective assignment endpoints. Custom roles can be created, modified…
role_definitions_destroy1 param→ 204
GET
/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…
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…
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
role_team_access 2
GET
/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_list5 params→ 200
GET
/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_26 params→ 200
role_team_assignments 4
GET
/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_list3 params→ 200
POST
/role_team_assignments/
Create a RoleTeamAssignment.
role_team_assignments_createbody→ 201
GET
/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_retrieve1 param→ 200
DELETE
/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_destroy1 param→ 204
role_user_access 2
GET
/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_list5 params→ 200
GET
/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_26 params→ 200
role_user_assignments 4
GET
/role_user_assignments/
role_user_assignments_list3 params→ 200
POST
/role_user_assignments/
Create a RoleUserAssignment.
role_user_assignments_createbody→ 201
GET
/role_user_assignments/{id}/
role_user_assignments_retrieve1 param→ 200
DELETE
/role_user_assignments/{id}/
role_user_assignments_destroy1 param→ 204
rulebooks 4
GET
/rulebooks/
List rulebooks
rulebooks_list4 params→ 200
GET
/rulebooks/{id}/sources/
List rulebook sources
rulebooks_sources_list5 params→ 200400
GET
/rulebooks/{id}/
Get the rulebook by its id
rulebooks_retrieve1 param→ 200
GET
/rulebooks/{id}/json/
Get the JSON format of a rulebook by its id
rulebooks_json_retrieve1 param→ 200
service-index 20
GET
/service-index/
Link other resource registry endpoints
service_index_retrieve→ 200
GET
/service-index/metadata/
service_index_metadata_retrieve→ 200
POST
/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
/service-index/resource-types/
Index of the resource types that are configured in the system.
service_index_resource_types_list2 params→ 200
GET
/service-index/resource-types/{name}/
Index of the resource types that are configured in the system.
service_index_resource_types_retrieve1 param→ 200
GET
/service-index/resource-types/{name}/manifest/
Returns the as a stream the csv of resourceid,hash for a given resource type.
List all resources. Accepts an optional 'extrafields' query parameter (comma-separated) to include additional fields in the response. Supported values: resourcedata.
The contract defines 116 schemas that model the data the API accepts and returns. The most detailed are ActivationRead (44 properties), ActivationList (40 properties), PatchedActivationUpdate (23 properties), ProjectRead (22 properties). Each schema is shown below with its type and property counts.
ActivationCopy
object
1 property1 required
ActivationCreate
object
Serializer for creating the Activation.
22 properties4 required
ActivationInstance
object
Serializer for the Activation Instance model.
10 properties6 required
ActivationInstanceLog
object
Serializer for the Activation Instance Log model.
5 properties3 required
ActivationList
object
Serializer for listing the Activation model objects.
40 properties17 required
ActivationRead
object
Serializer for reading the Activation with related objects info.
44 properties15 required
AuditAction
object
8 properties4 required
AuditEvent
object
7 properties5 required
AuditRuleDetail
object
8 properties6 required
AuditRuleList
object
6 properties5 required
AwxToken
object
6 properties5 required
AwxTokenCreate
object
3 properties2 required
Config
object
Serializer for ConfigView response.
3 properties3 required
CredentialInputSource
object
Serializer used during a GET.
12 properties8 required
CredentialInputSourceCreate
object
Serializer used during the Create process of the instance.
6 properties5 required
CredentialType
object
10 properties5 required
CredentialTypeCreate
object
4 properties1 required
CredentialTypeRef
object
4 properties2 required
CredentialTypeTest
object
2 properties1 required
DABContentType
object
6 properties3 required
DABPermission
object
4 properties3 required
DecisionEnvironment
object
11 properties9 required
DecisionEnvironmentCreate
object
Serializer for creating the DecisionEnvironment.
6 properties3 required
DecisionEnvironmentRead
object
Serializer for reading the DecisionEnvironment with embedded objects.
Serializer for reading the Project with embedded objects.
22 properties13 required
ProjectRef
object
9 properties5 required
PullPolicyEnum
string
always - Always pull container before running. missing - Only pull the image if not present before running. never - Never pull container before running.
RefreshToken
object
1 property1 required
Resource
object
10 properties6 required
ResourceList
object
9 properties4 required
ResourceType
object
5 properties5 required
RestartPolicyEnum
string
always - always on-failure - on-failure never - never
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.
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 Event-Driven Ansible Controller 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.