Red Hat Ansible Automation Platform Activity Stream API

openapi: 3.2.0
info:
  title: AWX Activity Stream API
  version: v2
  description: AWX API Documentation
  contact:
    email: ansible-community@redhat.com
  license:
    name: Apache License
tags:
- name: Activity Stream
paths:
  /api/v2/activity_stream/:
    get:
      operationId: activity_stream_list
      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:
      - Activity Stream
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedActivityStreamList'
          description: ''
      x-ai-description: A list of activity stream entries. An activity stream entry tracks actions or changes that were previously made to the system.
      summary: Activity stream list
      x-summary-source: derived
  /api/v2/activity_stream/{id}/:
    get:
      operationId: activity_stream_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Activity Stream
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityStream'
          description: ''
      x-ai-description: Retrieve an audit trail entry for tracking all changes within the system
      summary: Activity stream retrieve
      x-summary-source: derived
  /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:
      - Activity Stream
      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
      summary: Activitystream list
      x-summary-source: derived
  /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:
      - Activity Stream
      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
      summary: Activitystream retrieve
      x-summary-source: derived
components:
  schemas:
    PaginatedActivityStreamList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/ActivityStream'
    ActivityStream:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        type:
          type: string
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: string
          readOnly: true
        summary_fields:
          type: string
          readOnly: true
        timestamp:
          type: string
          format: date-time
          readOnly: true
        operation:
          enum:
          - create
          - update
          - delete
          - associate
          - disassociate
          - null
          type:
          - string
          - 'null'
          x-spec-enum-id: d1cf1307b8aa394e
          description: 'The action taken with respect to the given object(s).


            * `create` - Entity Created

            * `update` - Entity Updated

            * `delete` - Entity Deleted

            * `associate` - Entity Associated with another Entity

            * `disassociate` - Entity was Disassociated with another Entity'
        changes:
          type: string
          readOnly: true
          description: A summary of the new and changed values when an object is created, updated, or deleted
        object1:
          type:
          - string
          - 'null'
          description: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2.
        object2:
          type:
          - string
          - 'null'
          description: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with.
        object_association:
          type: string
          readOnly: true
          description: When present, shows the field name of the role or relationship that changed.
        action_node:
          type: string
          readOnly: true
          description: The cluster node the activity took place on.
        object_type:
          type: string
          readOnly: true
          description: When present, shows the model on which the role or relationship was defined.
      required:
      - object1
      - object2
      - operation
    Entry:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: object
          additionalProperties:
            type: string
          readOnly: true
        summary_fields:
          type: object
          additionalProperties:
            type: object
            additionalProperties: {}
          readOnly: true
        created:
          type: string
          format: date-time
          readOnly: true
          description: The date/time this resource was created.
        created_by:
          type:
          - integer
          - 'null'
          readOnly: true
          description: The user who created this resource.
        operation:
          enum:
          - create
          - update
          - delete
          - associate
          - disassociate
          type: string
          x-spec-enum-id: 9d2b7b6e53dc82e9
          description: 'The type of change recorded by the entry (i.e. create/update/delete/etc).


            * `create` - Entity created

            * `update` - Entity updated

            * `delete` - Entity deleted

            * `associate` - Entity was associated with another entity

            * `disassociate` - Entity was disassociated with another entity'
        changes:
          type:
          - object
          - 'null'
          additionalProperties:
            type: object
            additionalProperties: {}
          description: 'We store strings, we have to convert them back to the correct type.

            Related associations and disassociations will show a null for changes.'
          readOnly: true
        content_type:
          type: integer
          description: The content type which was changed in this entry.
        object_id:
          type:
          - string
          - 'null'
          description: The object id which was modified in this entry.
        related_content_type:
          type:
          - integer
          - 'null'
          description: The content type if this entry is recording an many to many (M2M) change.
        related_object_id:
          type:
          - string
          - 'null'
          description: The object id of the related model if this entry is for an many to many (M2M) change.
        content_type_model:
          type:
          - string
          - 'null'
          readOnly: true
        related_content_type_model:
          type:
          - string
          - 'null'
          readOnly: true
      required:
      - content_type
      - operation
    PaginatedEntryList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Entry'
  securitySchemes:
    Basic_Authentication:
      type: http
      scheme: basic
    OAuth2_Authentication:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /o/authorize/
          tokenUrl: /o/token/
          scopes:
            read: Read access to resources
            write: Write access to resources (includes read)
        password:
          tokenUrl: /o/token/
          scopes:
            read: Read access to resources
            write: Write access to resources (includes read)
    SessionAuthentication:
      type: apiKey
      in: cookie
      name: gateway_sessionid