openapi: 3.2.0
info:
  title: AWX System Jobs API
  version: v2
  description: AWX API Documentation
  contact:
    email: ansible-community@redhat.com
  license:
    name: Apache License
tags:
- name: system_jobs
paths:
  /api/v2/system_jobs/:
    get:
      operationId: system_jobs_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:
      - system_jobs
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSystemJobListList'
          description: ''
      x-ai-description: List system jobs
      summary: System jobs list
      x-summary-source: derived
  /api/v2/system_jobs/{id}/:
    get:
      operationId: system_jobs_retrieve
      description: Special handling when deleting a running unified job object.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - system_jobs
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemJob'
          description: ''
      x-ai-description: Retrieve a system job
      summary: System jobs retrieve
      x-summary-source: derived
    delete:
      operationId: system_jobs_destroy
      description: Special handling when deleting a running unified job object.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - system_jobs
      responses:
        '204':
          description: No response body
      x-ai-description: Delete a system job
      summary: System jobs destroy
      x-summary-source: derived
  /api/v2/system_jobs/{id}/cancel/:
    get:
      operationId: system_jobs_cancel_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - system_jobs
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemJobCancel'
          description: ''
      x-ai-description: Retrieve a cancel for a system job
      summary: System jobs cancel retrieve
      x-summary-source: derived
    post:
      operationId: system_jobs_cancel_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - system_jobs
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemJobCancel'
          description: ''
      x-ai-description: Create a cancel for a system job
      summary: System jobs cancel create
      x-summary-source: derived
  /api/v2/system_jobs/{id}/events/:
    get:
      operationId: system_jobs_events_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - system_jobs
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSystemJobEventList'
          description: ''
      x-ai-description: List events of a system job
      summary: System jobs events list
      x-summary-source: derived
  /api/v2/system_jobs/{id}/notifications/:
    get:
      operationId: system_jobs_notifications_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - system_jobs
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedNotificationList'
          description: ''
      x-ai-description: List notifications of a system job
      summary: System jobs notifications list
      x-summary-source: derived
components:
  schemas:
    PaginatedNotificationList:
      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/Notification'
    PaginatedSystemJobListList:
      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/SystemJobList'
    SystemJobEvent:
      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
        created:
          type: string
          readOnly: true
        modified:
          type: string
          readOnly: true
        event:
          type: string
          readOnly: true
        counter:
          type: integer
          minimum: 0
          readOnly: true
        event_display:
          type: string
          readOnly: true
        event_data:
          default: {}
        failed:
          type: string
          readOnly: true
        changed:
          type: string
          readOnly: true
        uuid:
          type: string
          readOnly: true
        stdout:
          type: string
          readOnly: true
        start_line:
          type: integer
          minimum: 0
          readOnly: true
        end_line:
          type: integer
          minimum: 0
          readOnly: true
        verbosity:
          type: integer
          minimum: 0
          readOnly: true
        system_job:
          type: integer
          readOnly: true
    SystemJobList:
      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
        created:
          type: string
          readOnly: true
        modified:
          type: string
          readOnly: true
        name:
          type:
          - string
          - 'null'
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        unified_job_template:
          type:
          - integer
          - 'null'
          readOnly: true
        launch_type:
          enum:
          - manual
          - relaunch
          - callback
          - scheduled
          - dependency
          - workflow
          - webhook
          - sync
          - scm
          type: string
          description: '* `manual` - Manual

            * `relaunch` - Relaunch

            * `callback` - Callback

            * `scheduled` - Scheduled

            * `dependency` - Dependency

            * `workflow` - Workflow

            * `webhook` - Webhook

            * `sync` - Sync

            * `scm` - SCM Update'
          x-spec-enum-id: e5bed25c2e652da3
          readOnly: true
        status:
          enum:
          - new
          - pending
          - waiting
          - running
          - successful
          - failed
          - error
          - canceled
          type: string
          description: '* `new` - New

            * `pending` - Pending

            * `waiting` - Waiting

            * `running` - Running

            * `successful` - Successful

            * `failed` - Failed

            * `error` - Error

            * `canceled` - Canceled'
          x-spec-enum-id: 6021859c28387823
          readOnly: true
        execution_environment:
          type:
          - integer
          - 'null'
          description: The container image to be used for execution.
        failed:
          type: boolean
          readOnly: true
        started:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time the job was queued for starting.
        finished:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time the job finished execution.
        canceled_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time when the cancel request was sent.
        elapsed:
          type: string
          format: decimal
          pattern: ^-?\d{0,9}(?:\.\d{0,3})?$
          readOnly: true
          description: Elapsed time in seconds that the job ran.
        job_explanation:
          type: string
          readOnly: true
          description: A status field to indicate the state of the job if it wasn't able to run and capture stdout
        execution_node:
          type: string
          readOnly: true
          description: The node the job executed on.
        launched_by:
          type: string
          readOnly: true
        work_unit_id:
          type:
          - string
          - 'null'
          readOnly: true
          description: The Receptor work unit ID associated with this job.
        system_job_template:
          type:
          - integer
          - 'null'
        job_type:
          enum:
          - cleanup_jobs
          - cleanup_activitystream
          - cleanup_sessions
          - ''
          - null
          type:
          - string
          - 'null'
          description: '* `cleanup_jobs` - Remove jobs older than a certain number of days

            * `cleanup_activitystream` - Remove activity stream entries older than a certain number of days

            * `cleanup_sessions` - Removes expired browser sessions from the database'
          x-spec-enum-id: c3fb7965187f07c2
          default: ''
        extra_vars:
          type:
          - string
          - 'null'
          default: ''
        result_stdout:
          type: string
          readOnly: true
      required:
      - name
    PaginatedSystemJobEventList:
      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/SystemJobEvent'
    SystemJobCancel:
      type: object
      properties:
        can_cancel:
          type: boolean
          readOnly: true
    SystemJob:
      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
        created:
          type: string
          readOnly: true
        modified:
          type: string
          readOnly: true
        name:
          type:
          - string
          - 'null'
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        unified_job_template:
          type:
          - integer
          - 'null'
          readOnly: true
        launch_type:
          enum:
          - manual
          - relaunch
          - callback
          - scheduled
          - dependency
          - workflow
          - webhook
          - sync
          - scm
          type: string
          description: '* `manual` - Manual

            * `relaunch` - Relaunch

            * `callback` - Callback

            * `scheduled` - Scheduled

            * `dependency` - Dependency

            * `workflow` - Workflow

            * `webhook` - Webhook

            * `sync` - Sync

            * `scm` - SCM Update'
          x-spec-enum-id: e5bed25c2e652da3
          readOnly: true
        status:
          enum:
          - new
          - pending
          - waiting
          - running
          - successful
          - failed
          - error
          - canceled
          type: string
          description: '* `new` - New

            * `pending` - Pending

            * `waiting` - Waiting

            * `running` - Running

            * `successful` - Successful

            * `failed` - Failed

            * `error` - Error

            * `canceled` - Canceled'
          x-spec-enum-id: 6021859c28387823
          readOnly: true
        execution_environment:
          type:
          - integer
          - 'null'
          description: The container image to be used for execution.
        failed:
          type: boolean
          readOnly: true
        started:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time the job was queued for starting.
        finished:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time the job finished execution.
        canceled_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time when the cancel request was sent.
        elapsed:
          type: string
          format: decimal
          pattern: ^-?\d{0,9}(?:\.\d{0,3})?$
          readOnly: true
          description: Elapsed time in seconds that the job ran.
        job_args:
          type: string
          readOnly: true
        job_cwd:
          type: string
          readOnly: true
        job_env:
          readOnly: true
        job_explanation:
          type: string
          readOnly: true
          description: A status field to indicate the state of the job if it wasn't able to run and capture stdout
        execution_node:
          type: string
          readOnly: true
          description: The node the job executed on.
        result_traceback:
          type: string
          readOnly: true
        event_processing_finished:
          type: boolean
          readOnly: true
          description: Indicates whether all of the events generated by this unified job have been saved to the database.
        launched_by:
          type: string
          readOnly: true
        work_unit_id:
          type:
          - string
          - 'null'
          readOnly: true
          description: The Receptor work unit ID associated with this job.
        system_job_template:
          type:
          - integer
          - 'null'
        job_type:
          enum:
          - cleanup_jobs
          - cleanup_activitystream
          - cleanup_sessions
          - ''
          - null
          type:
          - string
          - 'null'
          description: '* `cleanup_jobs` - Remove jobs older than a certain number of days

            * `cleanup_activitystream` - Remove activity stream entries older than a certain number of days

            * `cleanup_sessions` - Removes expired browser sessions from the database'
          x-spec-enum-id: c3fb7965187f07c2
          default: ''
        extra_vars:
          type:
          - string
          - 'null'
          default: ''
        result_stdout:
          type: string
          readOnly: true
      required:
      - name
    Notification:
      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
        created:
          type: string
          readOnly: true
        modified:
          type: string
          readOnly: true
        notification_template:
          type: integer
          readOnly: true
        error:
          type: string
          readOnly: true
        status:
          enum:
          - pending
          - successful
          - failed
          type: string
          description: '* `pending` - Pending

            * `successful` - Successful

            * `failed` - Failed'
          x-spec-enum-id: 91d6a0571e1ae0e7
          readOnly: true
        notifications_sent:
          type: integer
          readOnly: true
        notification_type:
          enum:
          - awssns
          - email
          - grafana
          - irc
          - mattermost
          - pagerduty
          - rocketchat
          - slack
          - twilio
          - webhook
          - null
          type:
          - string
          - 'null'
          description: '* `awssns` - AWS SNS

            * `email` - Email

            * `grafana` - Grafana

            * `irc` - IRC

            * `mattermost` - Mattermost

            * `pagerduty` - Pagerduty

            * `rocketchat` - Rocket.Chat

            * `slack` - Slack

            * `twilio` - Twilio

            * `webhook` - Webhook'
          x-spec-enum-id: 867d131dea32a033
        recipients:
          type: string
          readOnly: true
        subject:
          type: string
          readOnly: true
        body:
          type: string
          readOnly: true
          description: Notification body
      required:
      - notification_type