Red Hat Ansible Automation Platform Execution Environments API

openapi: 3.2.0
info:
  title: AWX Execution Environments API
  version: v2
  description: AWX API Documentation
  contact:
    email: ansible-community@redhat.com
  license:
    name: Apache License
tags:
- name: execution_environments
paths:
  /api/v2/execution_environments/:
    get:
      operationId: execution_environments_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:
      - execution_environments
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExecutionEnvironmentList'
          description: ''
      x-ai-description: A list of execution environments.
      summary: Execution environments list
      x-summary-source: derived
    post:
      operationId: execution_environments_create
      tags:
      - execution_environments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecutionEnvironmentRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironment'
          description: ''
      x-ai-description: Create a new execution environment container image reference.
      summary: Execution environments create
      x-summary-source: derived
  /api/v2/execution_environments/{id}/:
    get:
      operationId: execution_environments_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - execution_environments
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironment'
          description: ''
      x-ai-description: Retrieve an execution environment
      summary: Execution environments retrieve
      x-summary-source: derived
    put:
      operationId: execution_environments_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - execution_environments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecutionEnvironmentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironment'
          description: ''
      x-ai-description: Update all fields of an execution environment. All fields must be provided in the request body.
      summary: Execution environments update
      x-summary-source: derived
    patch:
      operationId: execution_environments_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - execution_environments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedExecutionEnvironmentRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironment'
          description: ''
      x-ai-description: Update specific fields of an execution environment. Only the fields you provide will be updated.
      summary: Execution environments partial update
      x-summary-source: derived
    delete:
      operationId: execution_environments_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - execution_environments
      responses:
        '204':
          description: No response body
      x-ai-description: Delete an execution environment.
      summary: Execution environments destroy
      x-summary-source: derived
  /api/v2/execution_environments/{id}/activity_stream/:
    get:
      operationId: execution_environments_activity_stream_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:
      - execution_environments
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedActivityStreamList'
          description: ''
      x-ai-description: List activity stream of an execution environment
      summary: Execution environments activity stream list
      x-summary-source: derived
  /api/v2/execution_environments/{id}/copy/:
    get:
      operationId: execution_environments_copy_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - execution_environments
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Copy'
          description: ''
      x-ai-description: Retrieve single copy for an execution_environment
      summary: Execution environments copy retrieve
      x-summary-source: derived
    post:
      operationId: execution_environments_copy_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - execution_environments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Copy'
          description: ''
      x-ai-description: Create new copy for an execution_environment
      summary: Execution environments copy create
      x-summary-source: derived
  /api/v2/execution_environments/{id}/unified_job_templates/:
    get:
      operationId: execution_environments_unified_job_templates_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:
      - execution_environments
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedUnifiedJobTemplateList'
          description: ''
      x-ai-description: List unified job templates using this execution environment
      summary: Execution environments unified job templates list
      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'
    PatchedExecutionEnvironmentRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        organization:
          type:
          - integer
          - 'null'
          description: The organization used to determine access to this execution environment.
        image:
          type:
          - string
          - 'null'
          minLength: 1
          title: Image location
          description: The full image location, including the container registry, image name, and version tag.
          maxLength: 1024
        credential:
          type:
          - integer
          - 'null'
        pull:
          enum:
          - always
          - missing
          - never
          - ''
          - null
          type:
          - string
          - 'null'
          x-spec-enum-id: 63475462f6c34286
          default: ''
          description: 'Pull image before running?


            * `always` - Always pull container before running.

            * `missing` - Only pull the image if not present before running.

            * `never` - Never pull container before running.'
    PaginatedExecutionEnvironmentList:
      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/ExecutionEnvironment'
    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
    Copy:
      type: object
      properties:
        name:
          type: string
      required:
      - name
    ExecutionEnvironment:
      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'
          description: The organization used to determine access to this execution environment.
        image:
          type:
          - string
          - 'null'
          title: Image location
          description: The full image location, including the container registry, image name, and version tag.
          maxLength: 1024
        managed:
          type: boolean
          readOnly: true
        credential:
          type:
          - integer
          - 'null'
        pull:
          enum:
          - always
          - missing
          - never
          - ''
          - null
          type:
          - string
          - 'null'
          x-spec-enum-id: 63475462f6c34286
          default: ''
          description: 'Pull image before running?


            * `always` - Always pull container before running.

            * `missing` - Only pull the image if not present before running.

            * `never` - Never pull container before running.'
      required:
      - image
      - name
    CopyRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
      required:
      - name
    UnifiedJobTemplate:
      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: ''
        last_job_run:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        last_job_failed:
          type: boolean
          readOnly: true
        next_job_run:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        status:
          enum:
          - new
          - pending
          - waiting
          - running
          - successful
          - failed
          - error
          - canceled
          - never updated
          - ok
          - missing
          - none
          - updating
          type: string
          description: '* `new` - New

            * `pending` - Pending

            * `waiting` - Waiting

            * `running` - Running

            * `successful` - Successful

            * `failed` - Failed

            * `error` - Error

            * `canceled` - Canceled

            * `never updated` - Never Updated

            * `ok` - OK

            * `missing` - Missing

            * `none` - No External Source

            * `updating` - Updating'
          x-spec-enum-id: b387d72f4f16647d
          readOnly: true
        execution_environment:
          type:
          - integer
          - 'null'
          description: The container image to be used for execution.
      required:
      - name
    ExecutionEnvironmentRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        organization:
          type:
          - integer
          - 'null'
          description: The organization used to determine access to this execution environment.
        image:
          type:
          - string
          - 'null'
          minLength: 1
          title: Image location
          description: The full image location, including the container registry, image name, and version tag.
          maxLength: 1024
        credential:
          type:
          - integer
          - 'null'
        pull:
          enum:
          - always
          - missing
          - never
          - ''
          - null
          type:
          - string
          - 'null'
          x-spec-enum-id: 63475462f6c34286
          default: ''
          description: 'Pull image before running?


            * `always` - Always pull container before running.

            * `missing` - Only pull the image if not present before running.

            * `never` - Never pull container before running.'
      required:
      - image
      - name
    PaginatedUnifiedJobTemplateList:
      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/UnifiedJobTemplate'