Red Hat Ansible Automation Platform Workflow Job Nodes API

openapi: 3.2.0
info:
  title: AWX Workflow Job Nodes API
  version: v2
  description: AWX API Documentation
  contact:
    email: ansible-community@redhat.com
  license:
    name: Apache License
tags:
- name: workflow_job_nodes
paths:
  /api/v2/workflow_job_nodes/:
    get:
      operationId: workflow_job_nodes_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:
      - workflow_job_nodes
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWorkflowJobNodeListList'
          description: ''
      x-ai-description: List workflow job nodes
      summary: Workflow job nodes list
      x-summary-source: derived
  /api/v2/workflow_job_nodes/{id}/:
    get:
      operationId: workflow_job_nodes_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - workflow_job_nodes
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowJobNodeDetail'
          description: ''
      x-ai-description: Retrieve a workflow job node
      summary: Workflow job nodes retrieve
      x-summary-source: derived
  /api/v2/workflow_job_nodes/{id}/always_nodes/:
    get:
      operationId: workflow_job_nodes_always_nodes_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:
      - workflow_job_nodes
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWorkflowJobNodeListList'
          description: ''
      x-ai-description: List always nodes of a workflow job node
      summary: Workflow job nodes always nodes list
      x-summary-source: derived
  /api/v2/workflow_job_nodes/{id}/credentials/:
    get:
      operationId: workflow_job_nodes_credentials_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:
      - workflow_job_nodes
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCredentialList'
          description: ''
      x-ai-description: List credentials of a workflow job node
      summary: Workflow job nodes credentials list
      x-summary-source: derived
  /api/v2/workflow_job_nodes/{id}/failure_nodes/:
    get:
      operationId: workflow_job_nodes_failure_nodes_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:
      - workflow_job_nodes
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWorkflowJobNodeListList'
          description: ''
      x-ai-description: List failure nodes of a workflow job node
      summary: Workflow job nodes failure nodes list
      x-summary-source: derived
  /api/v2/workflow_job_nodes/{id}/instance_groups/:
    get:
      operationId: workflow_job_nodes_instance_groups_list
      description: Derived version of SubListCreateAttachDetachAPIView that prohibits creation
      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:
      - workflow_job_nodes
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedInstanceGroupList'
          description: ''
      x-ai-description: List instance groups of a workflow job node
      summary: Workflow job nodes instance groups list
      x-summary-source: derived
    post:
      operationId: workflow_job_nodes_instance_groups_create
      description: Derived version of SubListCreateAttachDetachAPIView that prohibits creation
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - workflow_job_nodes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstanceGroupRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceGroup'
          description: ''
      x-ai-description: Create an instance group of a workflow job node
      summary: Workflow job nodes instance groups create
      x-summary-source: derived
  /api/v2/workflow_job_nodes/{id}/labels/:
    get:
      operationId: workflow_job_nodes_labels_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:
      - workflow_job_nodes
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedLabelList'
          description: ''
      x-ai-description: List labels of a workflow job node
      summary: Workflow job nodes labels list
      x-summary-source: derived
  /api/v2/workflow_job_nodes/{id}/success_nodes/:
    get:
      operationId: workflow_job_nodes_success_nodes_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:
      - workflow_job_nodes
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWorkflowJobNodeListList'
          description: ''
      x-ai-description: List success nodes of a workflow job node
      summary: Workflow job nodes success nodes list
      x-summary-source: derived
components:
  schemas:
    InstanceGroup:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        type:
          type: string
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: string
          readOnly: true
        name:
          type:
          - string
          - 'null'
          maxLength: 250
        created:
          type: string
          readOnly: true
        modified:
          type: string
          readOnly: true
        capacity:
          type: string
          readOnly: true
        consumed_capacity:
          type: string
          readOnly: true
        percent_capacity_remaining:
          type: string
          readOnly: true
        jobs_running:
          type: string
          readOnly: true
        max_concurrent_jobs:
          type: integer
          minimum: 0
          default: 0
          description: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.
        max_forks:
          type: integer
          minimum: 0
          default: 0
          description: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.
        jobs_total:
          type: integer
          readOnly: true
          description: Count of all jobs that target this instance group
        instances:
          type: string
          readOnly: true
        is_container_group:
          type: boolean
          description: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.
        credential:
          type:
          - integer
          - 'null'
        policy_instance_percentage:
          type: integer
          maximum: 100
          minimum: 0
          default: 0
          description: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.
        policy_instance_minimum:
          type: integer
          minimum: 0
          default: 0
          description: Static minimum number of Instances that will be automatically assign to this group when new instances come online.
        policy_instance_list:
          type: array
          items:
            type: string
          description: List of exact-match Instances that will be assigned to this group
        pod_spec_override:
          type:
          - string
          - 'null'
          default: ''
        summary_fields:
          type: string
          readOnly: true
      required:
      - name
    PaginatedInstanceGroupList:
      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/InstanceGroup'
    InstanceGroupRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 250
        max_concurrent_jobs:
          type: integer
          minimum: 0
          default: 0
          description: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.
        max_forks:
          type: integer
          minimum: 0
          default: 0
          description: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.
        is_container_group:
          type: boolean
          description: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.
        credential:
          type:
          - integer
          - 'null'
        policy_instance_percentage:
          type: integer
          maximum: 100
          minimum: 0
          default: 0
          description: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.
        policy_instance_minimum:
          type: integer
          minimum: 0
          default: 0
          description: Static minimum number of Instances that will be automatically assign to this group when new instances come online.
        policy_instance_list:
          type: array
          items:
            type: string
            minLength: 1
          description: List of exact-match Instances that will be assigned to this group
        pod_spec_override:
          type:
          - string
          - 'null'
          default: ''
      required:
      - name
    PaginatedCredentialList:
      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/Credential'
    Label:
      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
        organization:
          type: integer
          description: Organization this label belongs to.
      required:
      - name
      - organization
    WorkflowJobNodeList:
      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
        extra_data:
          default: {}
        inventory:
          type:
          - integer
          - 'null'
          description: Inventory applied as a prompt, assuming job template prompts for inventory
        scm_branch:
          type:
          - string
          - 'null'
        job_type:
          enum:
          - run
          - check
          - ''
          - null
          type:
          - string
          - 'null'
          description: '* `run` - Run

            * `check` - Check'
          x-spec-enum-id: 726608a431c1f104
        job_tags:
          type:
          - string
          - 'null'
        skip_tags:
          type:
          - string
          - 'null'
        limit:
          type:
          - string
          - 'null'
        diff_mode:
          type:
          - boolean
          - 'null'
        verbosity:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - null
          type:
          - integer
          - 'null'
          description: '* `0` - 0 (Normal)

            * `1` - 1 (Verbose)

            * `2` - 2 (More Verbose)

            * `3` - 3 (Debug)

            * `4` - 4 (Connection Debug)

            * `5` - 5 (WinRM Debug)'
          x-spec-enum-id: 8cfb81af905b865a
        execution_environment:
          type:
          - integer
          - 'null'
          description: The container image to be used for execution.
        forks:
          type:
          - integer
          - 'null'
          minimum: 0
        job_slice_count:
          type:
          - integer
          - 'null'
          minimum: 0
        timeout:
          type:
          - integer
          - 'null'
        job:
          type:
          - integer
          - 'null'
        workflow_job:
          type:
          - integer
          - 'null'
        unified_job_template:
          type:
          - integer
          - 'null'
        success_nodes:
          type: array
          items:
            type: integer
          readOnly: true
        failure_nodes:
          type: array
          items:
            type: integer
          readOnly: true
        always_nodes:
          type: array
          items:
            type: integer
          readOnly: true
        all_parents_must_converge:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node
        do_not_run:
          type:
          - boolean
          - 'null'
          default: false
          description: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run.
        identifier:
          type:
          - string
          - 'null'
          description: An identifier coresponding to the workflow job template node that this node was created from.
          maxLength: 512
    PaginatedWorkflowJobNodeListList:
      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/WorkflowJobNodeList'
    WorkflowJobNodeDetail:
      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
        extra_data:
          default: {}
        inventory:
          type:
          - integer
          - 'null'
          description: Inventory applied as a prompt, assuming job template prompts for inventory
        scm_branch:
          type:
          - string
          - 'null'
        job_type:
          enum:
          - run
          - check
          - ''
          - null
          type:
          - string
          - 'null'
          description: '* `run` - Run

            * `check` - Check'
          x-spec-enum-id: 726608a431c1f104
        job_tags:
          type:
          - string
          - 'null'
        skip_tags:
          type:
          - string
          - 'null'
        limit:
          type:
          - string
          - 'null'
        diff_mode:
          type:
          - boolean
          - 'null'
        verbosity:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - null
          type:
          - integer
          - 'null'
          description: '* `0` - 0 (Normal)

            * `1` - 1 (Verbose)

            * `2` - 2 (More Verbose)

            * `3` - 3 (Debug)

            * `4` - 4 (Connection Debug)

            * `5` - 5 (WinRM Debug)'
          x-spec-enum-id: 8cfb81af905b865a
        execution_environment:
          type:
          - integer
          - 'null'
          description: The container image to be used for execution.
        forks:
          type:
          - integer
          - 'null'
          minimum: 0
        job_slice_count:
          type:
          - integer
          - 'null'
          minimum: 0
        timeout:
          type:
          - integer
          - 'null'
        job:
          type:
          - integer
          - 'null'
        workflow_job:
          type:
          - integer
          - 'null'
        unified_job_template:
          type:
          - integer
          - 'null'
        success_nodes:
          type: array
          items:
            type: integer
          readOnly: true
        failure_nodes:
          type: array
          items:
            type: integer
          readOnly: true
        always_nodes:
          type: array
          items:
            type: integer
          readOnly: true
        all_parents_must_converge:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node
        do_not_run:
          type:
          - boolean
          - 'null'
          default: false
          description: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run.
        identifier:
          type:
          - string
          - 'null'
          description: An identifier coresponding to the workflow job template node that this node was created from.
          maxLength: 512
    Credential:
      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: ''
        organization:
          type:
          - integer
          - 'null'
        credential_type:
          type: integer
          description: Specify the type of credential you want to create. Refer to the documentation for details on each type.
        managed:
          type: boolean
          readOnly: true
        inputs:
          default: {}
          description: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
        kind:
          type: string
          readOnly: true
        cloud:
          type: string
          readOnly: true
        kubernetes:
          type: string
          readOnly: true
      required:
      - credential_type
      - name
    PaginatedLabelList:
      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/Label'