Red Hat Environments API

openapi: 3.1.0
info:
  title: Red Hat Ansible Automation Platform Add-Ons Environments API
  description: The Red Hat Ansible Automation Platform API provides programmatic access to the automation controller for managing IT infrastructure automation. It supports creating and launching job templates, managing inventories, tracking job execution status, and configuring credentials for connecting to managed hosts and external services.
  version: '2.6'
  contact:
    name: Red Hat Support
    url: https://access.redhat.com/support
  termsOfService: https://www.redhat.com/en/about/terms-use
servers:
- url: https://ansible-platform.example.com
  description: Ansible Automation Platform Server
security:
- bearerAuth: []
tags:
- name: Environments
  description: Operations for managing lifecycle environments that define the promotion path for content from development to production.
paths:
  /katello/api/v2/organizations/{organization_id}/environments:
    get:
      operationId: listEnvironments
      summary: Red Hat List Lifecycle Environments
      description: Retrieves the list of lifecycle environments for an organization, defining the promotion path for content views from development through to production.
      tags:
      - Environments
      parameters:
      - name: organization_id
        in: path
        required: true
        description: The organization identifier.
        schema:
          type: integer
        example: '500123'
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PerPageParam'
      responses:
        '200':
          description: Successfully retrieved lifecycle environments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEnvironmentList'
              examples:
                Listenvironments200Example:
                  summary: Default listEnvironments 200 response
                  x-microcks-default: true
                  value:
                    total: 10
                    subtotal: 10
                    page: 10
                    per_page: 10
                    results:
                    - id: abc123
                      name: Example Title
                      label: Example Title
                      description: A sample description.
                      prior:
                        id: abc123
                        name: Example Title
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    PerPageParam:
      name: per_page
      in: query
      description: The number of results per page.
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 20
    PageParam:
      name: page
      in: query
      description: The page number for paginated results.
      schema:
        type: integer
        minimum: 1
        default: 1
  responses:
    UnauthorizedError:
      description: Authentication credentials are missing or invalid.
  schemas:
    PaginatedEnvironmentList:
      type: object
      properties:
        total:
          type: integer
          example: 10
        subtotal:
          type: integer
          example: 10
        page:
          type: integer
          example: 10
        per_page:
          type: integer
          example: 10
        results:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
              label:
                type: string
              description:
                type: string
              prior:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
          example: []
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 Bearer token for authenticating API requests to the automation controller.
externalDocs:
  description: Ansible Automation Platform API Documentation
  url: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.6/html-single/automation_execution_api_overview/index