Every API here is available over the APIs.io API and to AI agents over MCP.
{
"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