Red Hat Ansible Automation Platform Event Streams API

openapi: 3.2.0
info:
  title: Event Driven Ansible Event Streams API
  version: 0.2.0
servers:
- url: /api/eda/v1
tags:
- name: Event Streams
paths:
  /event-streams/:
    get:
      operationId: event_streams_list
      description: List event streams
      parameters:
      - in: query
        name: name
        schema:
          type: string
        description: Filter by event stream 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: test_mode
        schema:
          type: boolean
        description: Filter by the test_mode being true or false
      tags:
      - Event Streams
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEventStreamOutList'
          description: Return a list of eventstreams.
      x-ai-description: List event streams. Returns event stream records. Supports filtering and pagination.
      summary: Event streams list
      x-summary-source: derived
    post:
      operationId: event_streams_create
      tags:
      - Event Streams
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventStreamIn'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EventStreamIn'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EventStreamIn'
        required: true
      security:
      - EDAJWTAuthentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventStreamOut'
          description: Return the new event stream.
        '400':
          description: Invalid data or missing credentials.
        '502':
          description: Gateway API error during certificate sync.
      x-ai-description: Create an event stream. Returns the created event stream.
      summary: Event streams create
      x-summary-source: derived
  /event-streams/{id}/activations/:
    get:
      operationId: event_streams_activations_list
      description: List all activations for the event stream
      parameters:
      - in: query
        name: decision_environment_id
        schema:
          type: number
        description: Filter by Decision Environment ID.
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this event stream.
        required: true
      - 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:
      - Event Streams
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedActivationListList'
          description: ''
      summary: Event streams activations list
      x-summary-source: derived
  /event-streams/{id}/:
    get:
      operationId: event_streams_retrieve
      description: Get the EventStream by its id
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this event stream.
        required: true
      tags:
      - Event Streams
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventStreamOut'
          description: Return the event stream by its id.
      summary: Event streams retrieve
      x-summary-source: derived
    patch:
      operationId: event_streams_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this event stream.
        required: true
      tags:
      - Event Streams
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedEventStreamIn'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedEventStreamIn'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedEventStreamIn'
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventStreamOut'
          description: Update successful, return the new event stream.
        '400':
          description: Update failed or missing credentials.
        '502':
          description: Gateway API error during certificate sync.
      summary: Event streams partial update
      x-summary-source: derived
    delete:
      operationId: event_streams_destroy
      description: Delete a EventStream by its id
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this event stream.
        required: true
      tags:
      - Event Streams
      security:
      - EDAJWTAuthentication: []
      responses:
        '204':
          description: Delete successful.
        '400':
          description: Missing credentials for certificate deletion.
        '502':
          description: Gateway API error during certificate deletion.
      summary: Event streams destroy
      x-summary-source: derived
components:
  schemas:
    PaginatedActivationListList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: /eda/api/v1/example/?page=51&page_size=100
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: /eda/api/v1/example/?page=49&page_size=100
        page_size:
          type:
          - integer
          - 'null'
          example: 100
        page:
          type:
          - integer
          - 'null'
          example: 50
        results:
          type: array
          items:
            $ref: '#/components/schemas/ActivationList'
    ScmTypeEnum:
      enum:
      - git
      type: string
      description: '* `git` - Git'
    ProjectRef:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        git_hash:
          type: string
        url:
          type: string
        scm_type:
          $ref: '#/components/schemas/ScmTypeEnum'
        name:
          type: string
        description:
          type: string
        organization_id:
          type: integer
          readOnly: true
        update_revision_on_launch:
          type: boolean
          description: Enable automatic project sync on activation launch
        scm_update_cache_timeout:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          description: Cache timeout in seconds for project updates (0 = always update, max 86400)
      required:
      - git_hash
      - id
      - name
      - organization_id
      - url
    EventStreamIn:
      type: object
      properties:
        name:
          type: string
        test_mode:
          type: boolean
          description: Enable test mode
        additional_data_headers:
          type: string
          description: The additional http headers which will be added to the event data. The headers are comma delimited
        eda_credential_id:
          type: integer
        organization_id:
          type: integer
        uuid:
          type:
          - string
          - 'null'
          format: uuid
      required:
      - eda_credential_id
      - name
      - organization_id
    EdaCredential:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        inputs:
          type: object
          additionalProperties: true
          readOnly: true
        credential_type:
          allOf:
          - $ref: '#/components/schemas/CredentialTypeRef'
        references:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EdaCredentialReference'
        created_by:
          type: object
          properties:
            id:
              type: integer
            username:
              type: string
            first_name:
              type: string
            last_name:
              type: string
        modified_by:
          type: object
          properties:
            id:
              type: integer
            username:
              type: string
            first_name:
              type: string
            last_name:
              type: string
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type: string
          format: date-time
          readOnly: true
        managed:
          type: boolean
          readOnly: true
        organization:
          $ref: '#/components/schemas/OrganizationRef'
      required:
      - created_at
      - created_by
      - id
      - inputs
      - managed
      - modified_at
      - modified_by
      - name
      - organization
    StatusEnum:
      enum:
      - starting
      - running
      - pending
      - failed
      - stopping
      - stopped
      - deleting
      - completed
      - unresponsive
      - error
      - workers offline
      type: string
      description: '* `starting` - starting

        * `running` - running

        * `pending` - pending

        * `failed` - failed

        * `stopping` - stopping

        * `stopped` - stopped

        * `deleting` - deleting

        * `completed` - completed

        * `unresponsive` - unresponsive

        * `error` - error

        * `workers offline` - workers offline'
    LogLevelEnum:
      enum:
      - debug
      - info
      - error
      type: string
      description: '* `debug` - debug

        * `info` - info

        * `error` - error'
    PaginatedEventStreamOutList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: /eda/api/v1/example/?page=51&page_size=100
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: /eda/api/v1/example/?page=49&page_size=100
        page_size:
          type:
          - integer
          - 'null'
          example: 100
        page:
          type:
          - integer
          - 'null'
          example: 50
        results:
          type: array
          items:
            $ref: '#/components/schemas/EventStreamOut'
    PatchedEventStreamIn:
      type: object
      properties:
        name:
          type: string
        test_mode:
          type: boolean
          description: Enable test mode
        additional_data_headers:
          type: string
          description: The additional http headers which will be added to the event data. The headers are comma delimited
        eda_credential_id:
          type: integer
        organization_id:
          type: integer
        uuid:
          type:
          - string
          - 'null'
          format: uuid
    EdaCredentialReference:
      type: object
      properties:
        type:
          type: string
          description: Type of the related resource
        id:
          type: integer
          description: ID of the related resource
        name:
          type: string
          description: Name of the related resource
        uri:
          type: string
          format: uri
          description: URI of the related resource
      required:
      - id
      - name
      - type
      - uri
    EdaCredentialRef:
      type: object
      description: Serializer for EdaCredential reference.
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
        description:
          type: string
        inputs:
          type: object
          additionalProperties: true
          readOnly: true
        managed:
          type: boolean
        credential_type_id:
          type:
          - integer
          - 'null'
          readOnly: true
        organization_id:
          type: integer
          readOnly: true
      required:
      - credential_type_id
      - id
      - inputs
      - name
      - organization_id
    CredentialTypeRef:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
        namespace:
          type:
          - string
          - 'null'
        kind:
          type: string
      required:
      - id
      - name
    EventStreamOut:
      type: object
      properties:
        name:
          type: string
        test_mode:
          type: boolean
          description: Enable test mode
        additional_data_headers:
          type: string
          description: The additional http headers which will be added to the event data. The headers are comma delimited
        organization:
          type: string
          readOnly: true
        eda_credential:
          $ref: '#/components/schemas/EdaCredentialRef'
        event_stream_type:
          type: string
          description: The type of the event stream based on credential type
        uuid:
          type: string
          format: uuid
        created_by:
          type: object
          properties:
            id:
              type: integer
            username:
              type: string
            first_name:
              type: string
            last_name:
              type: string
        modified_by:
          type: object
          properties:
            id:
              type: integer
            username:
              type: string
            first_name:
              type: string
            last_name:
              type: string
        id:
          type: integer
          readOnly: true
        owner:
          type: string
          readOnly: true
        url:
          type: string
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type: string
          format: date-time
          readOnly: true
        test_content_type:
          type: string
          readOnly: true
          description: The content type of test data, when in test mode
        test_content:
          type: string
          readOnly: true
          description: The content recieved, when in test mode, stored as a yaml string
        test_error_message:
          type: string
          readOnly: true
          description: The error message,  when in test mode
        test_headers:
          type: string
          readOnly: true
          description: The headers recieved, when in test mode, stored as a yaml string
        events_received:
          type: integer
          readOnly: true
          description: The total number of events received by event stream
        last_event_received_at:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date/time when the last event was received
      required:
      - created_at
      - created_by
      - eda_credential
      - events_received
      - id
      - last_event_received_at
      - modified_at
      - modified_by
      - name
      - organization
      - owner
      - test_content
      - test_content_type
      - test_error_message
      - test_headers
      - url
    ActivationList:
      type: object
      description: Serializer for listing the Activation model objects.
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
        description:
          type: string
        is_enabled:
          type: boolean
        status:
          $ref: '#/components/schemas/StatusEnum'
        restart_on_project_update:
          type: boolean
          description: Auto-restart when rulebook changes after project sync
        extra_var:
          type:
          - string
          - 'null'
        decision_environment_id:
          type:
          - integer
          - 'null'
          readOnly: true
        project:
          allOf:
          - $ref: '#/components/schemas/ProjectRef'
        project_id:
          type:
          - integer
          - 'null'
          readOnly: true
        rulebook_id:
          type:
          - integer
          - 'null'
          readOnly: true
        organization_id:
          type: integer
          readOnly: true
        restart_policy:
          $ref: '#/components/schemas/RestartPolicyEnum'
        restart_count:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        rulebook_name:
          type: string
          description: Name of the referenced rulebook
        current_job_id:
          type:
          - string
          - 'null'
        rules_count:
          type: integer
        rules_fired_count:
          type: integer
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type: string
          format: date-time
          readOnly: true
        edited_at:
          type:
          - string
          - 'null'
          format: date-time
        created_by:
          type: object
          properties:
            id:
              type: integer
            username:
              type: string
            first_name:
              type: string
            last_name:
              type: string
        modified_by:
          type: object
          properties:
            id:
              type: integer
            username:
              type: string
            first_name:
              type: string
            last_name:
              type: string
        edited_by:
          type: object
          properties:
            id:
              type: integer
            username:
              type: string
            first_name:
              type: string
            last_name:
              type: string
        status_message:
          type:
          - string
          - 'null'
        awx_token_id:
          type:
          - integer
          - 'null'
          readOnly: true
        log_level:
          $ref: '#/components/schemas/LogLevelEnum'
        eda_credentials:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EdaCredential'
        k8s_service_name:
          type:
          - string
          - 'null'
          description: Service name of the activation
        event_streams:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EventStreamOut'
        source_mappings:
          type: string
          description: Mapping between sources and event streams
        skip_audit_events:
          type: boolean
          description: Skip audit events for activation
        log_tracking_id:
          type: string
          readOnly: true
        enable_persistence:
          type: boolean
          description: Enable persistence for activation
        rule_engine_credential_id:
          type:
          - integer
          - 'null'
          description: The Rule Engine Credential to use, if empty use the default system rule engine credential.
          readOnly: true
        k8s_pod_service_account_name:
          type:
          - string
          - 'null'
          description: Kubernetes ServiceAccount for activation job pods
        k8s_pod_labels: {}
        k8s_pod_annotations: {}
        k8s_pod_node_selector: {}
        k8s_pod_tolerations:
          description: Kubernetes tolerations applied to activation job pods so they can be scheduled onto tainted nodes.
      required:
      - awx_token_id
      - created_at
      - created_by
      - decision_environment_id
      - edited_by
      - id
      - log_tracking_id
      - modified_at
      - modified_by
      - name
      - organization_id
      - project_id
      - rule_engine_credential_id
      - rulebook_id
      - rulebook_name
      - rules_count
      - rules_fired_count
    OrganizationRef:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          description: The name of this resource.
          maxLength: 512
        description:
          type: string
          description: The organization description.
      required:
      - id
      - name
    RestartPolicyEnum:
      enum:
      - always
      - on-failure
      - never
      type: string
      description: '* `always` - always

        * `on-failure` - on-failure

        * `never` - never'
  securitySchemes:
    EDAJWTAuthentication:
      type: apiKey
      name: X-DAB-JW-TOKEN
      in: header
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid